Introduction

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.

TABLE OF CONTENTS

• Introduction
• 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. Start the docker containers and clean up the old image
• 6. 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

Please note: 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 the version number as it's needed to ensure the extension versions you're downloading are compatible.  

Figure 4 Saas version download pop-up.

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. 

Please note: It's important to download the offline version because the online version will automatically update and make the extensions incompatible with the Vizlib Server version installed. 

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

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.

Figure 8 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

Figure 9 Ensure image has the Vizlib Server version number. 

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.

5. 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

6. 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 10 docker logs for vizlib-server container when Vizlib Server is running.