Try it free

Update Cluster ActiveGate

  • How-to guide
  • 3-min read

To see a list of installed ActiveGates, go to Deployment Status > ActiveGates. For each ActiveGate, the list gives the current Version of the ActiveGate and the Update status (up to date, pending, or in progress).

The yellow warning icon indicates that your ActiveGate is behind by more than five versions. Update these ActiveGates as soon as possible.

ActiveGates in containers are deployed and uploaded using cloud-specific tooling. For example, Kubernetes uses custom resource definitions.

Automatic update

To manage the update functionality of a particular ActiveGate in the list, select the ActiveGate to expand the details.

  • Autoupdate
    To use the autoupdate feature, verify that Automatic updates is turned on for the ActiveGate. This means that when a new version of ActiveGate becomes available, a new installation package is downloaded to the particular host, and the new version of ActiveGate is installed. This is the default setting for new environments. For existing environments, the setting remains unchanged.
    The availability check is performed at 30-minute intervals.

  • One-click update
    To perform the update immediately, select Update. This functionality is available only if Automatic updates is turned off for the particular ActiveGate.

Manual download and update

You can also download and update your ActiveGate manually. You don't need to uninstall your current version of ActiveGate. Install the new version over the old one, and the ActiveGate configuration is migrated.

  • Install a Cluster ActiveGate.

During an update, your ActiveGate configuration is preserved in the custom.properties and launcheruserconfig.conf files, which the update leaves unchanged. Back up these two files before updating the ActiveGate as a good practice.

  • See Configure ActiveGate for custom.properties file properties.
  • See Configure ActiveGate launcher for launcheruserconfig.conf properties.

Update status

The update status for an ActiveGate can assume the following values:

Up to date
The latest available ActiveGate version is installed on the respective host.

Update available
There is an update available for this ActiveGate version.

Update pending
Immediately after selecting Update ActiveGate, the status changes to Update pending and remains in this status until the update process begins. The status might also be listed as pending if:

  • The Managed Cluster upgrade is in progress.
  • The maximum number of concurrent update downloads has been reached, and the ActiveGate waits to resume the download.

Update in progress
The ActiveGate has requested and downloaded the new installation package from the server, and is currently in the process of installing it or re-connecting to the server.

Update problem
In this case, you will see the old version number displayed for the ActiveGate.
Possible problems are:

  • ActiveGate downloaded the new installer, but the installation wasn't attempted or wasn't performed successfully, so ActiveGate is still at the old version. Check the ActiveGate autoupdater logs and installer logs for the reason why the installation wasn't attempted or failed.
  • ActiveGate downloaded the new installer but then failed to re-connect to the server (was lost). Check the ActiveGate installer logs for the reason why the installation failed.
  • There are no installers available for ActiveGate.
  • Update is on hold because, on another environment, there were update problems with the offered version of ActiveGate.

Unknown
The connection to this ActiveGate has been lost and no status can be determined.
This status can also be displayed if an ActiveGate was successfully removed; in this case, the uninstalled ActiveGate continues to appear with update status Unknown for seven days.