Upgrade Datawiza Access Proxy (Docker Version)

This document shows you how to upgrade Datawiza Access Proxy instances in a Docker environment.

First, I assume you have started the Datawiza Access Proxy with a command similar to below:

docker compose up -d

To upgrade that instance, you will need to:

1. Go to (e.g., SSH) the host running Datawiza Access Proxy;

2. Go to the directory where your docker-compose.yml file is located. By default, this is typically your home directory (for example, /home/john), unless you've specified a different location.

3. Create a backup of the current image:

   docker tag registry.gitlab.com/datawiza/access-proxy registry.gitlab.com/datawiza/access-proxy:bak
   

4. (Optional) If you haven’t logged in to our docker registry, please do the following.

   docker login registry.gitlab.com -u datawiza-deploy-token -p ************
   

   You can retrieve the password from Guideline of Deployment Detail in DCMC::

   Info

   We may update our docker registry login password or credential from time to time. So if you fail to log in, please contact us info@datawiza.com to obtain the latest credential.

5. Now pull the latest Access Proxy image from Datawiza docker image repository:

   docker pull registry.gitlab.com/datawiza/access-proxy:latest
   

6. Stop the existing docker process:

   docker compose down -v
   

7. Now bring up docker container again:

   docker compose up -d
   

Rollback

If you encounter any issues and need to revert to the previous version, follow these rollback steps:

1. Rollback to the backup image:

   docker tag registry.gitlab.com/datawiza/access-proxy:bak registry.gitlab.com/datawiza/access-proxy
   

2. Stop the existing docker process:

   docker compose down -v
   

3. Now bring up docker container again:

   docker compose up -d
   

You can also put the above steps into an Ansible playbook or any other similar DevOps playbooks.

Info

Depending on your environment, you may need to use docker compose or docker-compose for the commands listed above.