Installing the Catalyst Center Adapter on the Automation Remote

Last updated
Save as PDF

Installing the Catalyst Center Adapter on the Automation Remote

This section provides step-by-step instructions for installing the Catalyst Center Adapter on the remote. To set up the remote, refer to the procedure in Remote Setup and Deployment.

In addition to the OVA file, you will also need the following files:

• docker-compose.yml (Docker Compose configuration)

• ad-catalystcenter.tar.gz (Adapter tarball)

If you have not received these files, please reach out to the Workflows team by emailing workflows-activation@cisco.com.

Prerequisites

Before proceeding, set the following environment variable in your terminal:

export REMOTE_IP=<YOUR REMOTE IP>

Installation Steps

Copy the Tarball to the Remote Server. Use the scp command to copy the ad-catalystcenter.tar.gz file to the remote server:

scp -i sshkey ad-catalystcenter.tar.gz ubuntu@$REMOTE_IP:~/

Access the Remote Server. SSH into the remote server using the following command:

ssh -i sshkey ubuntu@$REMOTE_IP

Extract the tar file. On the remote server, extract the contents of the tarball:

tar xvfz ad-catalystcenter.tar.gz 
cd ad-catalystcenter

Switch to the superuser:

sudo su

Set the adapter version environment variable:

export ADAPTER_VERSION=0.0.2

Load the Docker image from the tarball:

docker load < ad-catalystcenter:$ADAPTER_VERSION.tar.gz

Tag the Docker image:

docker tag docker.artifactory.ikarem.io/ci/cda/workflows/ad-catalystcenter:$ADAPTER_VERSION 
localhost:5000/cisco-sxo/ad-catalystcenter:$ADAPTER_VERSION

Push the image to the local Docker registry:

docker push localhost:5000/cisco-sxo/ad-catalystcenter:$ADAPTER_VERSION

Stop any existing Docker-Compose Services.

docker compose -f /etc/docker-compose/docker-compose.yaml down

Configure Catalyst Center Adapter. Navigate to the Docker Compose directory:

cd /etc/docker-compose/

Copy and configure the environment file:

cp adapter.web-service.env adapter.catalystcenter.env
chmod 640 adapter.catalystcenter.env

Navigate to the secrets directory:

cd secrets/

Source the common functions script:

source /home/ubuntu/ad-catalystcenter/common-functions.sh

Generate the necessary service certificates:

generate_service_certs adapter.catalystcenter /etc/docker-compose/secrets

Update ownership permissions for the certificates:

chown -R 10001:10001 adapter.catalystcenter

Return to the Docker Compose directory:

cd ..

Add Catalyst Center to Docker-Compose. Copy the provided docker-compose.yml file and place it the /etc/docker-compose/ directory. This file includes the required configuration for the Catalyst Center Adapter.
Start Docker-Compose Services. Start the updated Docker Compose services:

docker compose -f /etc/docker-compose/docker-compose.yaml up -d

The Catalyst Center Adapter should now be successfully installed and running on the specified remote server.