Upgrade Agents on Contrast

Enterprise-on-Premise (EOP) administrators can upgrade the Contrast language agents independently within the Contrast application. In earlier releases of Contrast, the agents were bundled with the application updater artifact. Administrators now have the ability to download a new agent from the Contrast Hub Site and copy the individual agent artifact(s) to a directory on the Contrast application. No restart of the application is required; the agent artifact dynamically reloads and becomes accessible for download.

Configuration

EOP installations of the Contrast application (starting with version 3.2.7) are automatically configured to support a new directory: $CONTRAST_HOME/data/agents. This directory includes sub-directories for each of the agent languages.

contrast-service@dev1eop1:~/contrast/data/agents$ ls -lrta
drwxrwxr-x  2 contrast-service contrast-service 4096 Apr 25 19:59 node
drwxrwxr-x  2 contrast-service contrast-service 4096 Apr 25 19:59 java
drwxrwxr-x  2 contrast-service contrast-service 4096 Apr 25 19:59 dotnet
drwxrwxr-x  6 contrast-service contrast-service 4096 Apr 25 19:59 .
drwxr-xr-x 13 contrast-service contrast-service 4096 Apr 25 20:01 ..

Agents are provided from the Contrast Hub Site and occasionally as a patch through Contrast's Support Site. Your can download the agent from one of those two locations, and copy it to the server hosting the Contrast application. Place it in the directory $CONTRAST_HOME/data/agents/agentName. As mentioned above, no restart is necessary.

If you encounter any issues after completing the configuration, read the troubleshooting article.

Update an EOP License

Contrast Enterprise-on-Premise (EOP) customers may occasionally need a new license file. There are two possible approaches for updating this file: A SuperAdmin can log into the application and update the license in the UI, or you can replace the license file on the local file system. If the license is expired, you must use the file system method.

Option One: The UI

  • Log in to the Contrast applications as a SuperAdmin.

Example:

  • URL: http://teamserver:8080/Contrast/static/ng/admin_index.html#/superadmin/signin
  • Username: contrast_superadmin@example.com
  • Password: Provided when the trial license is originally downloaded from Hub. (Contact your account team or Support for the password.)
  • Navigate to the user menu > System Settings > Licensing tab.
  • Click the Update This License button at the bottom of the panel.
  • Enter your Hub credentials to allow Contrast to download and apply the latest license from Hub.

  • Click Update to finish the process.
  • Restart Contrast to apply the new license changes.

Option Two: The Contrast file system

  • Obtain a new license from Hub, your account manager or the technical support team.

  • Rename the new license file contrast.new.lic.

  • Stop the Contrast application service.

    • On Windows, use the service control panel.
    • On Linux, execute sudo service contrast-server stop or other appropriate command for the distribution/configuration. Verify that all TeamServer processes have stopped by executing ps aux | grep contrast, and confirm there are no processes listed. If myslqld is still running, it may take a few minutes to terminate on its own after stopping the service. If it doesn't terminate, contact Support. Do not kill the processes.

Note: Don't move the current contrast.lic file. Contrast needs both the old and new license files to upgrade the license.

  • Place the new license file in the same data directory.
    • On Linux, confirm that the new license file has the same owner, group and permissions as other files in that directory. (Execute ls -l to list the directory contents with permissions and owners.) A backup of the current license called contrast.lic.bak will be created in the same directory when the new one is consumed during startup.

Note: Execute sudo chown contrast_service:contrast_service contrast.new.lic to change the owner and group. Execute sudo chmod 644 contrast.new.lic to change the permissions.

  • Start the Contrast application as normal.

    • On Windows, use the service control panel.
    • On Linux, execute sudo service contrast-server start or other appropriate command for the distribution/configuration.
  • The new license automatically takes effect.

Update Multiple Instances of Contrast

To update all instances of the Contrast application, follow the steps for the file system method described above for each application instance that's running. Contrast is currently exploring an alternative for distributed configurations that enables you to update all instances at once; however, a solution hasn't yet been implemented.

Update Your IP Address

Updating Contrast's IP address is fairly straightforward. Whether you moved the installation or had to change the hostname or IP address, you can let Contrast know in a few simple steps.

  • Log in to the UI as the SuperAdmin.
  • Go to the user menu > System Settings > General Settings tab.
  • In the General panel, change the TeamServer URL to IP:port/Contrast.
  • Click Save.
  • Restart Contrast to apply the changes.

Note: You must also replace your agents so they know the new address to which they now report.