Configure automatic push updates

The auto-update feature of the agent allows the distribution of new versions of the agent without reinstalling it on a user's machine. The agent utilizes the published.zip bundles for the auto-update process.

Prerequisites

Before auto-update can be initiated, the installation must meet the following prerequisites:
  • Not a Release Candidate (RC) Version: The installation cannot be an RC version. The current version type can be verified as follows:
    • Windows: Check under the registry key Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Getvisibility\Global\IsRCVersion.
  • Server Access: The agent must have access to the server.
  • Availability of Auto-update Artifacts: This is detailed in the Distribution section.
  • Auto-update Enabled: This is explained in the Configuration section.

The file names must remain consistent with those provided by the development team when published to the artifactory. Any deviation in the naming could result in a malfunctioning installation.

Configuration

By default, the auto-update functionality is disabled and can be enabled in dashboard.

The following properties can be adjusted:
  • Auto-update: Server URL or path- specifies the endpoint from where the agent will attempt to download updates. It should be left empty by default, and the agent will assume default values.
    • By default, the endpoint defaults to:
    • Custom URLs or paths don’t support beta releases.
    • It supports local file path - if this is the case, the full path to the directory must be provided, e.g. C:/Artifacts
    • If a custom URL is used it must be a NGINX file Server which lists the files in JSON format - configuration autoindex_format json. Example:
      server {  
 listen 80;  
 server_name auto-updater;  
 access_log /var/log/access.log;  
 error_log /var/log/error.log;  
 location /static/ {  
 alias /var/static/;  
 autoindex on;  
 autoindex_format json;  
 gzip_static on;  
 expires max;  
 add_header Cache-Control public;  
 }  
}
  • Auto-update: regex for agent packages to include- specifies the regex which will be used for artifacts discovery. It should be left empty by default, and the agent will assume default values.
  • Auto-update: check for updates frequency rate- how often the agent should look for updates. By default, it should be left empty, and agent will assume default values.
  • Enable beta version update- If this option is enabled and appropriate machine name entries are created, the targeted machines will attempt to fetch auto-updates from beta endpoints (https://{cluster}/static-server/static/agent/beta/) instead of stable endpoints (stable endpoint will be completely ignored by the agent).

The agent only supports upgrading via auto-update. It’s not possible to downgrade using auto-update functionality.

This means removing machine from beta endpoints will not result in the agent downgrading to the previous stable version.