3.3 Installing OpenText Cloud Bridge Agent Instances

This section provides instructions for installing the OpenText Cloud Bridge Agent (“the Agent”) in a new environment. To upgrade an existing Agent environment, see Upgrading Your Agent Environment.

Before you can install the OpenText Cloud Bridge Agent, you must have already installed a supported Linux® operating system and a Docker® or Podman environment on the host server where you plan to install the Agent. For more information, see the following topics:

You can install the OpenText Cloud Bridge Agent anywhere on the Docker® or Podman host server, but OpenText recommends that you use a standard installation location for each Agent instance. Wherever you install the Agent, the installation script installs an agent directory. The agent directory contains the scripts, the .env file containing the encryption Key and IV values, and additional directories as follows:

  • <Agent_install_dir>/agent/conf contains the bridge-agent.yml and DataCenter.json files

  • <Agent_install_dir>/agent/log holds the rolling log files

  • <Agent_install_dir>/agent/bridgelib holds the connector.jar files

  • <Agent_install_dir>/agent/update contains temporary connector .jar files and pending update actions

  • <Agent_install_dir>/agent/backup holds .jar files for connectors that you have deleted or updated, and .json files containing the history of actions you have performed

3.3.1 Installing Your Primary Agent Instance

You can install a single Agent instance in your environment, but OpenText recommends also installing secondary and backup Agent instances to ensure high availability for your users. Depending on the size of your organization, you might need to set up more than one site. For more information, see Planning for High Availability.

IMPORTANT:Ensure that you download the installation script within the time window that the SaaS operations team specified for your installation. After this time, the script will no longer be available for download and you will have to request another script.

  1. After you receive the Agent download instructions from the SaaS operations team, open a command line and navigate to the folder where you want to install the Agent.

  2. Copy and paste the provided curl command, then press Enter.

    This command downloads and runs the installation script specific to your organization.

  3. At the prompt, specify the desired priority for the Agent instance as follows:

    • If you want the instance to be the Primary instance (the default), enter 0 or just press Enter.

    • Enter 1 for Secondary.

    • Enter 2 for Backup.

    NOTE:If you need to make any changes to your Agent instance or site settings at a later time, you can rerun the installation script. For more information, see Updating High Availability and Other Agent Settings.

  4. At the prompt, specify the desired priority for the Agent site as you did for the Agent instance.

    The installer displays a generated Instance ID for the Agent consisting of the host name and random letters, but you can change this ID to a more meaningful name.

  5. (Optional) Type your desired Instance ID and press Enter to save it.

    The installer then checks whether Docker® or Podman is installed and displays the version.

  6. At the prompt, enter the user name for the Agent administrator (cbagent) and set a password.

    You will use these credentials to log in to the Agent console and add credentials for your data source.

    The script then installs the OpenText Cloud Bridge Agent. When installation is complete, the Agent comes up and sends a heartbeat to the SaaS operations center.

  7. Log in to OpenText Advanced Authentication and perform the following steps:

    1. Configure an external repository to an on-premises LDAP source. For more information, see “Adding a Cloud Bridge External Repository” in the OpenText™ Advanced Authentication SaaS Administration Guide.

      IMPORTANT:If you are setting up an OpenText™ Cloud Bridge external repository in OpenText Advanced Authentication for an OpenText Identity Governance tenancy, use the format TENANT_ID_AA_ER for the external repository name, where TENANT_ID is in uppercase.

    2. Copy the data source connection credential ID from the OpenText Advanced Authentication user interface. You will need this credential ID in OpenText Cloud Bridge.

  8. (Conditional) If you have OpenText Identity Governance, log in to OpenText Identity Governance, configure a data source connection, then copy the unique ID for that connection. For more information, see “Collecting Data Using Cloud Bridge” in the OpenText™ Identity Governance User and Administration Guide.

  9. (Conditional) If you have other OpenText SaaS products that you want to use with OpenText Cloud Bridge, log in to those products and configure data source connections as described in the documentation for those products.

  10. In a supported browser, go to the OpenText Cloud Bridge Agent URL:

    http://localhost (Agent_IP_address_or_DNS_name):8080

  11. Log in to the OpenText Cloud Bridge Agent console using the bootstrap administrator credentials:

    • User name: cbagent
    • Password: The password that you set when you ran the installation script

  12. (Optional) On the Dashboard tab, verify that the site and instance priorities you set for the Agent during installation are correct.

    NOTE:The Instance Id is the generated identifier or the name that you specified for the current Agent instance.

    The Target Id is the name of the primary Agent instance in a high availability environment. It is the instance with which the OpenText Cloud Bridge Client communicates. The Instance Id and the Target Id might be the same if you are currently viewing the primary Agent instance or if you have only one Agent instance in your installation.

  13. Click the Data Source Management tab and add your data source connection credentials. For more information, see Manage Credentials for Data Source Connections.

  14. (Optional) In OpenText Advanced Authentication, click the Test button to verify that the data source connection works.

After you have installed your primary Agent instance, consider installing additional Agent instances for high availability. For more information, see Installing Secondary and Backup Agent Instances.

For more information about using OpenText Cloud Bridge with other OpenText SaaS products, see the following resources:

3.3.2 Installing Secondary and Backup Agent Instances

After you have installed your primary Agent instance, you can install secondary and backup instances following the same steps that you used for your primary Agent instance. For more information, see Installing Your Primary Agent Instance.

Each instance of the Agent configuration in your high availability environment must use the same encryption IV and key values. Using the same values on all Agent instances ensures that no disruptions will occur during failovers. For more information about encryption keys and IVs, see Understanding Encryption IV and Key Values.

NOTE:If you have a scenario where you need to back up credentials on an existing Agent server and plan to reinstall the Agent, you should make note of the original key and IV from the old Agent before you uninstall it. When you import the credentials into the newly installed Agent, you will need to provide the key and IV from the old Agent.

To reuse the encryption key and IV from the first Agent instance:

  1. On your primary Agent instance, locate and open the .env file. Copy the encryption key and IV from this file.

  2. Install your secondary Agent instance.

    The installation script creates the /agent directory on the secondary instance, but the instance has its own encryption key and IV at this point.

  3. On the secondary Agent instance:

    1. Enter the following command to stop the instance:

      sh <Agent_install_dir>/agent/stop.sh

    2. Open the agent/.env file:

      vi <Agent_install_dir>/agent/.env

    3. Replace the KEY and IV entries in the .env file with the KEY and IV values from the primary Agent instance.

  4. Because the second instance created the Docker® container on the installation, it must be replaced for the new key and IV to be used. Enter the following commands to replace the pod definition with the updated key and IV properties:

    sh <Agent_install_dir>/agent/remove.sh
    sh <Agent_install_dir>/agent/create.sh

  5. Start the secondary instance back up with the start script:

    sh <Agent_install_dir>/agent/start.sh

    The second instance initializes, and OpenText Cloud Bridge recognizes both Agents as running in a high availability system.

NOTE:If you need to change your Agent instance or site settings at any point, you can rerun the installation script and make updates. For more information, see Updating High Availability and Other Agent Settings.