Upgrading the CDA Component from Version 6 to 11

This page includes the following:

Stop the Components

Stop CDA (IIS server), and AWI (for example, Tomcat server).

Make sure that no Automation Engine workflows (including Actions) are open or being executed.

Install the Utilities

Unpack and copy the utilities to your utilities folder (for example, c:\Automic\Release.Manager\Utilities\).

Run the Release Manager Unified Upgrade Wizard

As of this version, multiple client databases are consolidated into one single database. For more information, see Friction-free Upgrades of CDA.

You can either create a new database for this purpose, or use an existing database into which you can merge all other databases.

Watch the video:

Follow the steps below to download and run the Release Manager Unified Upgrade wizard.

  1. Download the offering and unpack it to a new, temporary location, for example C:\Staging. Once you have unpacked the offering you can find the wizard in this folder, for example, C:\Staging\Release.Manager\Utilities\RamiusUpgradeTool\RamiusUpgradeTool.exe.

    Note: Make sure you do not download the offering to the existing RamiusUpgradeTools folder in the Automic directory (Automic\Release.Manager\Utilities\RamiusUpgradeTools), as it would overwrite the existing content of the folder.

  2. Review the prerequisites before starting the wizard, see Prerequistes for the Release Manager Unified Upgrade tool.

  3. Execute the Release Manager Unified Upgrade tool to upgrade the CDA clients and update the configuration files. For more information, see Release Manager Unified Upgrade.

  4. (Optional) Review and update the customer.config file (Configuring CDA via Customer.Config File) and the web.config file (Configuring HTTPs Endpoints for CDA). 

  5. (Optional) Review and update the client settings VARA objects, see Configuring CDA via RM.CLIENT_SETTINGS/RM.SYSTEM_SETTINGS VARA Objects.

Important! 

  • Historical installation data is not migrated. This might have an impact on some views and widgets, for example, the Deployment Timeline widget and the Installations view.

  • During a parallel upgrade, you have to manually execute the CDA tools DataMigrator, ApplicationContentMigrator and SyncPermission.ps1 tools must be to upgrade / migrate the database data. During in an in place upgrade, these tools are automatically executed by the Release Manager Unified Upgrade tool, see: Release Manager Unified Upgrade.

Update the Index Data

Execute the following commands in the CLI:

  1. admin-cli clearallindex -con (connection string) -usr (user credentials) -pwd (password)

    Example:

    admin-cli clearallindex -con http://vviedev01/ara -usr 120/ARA/AUTOMIC -pwd ara123

  2. admin-cli index -con (connection string) -usr (user credentials) -pwd (password)

    Example:

    admin-cli index -con http://vviedev01/ara -usr 120/ARA/AUTOMIC -pwd ara123

Tip: Check the log.txt file to see the execution outcome. For more information, see: CDA Logging Files

Install the CDA Plug-in and Update the connection.properties in the Application Server Config Folder

You can use different application servers, for example, Tomcat.

  1. Clear the cache by deleting the files and sub-folders of the folder named felixcache (Example path: C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps\AWI\WEB-INF\felixcach).

  2. Remove the following files from the AWI autoinstall Tomcat folder:

    • ecc-plugins-actionbuilder-*.jar
    • ecc-plugins-pluginmanager-*.jar
    • ecc-plugins-bond-*.jar
    • ecc-plugins-bond-pipeline-*.jar

    (Example path: C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps\AWI\WEB-INF\autoinstall\ecc-plugins-bond-*.jar).

  3. Copy the following files to the AWI autoinstall Tomcat folder: webui-plugin-bond-*.jar

    (Example path: C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps\AWI\WEB-INF\autoinstall).

    Note: Further updates can be performed by simply replacing the existing .jar file in the autoinstall folder within the webapps/ directory of the Tomcat server running AWI with the new version. The configuration file will not be overwritten.

  4. Start Tomcat.

  5. Check and configure the CDA plug-in configuration file (for example, C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps\awi\config\webui-plugin-bond\connection.propertiess).

    Open the configuration file connection.properties.

    Important! Ensure that the URL matches the CDA URL defined in IIS while installing the CDA Web Server Application

    Example: Content in connection.properties:

    url= http://my-cda-server:80/cda (URL of BOND on IIS. A fully-qualified host name (FQHN) is required.)

    timeout=60000 (BOND session timeout)

    package_folder=/PACKAGES (folder containing Automic Continuous Delivery Automation packages)

    use_dedicated_api=true

    rest_connect_timeout=60000

    rest_read_timeout=60000

    use_dedicated_api=true (allows to use dedicated API for Deployment Pipeline)

Install the CDA /KPI Dashboards

The CDA start page has been replaced with the CDA dashboard, which contains widgets that provide an overview of the CDA system state.

To install the CDA /KPI Dashboards

The CDA & KPI dashboards can be manually installed by importing the corresponding files ARA.DASH.DEFAULT.xml/KPI.DASH.DEFAULT.xml(located in the \Release.Manager\AE folder) into the correct AE-client. For more information, see Working with Dashboards. To import the XMLs, you can use the Automation Engine import function. For more information, see Importing/Exporting Objects.

Note: The Access to Dashboard privilege must be assigned to the users to whom you want to grant access to dashboards. For more information, see Setting Up Dashboards.

Add the PM_INDEX_URL and PM_PACK_RELEASENOTE_URL Keys to the UC_SYSTEM_SETTINGS Variable

To connect to the repository containing the release notes of the Packs and show the latest version of the Action Packs in the Packs view of the Administration Perspective, two keys must be defined in the UC_SYSTEM_SETTINGS variable. If the keys are not displayed, add them manually.

To Add the Keys

  1. Log into client 0.
  2. Open the UC_SYSTEM_SETTINGS variable.
  3. Enter the pack release note key as described here: PM_PACK_RELEASENOTE_URL
  4. Enter the index url key as described here: PM_INDEX_URL
  5. Save your changes.

For more information, see Working with Packs and Plug-ins.

 

Clear your Browser Cache Before Opening the Upgraded AWI/CDA

Microsoft Internet Explorer

  1. Navigate to Internet Options > General > Browsing history.
  2. Select Delete.
  3. Deactivate the Preserve Favorites website data option.
  4. Activate the Temporary Internet files and website files option.
  5. Select Delete.

Firefox

  1. Navigate to Options > Advanced.
  2. Select the Network tab.
  3. In the Cached Web Content section, select the Clear Now option.

Google Chrome

  1. Select the Menu button in the upper-right corner.
  2. Go to More Tools > Clear browsing data.
  3. From the Obliterate the following items from drop-down list, select the beginning of time.
  4. Select Clear browsing data.
  5. Activate Browsing history, Cookies and other site & plug-in data, and Cached images and files.
  6. Select Clear browsing data.

Important! Ensure that all your AWI/CDA users clear their browser cache before they start working with the upgraded AWI/CDA

Next step:

Upgrading the Package Manager