Backup & restore on offline environments

Follow the instructions below to backup and restore your air-gapped Axiomatics Services Manager (ASM) deployment.

Backup

1. Stop all services except for the databases.

   docker stop docker-adm-1 docker-service-aggregator-1 docker-asm-1 docker-gateway-1 docker-keycloak-1 docker-pd-api-1 docker-pd-ui-1

2. Enter the container.

   docker exec -it -u postgres docker-db-1 bash

3. Dump the databases inside the container.

   cd /tmp
   pg_dump asm > asm.sql
   pg_dump keycloak > keycloak.sql
   pg_dump domain_manager > domain_manager.sql
   pg_dump pd > pd.sql
   note

   Verify that the output files aren't empty and contain valid data.

4. Exit the container.

   exit

5. Copy the SQL files to the host.

   docker cp docker-db-1:/tmp/asm.sql .
   docker cp docker-db-1:/tmp/keycloak.sql .
   docker cp docker-db-1:/tmp/domain_manager.sql .
   docker cp docker-db-1:/tmp/pd.sql .

6. Optionally, if you are using custom Attribute Connectors, back up the contents of the docker/asm.core/attribute.connectors/custom-attribute-connectors folder.

   note

   The older http-pip and parser-pip are also included in this directory. To keep using them, you should back them up along with the rest of the folder contents. However, you should consider switching to the new refactored HTTP Attribute Connector 5.0.0Opens in a new tab and Parser Attribute Connectors 1.0.0Opens in a new tab that are bundled with ASM 7.5.

Restore

1. Stop all services except for the databases.

   docker stop docker-adm-1 docker-service-aggregator-1 docker-asm-1 docker-gateway-1 docker-keycloak-1 docker-pd-api-1 docker-pd-ui-1

2. Copy the SQL files to the new database container.

   docker cp <path_to_file>/asm.sql docker-db-1:/
   docker cp <path_to_file>/keycloak.sql docker-db-1:/
   docker cp <path_to_file>/domain_manager.sql docker-db-1:/
   docker cp <path_to_file>/pd.sql docker-db-1:/

3. Enter the container.

   docker exec -it -u postgres docker-db-1 bash

4. Drop the databases, create them again and run the SQL files.

   psql template1 -c 'drop database asm'
   psql template1 -c 'drop database keycloak'
   psql template1 -c 'drop database domain_manager'
   psql template1 -c 'drop database pd'
   psql template1 -c 'create database asm'
   psql template1 -c 'create database keycloak'
   psql template1 -c 'create database domain_manager'
   psql template1 -c 'create database pd'
   psql asm < asm.sql
   psql keycloak < keycloak.sql
   psql domain_manager < domain_manager.sql
   psql pd < pd.sql

5. Exit the container.

   exit

6. Start all the service's containers again.

   docker start docker-adm-1 docker-service-aggregator-1 docker-asm-1 docker-gateway-1 docker-keycloak-1 docker-pd-api-1 docker-pd-ui-1