Running the maintenance tool for TrueSight Orchestration in containers

A maintenance tool is available with the installation bundle for TrueSight Orchestration in containers. Using the maintenance tool, you can backup logs, remove components, and remove unused containers or volumes. 

Each of the supported action in the maintenance tool is used for a specific reason. If you want to remove TSO components and clean up your containers before installing it again, you must first backup the logs. You can also use the maintenance tool to remove unused containers and volumes from your docker environment. Used objects utilize extra disk space, so it is advisable that you maintain your environment regularly. 

To run the maintenance tool to check the service status

1. Open a terminal and SSH into the host where you want to perform any cleanup activity. 

2. Go to the DOCKER_TSO_INSTALLER > files > maintenance-tool folder and run the following script. 

   # ./tso_maintenance_tool.sh

   TrueSight Orchestration Platform Maintenance Tool is started and you see the following options: 
   

3. To check the status of the services, type 1. 
   After successfully checking the service status, the tool stops running. 

To run the maintenance tool to backup logs

1. To back up the component logs, run the tso_maintenance_tool.sh script again, and from the list of supported actions, type 2 (Backup TrueSight Orchestration Component Logs option) to backup logs. You see with the following options: 

   Please select component to backup logs -
   1) TSO Configuration Distribution Peer  3) Exit
   2) TSO Repository
   Select the component - 1 or 2 (3 to exit) : 3
2. To back up CDP logs, type 1.
   The maintenance tool verifies whether the component service is running on the current node and then copies the log files in a zip folder at the location that you specify in the tool. If no location is specified, by default, the zip file is copied in the /opt folder. After backing up the logs, the script stops running. 
3. Perform Step 1 again and from the backup log options, type 2 to backup the repository logs. 

To run the maintenance tool to remove components

To remove TrueSight Orchestration components from a container, do the following steps on each host where the components are installed: 

1. Run the tso_maintenance_tool.sh script again, and from the list of supported actions, type 3 (Remove Stack option). 

2. Type y to continue.
   You see the following options: 

   1. Remove stack with complete data clean up (This will also clean-up the data in the mounted volume on this node).
   2. Remove stack without data clean up.
   3. Exit
   Please select the uninstallation type - 1 or 2 (3 to exit) :
3. To remove the components completely and cleanup data in the mounted volumes, type 1. 
   Docker starts the cleanup task, removes containers, removes volumes, and exits from the script. 
   OR
4. To remove the components without removing the volumes or containers, type 2.
   Docker starts the cleanup task, and only the "tso_stack" is removed. 

To run the maintenance tool to prune the containers

If you need to remove unused containers, use the maintenance tool. Only those containers that are in the Exited state are removed from the stack. This option does not affect the running containers. 

1. Run the tso_maintenance_tool.sh script again and from the list of supported actions, type 4 (Containers Prune option).
   Containers that are in the Exited state are listed. 
2. Type y to continue with removing containers. 
   Unused containers are removed.

To run the maintenance tool to prune volumes

Use this option to remove all unused volumes in your environment. 

1. Run the tso_maintenance_tool.sh script again and from the list of supported actions, type 5 (Volumes Prune option).
   Volumes mounted from TSO containers are listed. 
2. Type y to continue with removing volumes. 
   Unused volumes are removed. 

Related topics

Installing – In containers