CloudShell Version: 2023.3 GA
Guide Version: 1.0

Deploy QualiX 5.0 and up Using Docker

This article explains how to deploy/upgrade QualiX version 5.0 and up.

Note that there are two versions of the deployment script:

deploy-qualix-docker-5.0.1.506.sh installs both the required containers and QualiX on a clean machine.

guacamole-quali-install-docker-5.0.1.506.sh install Qualix startup scripts and requires Docker to be installed on the machine as a prerequisite

Deployment and Upgrade

There are three ways to deploy Qualix 5.0 (and up):

Deploy on a clean VM
Upgrade QualiX on an existing OVA VM
Upgrade QualiX on an existing Docker machine

Prerequisites

OS: Ubuntu (20.04, 22.04), Centos or RHEL (need subscription)

Deploy on a clean VM

To deploy QualiX on a clean VM:

Download the latest version of the deploy-qualix-docker.sh deployment file from CloudShell Download Center.

Install QualiX.

wget h <qualix deployment script path>
 chmod +x <qualix deployment script>
 <qualix deployment script>

Where <qualix deployment script path> is the full path to the script, and <qualix deployment script> is the script's filename and extension.

For example:

wget https://quali-prod-binaries.s3.amazonaws.com/deploy-qualix-docker-5.0.1.506.sh
chmod +x deploy-qualix-docker-5.0.1.506.sh
deploy-qualix-docker-5.0.1.506.sh

Set QualiX Configuration for Version 5.0 and up.
Start QualiX.
```
qualix_start
```
Run QualiX.

Upgrade QualiX on an existing OVA VM

Stop and disable the qualix-tomcat, qualix-guacd, qualix-wmks-proxy, and nginx services.

systemctl stop qualix-tomcat; systemctl disable qualix-tomcat

systemctl stop qualix-guacd; systemctl disable qualix-guacd

systemctl stop qualix-wmks-proxy; systemctl disable qualix-wmks-proxy

systemctl stopnginx; systemctl disable nginx

Install QualiX.

wget h <qualix deployment script path>
 chmod +x <qualix deployment script>
 <qualix deployment script>

Where <qualix deployment script path> is the full path to the script, and <qualix deployment script> is the script's filename and extension.

For example:

wget https://quali-prod-binaries.s3.amazonaws.com/deploy-qualix-docker-5.0.1.506.sh
chmod +x deploy-qualix-docker-5.0.1.506.sh
deploy-qualix-docker-5.0.1.506.sh

Run QualiX.

Upgrade QualiX on an existing Docker machine

Stop Qualix.
```
qualix_stop
```
Back up and uninstall the existing QualiX installation.
```
mv /opt/qualix /opt/qualix_bcp
```

Install QualiX.

wget h <guacamole-quali-install script path>
 chmod +x <guacamole-quali-install script>
 <guacamole-quali-install script>

Where <guacamole-quali-install script path> is the full path to the script, and <guacamole-quali-install script> is the script's filename and extension.

For example:

wget https://quali-prod-binaries.s3.amazonaws.com/guacamole-quali-install-docker-5.0.1.506.sh
chmod +x guacamole-quali-install-docker-5.0.1.506.sh
guacamole-quali-install-docker-5.0.1.506.sh

Start Qualix.
```
qualix_start
```
Run QualiX.

Run QualiX

Once QualiX deployment/upgrade completes, enable the appropriate services.

Available services

-g enables guacamole, which allows users to use RDP/SSH/VNC/TELNET protocols for remote connections.
-w enables wmks-proxy which allows users to connect to VMs using Vcenter Console.
-n enables nginx services for enhanced security. Enabled automatically when running wmks-proxy. Aggregates the above services to a single entry point, handles security headers and SSL Options for connections, provides additional security and logging capabilities.
-v prints version information and quits.

Available combinations

Guacamole Service + Nginx Service - Enable Guacamole Service. Allows users to handle security capabilities with Nginx Proxy. This is the default combination.
Guacamole Service + WMKS-Proxy Service + Nginx Proxy - Enable Guacamole and WMKS-Proxy services with a single entry point. Handle security capabilities with Nginx Proxy.
WMKS-Proxy Service + Nginx Proxy - Enable WMKS-Proxy service only, WMKS-Proxy can only work with enabled Nginx.
Guacamole Service - Enable Guacamole service only. Nginx Proxy service is not used. This option could be useful when use the service in a cluster. For example, AWS or Azure.

Notes:

Options 1 - 3 from the above list use Nginx Proxy service, which requires SSL options to be configured. For details, see Nginx proxy service options.
Option 4 uses the Guacamole service only. To configure SSL options for Guacamole, see JKS Keystore options, SSL settings for Guacamole Tomcat.

Example

qualix_start -g -n -w

Additional Options

Check the status of the QualiX containers:
```
qualix_status
```

Docker logs

See Docker logs (QualiX 5.0 and above).