Steps to upgrade ARD Hub 3.1.1 to ARD 3.3
search cancel

Steps to upgrade ARD Hub 3.1.1 to ARD 3.3

book

Article ID: 265355

calendar_today

Updated On:

Products

CA Agile Requirements Designer

Issue/Introduction

We are in the process of planning to upgrade ARD Hub 3.1.1 to ARD Hub 3.3. We would like to know what permissions are needed, and other requirements to run the upgrade. Our team has very limited access to the Linux machine.

Environment

Release : ARD 3.1.x

Resolution

The upgrade/installation requires sudo permissions. to perform the ARD Hub installation with a Linux account that can run the sudo command; and similarly, you need a service account with sudo permissions to start the Docker container.

The user or service account that installs and runs the Hub must have sudo permissions to run the latest releases of the following commands:
  • docker, dockerd, docker-compose
  • uuidgen, host, awk, sed, mkdir, chmod, touch, which, echo, hostname, cat, grep, getent, mv, rm, tar, env, cp, gzip, gunzip, date, tee

  • Sudo permissions will also need to be granted to the directories where you place the ARD Hub installation media (ard.sh script), and any other scripts, such as the hub-db-backup.sh.
The 'dockerised' Hub installation was tested successfully in a RedHat Enterprise Linux 7.9 environment with Docker version 20.10.8 and Docker Compose version 1.29.2.
 
NOTE: You must have docker-compose 1.x installed. The installation will fail if you use docker-compose 2.x.
If you have the requirement to install and run ARD Hub without sudo permissions, you cannot use the Docker container. In this case, you will need to install ARD manually.

 

 

Upgrading ARD HUB
The ARD 3.3 Upgrade Path

You cannot upgrade directly from ARD Hub 3.0 o 3.1 to ARD 3.3. You will need to first upgrade to ARD 3.2.7 before upgrading to ARD 3.3.

NOTE: due to changes in the Keycloak component, ARD 3.3 is not backward compatible. You will want to first upgrade the ARD Hub, and then upgrade the ARD Studio. The ARD 3.x Studio can be directly upgraded to ARD 3.3 Studio.

Steps to Upgrade ARD Hub 3.1.1 to ARD Hub 3.2.7

Preinstallation Steps

  1. Download the ARD Hub installation media from the Broadcom Support Portal (https://support.broadcom.com).
    • 'CA Agile Requirements Designer Hub 3.2.7 - Docker Launcher.zip'
    • 'CA Agile Requirements Designer Hub 3.3 - Docker Launcher.zip'

  2. Place the file in the folder of your choice.
    Note: The file is a zip file. The Linux system will need to have the zip and unzip packages installed. You may need to have your Linux Admin help you with this.

Take a backup of the MySQL Database

  1. Get a copy of the hub-db-backup.sh script from support.

  2. Place a copy of the script in a directory that sudo access has been granted

  3. Execute the script by running:
            sudo ./hub-db-backup.sh

  4. The script will create the backup file in the same directory where it was executed from. The file name will be backup-DATE-TIME.sql
            NOTE: you may want to rename the backup file to backup_3.2.7-DATE-TIME.sql, just so you know what version the backup file is from.

ARD 3.2.7 Upgrade Steps

  1. Go to the Broadcom Support Portal (https://support.broadcom.com) and save a copy of the export 'Token' command, and the export 'customer_name' command. You will need to run these commands before running the ard.sh script. These command export temporary user variables used by the ard.sh installation script to pull the ARD images.
    Note: The token is only valid for 2 hours, so do not do this until you are ready to preform the installation.
    • Log into https://support.broadcom.com

    • Select Enterprise Software


    • Select "My Downloads" > "Agile Requirements Designer"


    • Expand the Product SKU that your site has access to. Your choices could be different from the example used.

    • Click the Docker icon that correlates to ARD 3.2.7 release.


    • Copy the provided custom commands and paste them into a terminal window. Run the custom commands to initialize temporary local environment variables:
                  export token='your token'
                  export customer_name='your name'

  2. Change directories to the location where the 'CA Agile Requirements Designer Hub 3.2.7 - Docker Launcher.zip' file was unzipped.

  3. Run the ard.sh script as sudo -E ard.sh to preserve the user's environment variables:
            sudo-E ./ard.sh --hostname <FQDN Hostname> --port 8080 --jvm-heap-max-size <memory allocated to Java Heap in MB>
                Example: sudo -E ./ard.sh --hostname bgray-tdm-dkr01 --port 8080 --jvm-heap-max-size 8192

  4. Log into ARD Hub and verify the upgrade was successful, and Projects/versions, and flows are accessible.

NOTE: The 3.2.7 ard.sh script checks Firewall configurations. If iptables is enabled, a problem could be detected, causing the installation to fail.
If this happens, please follow the steps to resolve the issue.

    For Example:
        Installation failed. Please re-install ARD using following command
            ./ard.sh --reinstall
        In case of repetitive failure contact customer support.

        Checking Firewall configuration...

        #################################     ALERT !!!!     ########################################

        We have detected an issue with the routing from container c6d333ab-hub to the Docker host.
        Please follow instructions below to configure your firewall settings.

        How to configure firewall for ARD Hub on Linux
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        $ iptables -I INPUT -i br-8c86d037c887 -j ACCEPT
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #############################################################################################

To resolve this example problem, run the suggested command as sudo:

        [user@host ard_launcher-3.2.7]$ sudo iptables -I INPUT -i br-8c86d037c887 -j ACCEPT

Then try reinstalling the 3.2.7 Hub

        [user@host ard_launcher-3.2.7]$ sudo -E ./ard.sh --reinstall

If the reinstall is successful, you should see something like:
        
        Installation completed successfully.

        Hub deployment summary

        Using HUB_PORT:       8080
        Using DB_PORT:        3306 (Database: mysql)

        Keycloak URL: http://hostname:8080/ard/api/iam/auth/

        You can now start using Agile Requirements Designer using following URL
            http://hostname:8080/ard/ui

ARD 3.3 Upgrade Steps

These steps will be the same as above:

Take a backup of the MySQL Database

  1. Execute the script by running:
            sudo ./hub-db-backup.sh

  2. The script will create the backup file in the same directory where it was executed from. The file name will be backup-DATE-TIME.sql
            NOTE: you may want to rename the backup file to backup_3.3-DATE-TIME.sql.

ARD 3.3 Upgrade Steps

  1. Go to the Broadcom Support Portal (https://support.broadcom.com) and save a copy of the export 'Token' command, and the export 'customer_name' command. You will need to run these commands before running the adr.sh script. These command export temporary user variables used by the ard.sh installation script to pull the ARD images.
    Note: The token is only valid for 2 hours, so do not do this until you are ready to preform the installation.
    • Log into https://support.broadcom.com
    • Select Enterprise Software
    • Select "My Downloads" > "Agile Requirements Designer"
    • Expand the Product SKU that your site has access to.
    • Click the Docker icon that correlates to ARD 3.3 release.
    • Copy the provided custom commands and paste them into a terminal window. Run the custom commands to initialize temporary local environment variables:
                  export token='your token'
                  export customer_name='your name'

  2. Change directories to the location where the 'CA Agile Requirements Designer Hub 3.3 - Docker Launcher.zip' file was unzipped.

  3. Run the ard.sh script as sudo -E ard.sh to preserve the user's environment variables:
            sudo-E ./ard.sh --hostname <FQDN Hostname> --port 8080 --jvm-heap-max-size <memory allocated to Java Heap in MB>
                Example: sudo -E ./ard.sh --hostname bgray-tdm-dkr01 --port 8080 --jvm-heap-max-size 8192

  4. Log into ARD Hub and verify the upgrade was successful, and Projects/versions, and flows are accessible.

 

 You can now upgrade the ARD Studio to the ARD 3.3 Studio.

Note: If you have users running the ARD 3.2.5 Studio, they continue to use the ARD 3.2.5 studio, until they have time to upgrade their Studio version. However, they will need to add the following parameter in the settings.properties file:  legacy-ard-3.2.5=true

 

Additional Information

Powered by Wolken Software