Skip to main content

Upgrading

About 1 min

Upgrade Datawiza Access Proxy (Docker)

This document shows you how to upgrade Datawiza Access Proxyopen in new window instances in a Dockeropen in new window environment.

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

docker-compose -f {DOCKER-COMPOSE-FILE}.yml up -d

To upgrade that instance, you will need to:

  1. Go to (e.g., SSH) the host running Datawiza Access Proxy;
  2. (Optional) Check your Docker process if needed to confirm the process is there:
    a. docker ps
  3. Create a backup of the current image: a. docker tag registry.gitlab.com/datawiza/access-proxy registry.gitlab.com/datawiza/access-proxy:bak
  4. Stop the existing docker process:
    a. docker-compose -f {DOCKER-COMPOSE-FILE}.yml down -v
  5. (Optional) If you haven’t logged in to our docker registry, please do the following.
    NOTE: 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.
    a. docker login registry.gitlab.com -u datawiza-deploy-token -p ************ You can retrieve the password from Guideline of Deployment Detail in DCMC:: docker login
  6. Now pull the latest Access Proxy image from Datawiza docker image repository:
    a. docker pull registry.gitlab.com/datawiza/access-proxy:latest
  7. Now bring up docker container again:
    a. docker-compose -f {DOCKER-COMPOSE-FILE}.yml up -d

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

  1. Backup the faulty image: a. docker tag registry.gitlab.com/datawiza/access-proxy registry.gitlab.com/datawiza/access-proxy:faulty
  2. Rollback to the backup image: a. docker tag registry.gitlab.com/datawiza/access-proxy:bak registry.gitlab.com/datawiza/access-proxy
  3. Stop the existing docker process:
    a. docker-compose -f {DOCKER-COMPOSE-FILE}.yml down -v
  4. Now bring up docker container again:
    a. docker-compose -f {DOCKER-COMPOSE-FILE}.yml up -d

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

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