Upgrading Agility Connect
Overview
At the present time upgrading Agility Connect is a manual, decision-based process. The upgrade process is quick and painless but does require an outage. This means that you will need to select a period of downtime where pipelines, automation, user logins, and so on. may be interrupted. Usually, this period of time is seconds, not minutes. Our goal is to get to a zero-downtime upgrade in the future.
If the Agility Connect server does not have direct outbound access to the internet you will need to download the file to the Agility Connect server using an intermediate step such as your desktop, then get the file to the server using sftp or some other protocol.
Step 1. Download the Upgrade File
You may have received an email with a link to download the latest release of Agility Connect. Use this link in the following command.
curl -O "download link here"
Or if you prefer `wget`:
wget -O "download link here"
Step 2. Run the Upgrade
Make sure you run the following steps as the Agility Connect application owner on the Agility Connect server.
# make the installer executable
chmod +x downloadedfile
# run the executable, using silent mode (no prompting)
./downloadedfile
The upgrade process performs the following actions:
-
Stops the Agility Connect services
-
Installs the new files into a new directory under $AGILITYSYNC_HOME (usually under
/opt/agilitysync
unless you have changed the default Agility Connect installation directories. See Change the Default Installation Directories for more information.)
If you have Agility Connect installed on a custom location and are now upgrading, the Agility Connect installer installs Agility Connect on the same directories where it was installed earlier. Any new paths passed with the installer script during such upgrades are ignored.
- Changes a symbolic link /opt/agilitysync/current to point to the new directory
- Performs any database change scripts that may be included
- Restarts the Agility Connect services
At this point you should be able to log back into the Agility Connect application and its service is returned to normal.
Rolling Back to a Previous Release
If for any reason you need to rollback to a previous release, you can use the following commands to perform the rollback.
First do a directory listing of the Agility Connect install directory. The following link will list in chronological order from oldest to newest.
ls -ltr /opt/agilitysync
total 12
drwxrwxr-x 3 agilitysync agilitysync 4096 Jan 30 11:20 python
drwxrwxr-x 9 agilitysync agilitysync 4096 Mar 24 13:57 16.3.4.352
drwxrwxr-x 9 agilitysync agilitysync 4096 Apr 3 14:50 17.0.0.674
lrwxrwxrwx 1 agilitysync agilitysync 25 Apr 3 14:56 current -> /opt/agilitysync/17.0.0.674 <previous-release-number>
You will notice at least one symbolic link named "current" and another actual directory containing the Agility Connect software. If there has been more than one installation, there will be other directories with a different naming convention for the older installs.
The objective of the rollback will be to stop the Agility Connect services, change the symbolic link named "current" to point to one of the other Agility Connect install directories and restart the services.
From the "ls" command output, choose the Agility Connect install directory to switch to. Then substitute it in the commands below where you see "16.3.4.352".
as-stop-services
rm /opt/agilitysync/current
ln -s /opt/agilitysync/16.3.4.352 /opt/agilitysync/current
as-start-services
Log in and check your data.
At this time there is no way to rollback the database version in Agility Connect. However, we make our best effort to make database modification additive so as to not affect previous releases adversely.