Update of an existing installation

This page describes how to upgrade security.manager NEXT to a newer version. The upgrade affects all components of security.manager NEXT:

Before the upgrade

Note the upgrade notes in the Release Notes of the current version as well as all versions that lie between the current version and the version you have installed so far.

When the upgrade of security.manager NEXT goes hand in hand with an upgrade of ArcGIS Enterprise from 10 to 11, see the upgrade notes first.

Preparation

Before upgrading the security.manager NEXT components, unzip the installation file security.manager-NEXT-1.7.0.zip into an arbitrary folder. This will create the folder security.manager-NEXT-1.7.0 that will be referred to as [SECMAN-DIR] in these docs.

Upgrade the Manager UI

To identify the running version of the Manager UI before or after an upgrade, open https://<tomcat-host>/secman-next/info.txt in a browser.

Follow these steps to update the Manager UI:

  1. Determine the data directory (parameter data.directory.location) configured in [TOMCAT]\webapps\secman-next\WEB-INF\classes\custom-application.properties. The directory contains custom configuration of the current installed version of security.manager NEXT. The value is needed for restoring it later.

  2. Stop the Apache Tomcat server where the Manager UI is installed.

  3. Remove the old Manager UI context from [TOMCAT]\webapps (move it to a backup folder before deleting it completely).

  4. Extract the file [SECMAN-DIR]\secman-next.war to [TOMCAT]\webapps.

  5. Edit the file [TOMCAT]\webapps\secman-next\WEB-INF\classes\custom-application.properties and change the property data.directory.location to the previously determined value.

  6. Restart the Apache Tomcat server.

  7. Check the Manager UI version as described above.

Upgrade the CLI

The application secmanctl is shipped as an executable file for Windows and Linux operating systems (x86-64 architecture). It is also available as a package in the public npm registry. Depending on which type of installation was used before, there are basically two possibilities to upgrade an existing installation:

  • If the shipped executables were installed, you should update them with those shipped by the new release.

  • If the application was installed from the public npm registry, you should update them by using npm.

Upgrading installed executables

The secmanctl files are located in the following directory:

  • [SECMAN-DIR]/cli/linux_x64 for Linux.

  • [SECMAN-DIR]\cli\windows_x64 for Windows.

Follow these steps to upgrade the manually installed files:

  1. Determine the current installation path.

    • On Linux by executing the command which secmanctl.

    • On Windows by executing the command where secmanctl.

  2. Delete all previously installed files from the installation path.

  3. Copy all new files from the directory mentioned above to the installation path.

  4. Check the new version of the CLI by executing the command secmanctl --version. The version should be 1.7.0.

Upgrading the npm package

Follow these steps to upgrade the npm package:

  1. Perform the update by executing the command npm update -g @conterra/secmanctl.

  2. Check the new version of the CLI by executing the command secmanctl --version. The version should be 1.7.0.

Upgrade the SOI

Important notes about the upgrade

  • Please make sure you have upgraded the CLI before upgrading the SOI.

  • We recommend you to backup existing policies via the CLI before upgrading the SOI.

  • The SOI update will stop all services where the SOI is active. Please manually start these services after the SOI update.

  • Existing policies will get lost if you delete the SOI via the ArcGIS Server Manager. Please make sure not to delete the SOI extensions, but to upgrade them. If you have accidentally deleted an extension, you can restore previously backed up policies via the CLI.

To upgrade the SOI you have to use the ArcGIS Server Manager. Follow these steps:

  1. Sign in to ArcGIS Server Manager.

  2. Navigate to the sections Site > Extensions.

  3. Perform an upgrade of the installed SOE files via Edit extension Edit extension symbol action.

    ArcGIS Server 10.x

    1. Upgrade the ct-security-soi-arcmap.soe extension with the file of the same name from [SECMAN-DIR]/soi/ArcGIS 10.x.

    2. Upgrade the ct-security-soi-arcgispro.soe extension with the file of the same name from [SECMAN-DIR]/soi/ArcGIS 10.x.

    ArcGIS Server 11.x

    1. Upgrade the ct-security-soi-arcgispro.soe extension with the file of the same name from [SECMAN-DIR]/soi/ArcGIS 11.x.

  4. Verify that the version of the upgraded extensions shown in the column Display Name contains the version 1.7.0.

  5. Verify that previously existing policies are still set. You have the following options to do this:

    • Verify the policies via the Manager UI.

      Or

    • Verify the policies via the CLI. The sync command, using the --dry option, should not show any differences between active and backed up policies:

      $ secmanctl sync -f ./backup_policies -d https://gis.example.com:6443/arcgis -t MghzyNeWubQtT.. --dry

After the upgrade

Congratulations! You successfully finished the upgrade process. Now, get familiar with the new features of security.manager NEXT.