How do I apply a TDM Portal Patch to a docker installation?

Products

CA Test Data Manager (Data Finder / Grid Tools)

Issue/Introduction

I am running an older version of the TDM Portal on docker.I need to update to a new version of the TDM Portal docker images. Please provide an overview of the steps needed.

Environment

TDM Portal for Docker

Cause

Resolution

Download the latest build from the Support patches page:
TDM Support Patches.

*******************NOTE*********************
If you copy the command below, make SURE TO REPLACE the - in front of the -f, or you will get an error about unknown command -f

Example:
docker-compose -f ./docker-compose-messaging.yml up -d
No such command: -f

Below are the steps to update to the new version.

Download the docker container zip file.
We need to stop and remove all the Docker orphans that might remain
- docker-compose –f ./docker-compose-masking.yml down
- docker-compose –f ./docker-compose.yml down
- docker-compose –f ./docker-messaging.yml down –remove-orphans
- docker volume list
- docker volume rm tdm_messaging_rabbitmqdb
  
  (It is assumed) that the gtrep repository has been backed up.
Follow the README_INSTALL.md file that was shipped with the image package that you are installing for instructions to load the new containers into your Docker installation.

From the readme-install.md, you will install the following containers.

- Installing Core TDMWeb Images
  - docker load -i ./TDM_images/orientdb/orientdb-2.x.xx.tgz
  - docker load -i ./TDM_images/messaging/messaging-4.x.xxx.x.tgz
  - docker load -i ./TDM_images/action-service/action-service-4.x.xxx.x.tgz
  - docker load -i ./TDM_images/masking/masking-4.x.xxx.x.tgz
  - docker load -i ./TDM_images/tdmweb/tdmweb-4.x.xxx.x.tgz
  - docker pull zoopkeeper:x.x.x
- Installing TDM Tools Image
  - docker load -i ./TDM_images/tdmtools/tdmtools-4.x.xxx.x.tgz

To run the new TDM in Docker, follow the steps fond in the README-RUN.md file that was shipped with the image package that you installed above.

Customizing docker-compose files

Before running TDM in docker, you must customize the docker-compose files according to your requirements.

The following items should be provided:
* Update the **docker-compose-environment.yml** file with GTREP database connection properties.

* OPTIONAL: Port numbers and passwords can also be changed, if required.

* OPTIONAL: Host names of the remote services (services running on different machines) must be provided instead of the default ones.
Refer to the Upgrade TDM Portal in Docker product documentation for details.

• Make backup copies of all the docker-compose*.yml files located in the TDM_HOME/conf folder

• Update the new docker-compose*.yml files with your latest changes (Please review your original docker-compose*.yml and update the new one with the same values)

• Copy the updated docker-compose*.yml files into the TDM_HOME/conf folder.
For example: /bin/cp ./docker-compose*.yml $TDM_HOME/conf/
Check the TDM stack to verify the docker images are currently running.
- docker stack services tdm-stack
If you are seeing your older docker images, you will need to remove the TDM stack, and redeploy using the proper updated docker-compose yml files.
(This command does not remove the docker volumes)
- docker stack rm tdm-stack
Redeploy the TDM docker stack using the updated docker-compose yml files.
- docker stack deploy --compose-file=docker-compose.yml --compose-file=docker-compose-messaging.yml --compose-file=docker-compose-masking.yml --compose-file=docker-compose-service-orchestration.yml --compose-file=docker-compose-volumes.yml --compose-file=docker-compose-environment.yml tdm-stack
Verify the TDM docker stack is now running the correct version of TDM services.
- docker stack services tdm-stack

Additional Information

How to restart the masking container:
docker-compose -f docker-compose-masking.yml -f docker-compose-messaging.yml restart masking