Install ARD Hub Using a Docker Container

The provided docker container simplifies ARD Hub installation.
ard31
The advantage of the Docker-based on-premise installation of ARD Hub is that it is easier to configure, upgrade, and back up for the system administrator. One script,
ard.sh
, sets up the whole ARD Hub environment. If you have the requirement to install and run ARD Hub without sudo permissions, you cannot use the Docker container; in this case, follow the instructions how to install ARD Hub manually.
ARD Hub components and roles
Requirements
  • Verify the ARD Hub installation requirements on the ARD Installation Requirements page
  • Verify you have sudo permissions to run the ard.sh script and
    docker
    ,
    dockerd
    ,
    docker-compose
    , and other Linux commands listed on the ARD Installation Requirements page
  • Verify the service account has sudo permissions to start the Docker container
  • You will need an internet connection to download Docker images online, or import the Docker images manually into an offline Docker repository
Download the ARD Hub Installer
Follow these steps:
  1. Log on the Customer Support Site at https://support.broadcom.com.
  2. Select
    Enterprise Software > Product Downloads
    , then select Agile Requirements Designer. The available packages are listed.
  3. Choose 3.1 from the menu in the
    Release
    column.
  4. Click the package to drill down to individual products.
  5. Download or FTP transfer the Docker installation ZIP and unzip it.
    Verify that you have received the ard.sh installer file.
  6. Click the Docker icon in the "Token Generation" column.
    The download instructions window opens.
  7. Copy the provided custom commands and paste them into a terminal window. Run the custom commands to initialize temporary local variables.
    export token='
    your token
    ' export customer_name='
    your name
    '
Download the ARD Hub Docker Images (Offline)
If your system has access to the Internet, skip this step.
If the target system for the ARD Hub installation has
no access to the Internet
, pre-download the Docker images now, and import them into your offline docker repository:
Follow these steps:
  1. Run the following commands on the command line of a computer with internet access.
    ./ard.sh --get-files docker pull percona:ps-5.6 docker pull jboss/keycloak:5.0.0 docker pull traefik:1.7.12-alpine docker image save -o percona.ps-5.6.tar percona:ps-5.6 docker image save -o keycloak.5.0.0.tar jboss/keycloak:5.0.0 docker image save -o ard_aux.tar ard/aux:
    3.1.1.214
    docker image save -o hub.tar ard/hub:
    3.1.1.214
    docker image save -o traefik.1.7.12-alpine.tar traefik:1.7.12-alpine
  2. Verify that you have downloaded the following files:
    ard_aux.tar, hub.tar, keycloak.5.0.0.tar, percona.ps-5.6.tar, traefik.1.7.12-alpine.tar
  3. Move these TAR files to the computer without internet access where you want to install ARD Hub.
  4. Run the following commands on the computer without internet access to import the images to your local Docker registry:
    docker image load -i percona.ps-5.6.tar docker image load -i keycloak.5.0.0.tar docker image load -i ard_aux.tar docker image load -i hub.tar docker image load -i traefik.1.7.12-alpine.tar
  5. Identify your ARD version tag. Open the ard.sh script and copy the tag from the third line. In the following example, the tag for ARD 3.1.1 is 3.1.1.214. For ARD 3.1.2, it would be 3.1.2.215.
    HUB_VERSION=3.1.1.214
  6. Replace the word
    TAG
    in the following commands with the obtained tag. Replace 3.1.1 with the respective ARD version number. Run the commands on the computer without internet access. The following example is for ARD 3.1.1.
    docker tag ard/aux:
    3.1.1
    ard/aux:
    3.1.1.214
    docker tag ard/hub:
    3.1.1
    ard/hub:
    3.1.1.214
Install ARD Hub
The script can identify the default hostname, but you can also provide the fully-qualified hostname (FQDN), without the
http(s)://
prefix, explicitly when launching the script.
If a non-root user runs the
ard.sh
script, it displays the error message “You must be root to run this script. Hint: sudo ./ard.sh”, and exits with return code 100.
Follow these steps:
  1. Run the ARD Hub installer. Provide your fully qualified ARD Hub hostname, a port, and increase the Tomcat's server's default memory allocation. Run
    one
    of the following commands:
    • If you are online:
      ./ard.sh --hostname
      hub_server.mycompany.com
      --port 8080 --jvm-heap-max-size 8192
    • If you use an offline repository:
      ./ard.sh --hostname
      hub_server.mycompany.com
      --port 8080 --jvm-heap-max-size 8192 --offline
    • If you want to use HTTPS:
      ./ard.sh --hostname
      hub_server.mycompany.com
      --port 8080 --jvm-heap-max-size 8192 --proxy-ssl-enable
    For more information about options such as ports and ssl proxies, see Upgrade, Reconfigure, or Back Up ARD Hub.
  2. Wait for the installation to complete.
    The installer installs Docker images, creates configuration files, and proceeds with the ARD Hub installation. The installer creates a
    /var/ard/application-data/.ard
    folder which contains configuration files. When the script completes, it prints the URL of the ARD web interface.
    Example:
    http://hub_server.mycompany.com:8080/ard/ui
  3. If you are a customer using the PLA license, configure your pla.properties file now. For more information, see Configure the License.
  4. Open your web browser and verify that you can log into the ARD web interface with the admin password. By default, the admin password is
    admin
    .
Now that you have installed ARD Hub and the web interface, add users to the Hub by configuring the LDAP connection, so users can log in using their existing Active Directory Directory accounts.