Updating Vizlib Cloud Server for Qlik Cloud (SaaS)

The steps on this page describe updating Vizlib Server for Qlik Cloud.

This example shows an update on Google Cloud Platform (GCP); the steps apply to Amazon Web Services (AWS), Azure, or a private cloud but how you perform the step may differ depending on the platform.

This topic contains the following sections:

• 1. Export your config file
• 2. Download the files and update the extensions
• 3. Replacing the image file
• 4. Update the docker-compose.yml with the new version tag
• 5. (Optional) Update the PostgreSQL version
• 6. Start the docker containers and clean up the old image
• 7. Verify that the container is running

1. Export your config file

Before you begin the upgrade process, you must export your configuration from the Dashboard in the Vizlib Management Console (VMC). This step ensures that if there's an error during the upgrade process, you can rollback to a previous version.

Click the Download Config button.

Figure 1:  Vizlib Server dashboard

Save the config file in a folder on your disk.

Figure 2:  Save the config as a JSON file on disk

2. Download the files and update the extensions

The Extensions and Vizlib Server must be upgraded at the same time to make sure the versions are compatible.

Download Vizlib Server docker container and extensions from the Vizlib Portal.

From the Vizlib Portal, select Vizlib Server, open the versions pop-up, and select the latest version of Vizlib Server for Qlik Cloud by clicking Saas Versions under Download product in the panel to the right of the page.

Figure 3:  Vizlib Server section in the Vizlib Portal

Open up the versions pop-up to select the latest version of Vizlib Server for Qlik Cloud. From the panel on the right, in the Download product section, click Saas Versions.

Note: Note the version number as it's needed to ensure the extension versions you're downloading are compatible.

Figure 4:  Download options

Download the compatible extension versions to the Vizlib Server version you downloaded. Click the Collaboration section under Products.

Open up the Extensions pop-up by clicking Extensions under Download product in the panel to the right of the page.

Figure 5:  Collaboration section in the Vizlib Portal

The Extensions pop-up displays all the versions of the extensions included in the Vizlib Collaboration product.

Figure 6:  Extensions pop-up

Filter the version by typing Table in the search field at the top to only show the Vizlib Writeback Table versions. Find the latest version that is compatible with the Server version you downloaded.

Click the Offline download button to download the extension.

Figure 7:  Filtered Vizlib Writeback Table versions in Extensions pop-up

Replace Table with Input in the search field at the top to only show the Vizlib Input Form versions. Find the latest version that is compatible with the Server version you've downloaded.

Click the Offline download button to download the extension.

Filtered Vizlib Input Form versions in Extensions pop-up

3. Replacing the image file

Delete the old container file with this command:

rm vizlib-server.tar.gz

Upload the new vizlib-server.tar.gz to the vizlib-server folder.

4. Update the docker-compose.yml with the new version tag

Edit the docker-compose.yml by running this command:

nano docker-compose.yml

Update the version tag to the correct version that corresponds to the version you downloaded. Save the file after you update the version tag.

Figure 9 Ensure image has the Vizlib Server version number

5. (Optional) Update the PostgreSQL version

Run this step if your docker-compose.yml lists image: postgres:14 as the image for Vizlib Server's configuration database and you want to update to a newer PostgreSQL database version. These steps guide you through creating a backup of your PostgreSQL 14 database to restore it on PostgreSQL 15.18 and to keep the backup in case you need to restore it later.

Prerequisites

• Old PostgreSQL 14 container is running

• docker-compose.yml file updated to postgres:15.18 but not yet applie

Note: The commands below use postgres as the container name, sa as the user, and collaboration as the database. If your setup uses different values, replace them accordingly.

Step 1: Dump from PostgreSQL 14

Run the following commands to create a database dump:

docker exec postgres pg_dump -U sa -d collaboration -F c -f /tmp/collaboration.dump
		docker cp postgres:/tmp/collaboration.dump ./collaboration.dump

The -F c flag specifies the custom binary format, which produces a smaller and more reliable dump than plain SQL format for restore operations.

Step 2: Stop and remove old container and data

Run the following commands:

docker compose down
			mv ./pg-data ./pg-data-backup-pg14
		rm -rf ./pg-data

Step 3: Start PostgreSQL 15

Run the following command. Ensure that the image is set to postgres:15.18 in your docker-compose.yml before running this step:

docker compose up -d postgres

Wait approximately 5 seconds for the cluster to initialize.

Step 4 – Restore the database

Run the following commands to restore your database:

docker cp ./collaboration.dump postgres:/tmp/collaboration.dump
		

docker exec postgres pg_restore -U sa -d collaboration -F c /tmp/collaboration.dump

Step 5: Verify the restoration

Run the following command to verify that your tables have been restored:

docker exec -it postgres psql -U sa -d collaboration -c "\dt"

You should see your tables listed in the output.

Step 6: Start Vizlib Server

Run the following command to start all services:

docker compose up -d

Restore the database from the created backup if anything goes wrong

Perform the following steps:

1. Stop PostgreSQL 15 container:

   docker compose down

2. Remove the new data directory:

   rm -rf ./pg-data

3. Revert the image in the docker-compose.yml file back to postgres:14.
4. Start the old container:

   docker compose up -d postgres

5. Restore the database:

   docker cp ./collaboration.dump postgres:/tmp/collaboration.dump
   				docker exec postgres pg_restore -U sa -d collaboration -F c /tmp/collaboration.dump

6. Verify the restoration:

   docker exec -it postgres psql -U sa -d collaboration -c "\dt"

7. Start Vizlib Server:

   docker compose up -d

6. Start the docker containers and clean up the old image

Start the docker containers and clean up the old image by running this command:

docker load < vizlib-server.tar.gz && docker-compose up -d && docker image prune -f

7. Verify that the container is running

Verify that the container is running correctly by checking the docker logs. Check that there are no errors. Type this command for the vizlib-server container:

docker logs vizlib-server

Figure 8:  docker logs for vizlib-server container when Vizlib Server is running