Upgrade Volt MX Go server components
The following procedures guide you in upgrading the server components of Volt MX Go.
When clicking the links in the steps in the following procedures, some links open in a new tab and direct you to related product documentation. Expect to switch between browser tabs when executing the procedures.
Upgrade Domino REST API
Make sure to check version compatibility between Volt MX Go and Domino REST API.
- Downloaded the required version of the Domino REST API installer. For more information, see Download the Domino REST API.
- Follow the relevant steps in the upgrade procedure based on your installation platform.
Upgrade Volt MX Go Foundry
As Volt MX Go Foundry supports various installation mechanisms, refer to the relevant upgrade procedure.
For using an installer
The upgrade process works by upgrading the existing database to the latest version, and installing fresh application server artifacts, such as data sources and WARs. For installation details such as hostname, database port, prefix, suffix, you must refer to the installation logs of your previous setup.
The installer does not support automatic backups of database and other artifacts. You must clean up the existing application server artifacts and take a backup of the custom artifacts. The installer also does not support rollback in case of a failure during the upgrade. To roll back, restore the database and server artifacts you backed up before upgrading.
Before you start
- Back up your databases and server artifacts.
- You have downloaded the latest Volt MX Go Foundry installer based on your used installation platform/option. For more information, see Download HCL Volt MX Go Release package.
- Ensure that the installer has execute permission.
- Ensure that you have the path of your previous installation directory.
- Ensure that you stop the application server of your existing Foundry instance, which you want to upgrade.
Follow the link to the upgrade procedure based on your used installation platform/option:
- The upgrade procedure will indicate installation files and installation file download locations. You must use the installer you downloaded in Before you start.
- Check all the details and complete all the applicable steps indicated in the upgrade procedure.
For using helm charts on a supported Kubernetes platform
Before you start
Create a temp directory for the charts.
Run the following to create a temp directory for downloading the charts, and make it the current directory:
mkdir ~/<new directory name> cd ~/<new directory name>
mkdir ~/mxgo201 cd ~/mxgo201
In the example, you create a new directory
mxgo201that will contain the new helm charts. Creating the new directory allows you to differentiate and compare the helm charts from different MX Go versions.
Configure Helm to pull from HCL Container Repository.
You will need your email and authentication token used with the HCL Container Repository.
Run the following command to check if
hclcris already defined:
helm repo list
hclcris already defined, proceed to Download Foundry charts step. Otherwise, execute the following step to set up Helm.
hclcrpoints to voltmxgo-ea, you should remove it and then proceed to the next step to set up Helm.
Run the following command to set up Helm:
helm repo add hclcr https://hclcr.io/chartrepo/voltmxgo --username <your hclcr username> --password <your hclcr password>
helm repo add hclcr https://hclcr.io/chartrepo/voltmxgo --username firstname.lastname@example.org --password xx3ds2w
Use the CLI secret value you saved from obtaining authentication token from HCL Container Repository as your authentication token or password.
If you get an error message similar to the following:
Error: looks like https://hclcr.io/chartrepo/voltmxgo is not a valid chart repository or cannot be reached: failed to fetch https://hclcr.io/chartrepo/voltmxgo/index.yaml : 401 Unauthorized
Most likely, you haven't specified your username or authentication token correctly. Make sure the case and content matches exactly what's listed on the HCL Container Repository site and retry.
Download Foundry charts.
Run the following command to make sure that the chart information for the repositories is up-to-date.
helm repo update
See Volt MX Go and Helm chart version compatibility to know the latest Helm chart version.
Run the following commands to download the Foundry charts, unpack the files, and move the
values.yamlfile to the current directory:
mkdir foundry cd foundry helm pull hclcr/voltmx-dbupdate helm pull hclcr/voltmx-foundry tar -xzf voltmx-foundry-1.n.n.tgz tar -xzf voltmx-dbupdate-1.n.n.tgz mv voltmx-foundry/values.yaml ./ mv voltmx-foundry/init-guids.sh ./ chmod +x init-guids.sh
The foundry and dbupdate chart names have a version string in the filename. The
helm pullcommand will pull down the latest version of the charts. Ensure your tar command uses the correct matching file names.
upgrade.propertiesfile from your prior deployment and copy it into the same directory as your
Invoke the init-guids script specifying the file path of the prior deployment's
upgrade.propertiesby running the following command:
./init-guids.sh --upgrade ./
- Update the
values.yamlfile of the target upgrade version with custom settings you want to apply from the
values.yamlfile of your current installation.
Remove the dbupdate deployment by running the following command:
helm uninstall dbupdate -n mxgo
Scale down existing Foundry deployments to zero by running the following commands:
kubectl scale deployment --replicas=0 voltmx-foundry-console kubectl scale deployment --replicas=0 voltmx-foundry-apiportal kubectl scale deployment --replicas=0 voltmx-foundry-integration kubectl scale deployment --replicas=0 voltmx-foundry-identity
Confirm that the ready count has dropped to zero by running the following command:
kubectl get deployment
You should get an output similar to the following where the ready count has dropped to zero:
NAME READY UP-TO-DATE AVAILABLE AGE drapi 1/1 1 1 5h40m voltmx-foundry-console 0/0 0 0 51m voltmx-foundry-identity 0/0 0 0 51m voltmx-foundry-integration 0/0 0 0 51m voltmx-foundry-apiportal 0/0 0 0 51m
Confirm the removal of the pods by running the following command:
kubectl get pods
You should get an output similar to the following where the Foundry pods have been removed:
NAME READY STATUS RESTARTS AGE drapi-6949c45b8-wghbz 3/3 Running 0 5h40m mysql-0 1/1 Running 0 5h36m
Within the directory containing the new Foundry charts, upgrade the databases by running the following command:
helm install dbupdate voltmx-dbupdate -f values.yaml
After a successful database upgrade, upgrade the Foundry applications by running the following command:
helm upgrade foundry voltmx-foundry -f values.yaml
This updates the deployment configuration and spins up new pods to run the latest version of the applications.
After completing the upgrade installation of Domino REST API and Volt MX Go Foundry, proceed to Install and upgrade Volt MX Go Iris.