Volt MX Go v10
Install Domino REST API
Guides you in installing Domino REST API.
Before you begin
Important
Make sure to check version compatibility between Volt MX Go and Domino REST API.
Procedure
-
Download the Domino REST API installer. For more information, see Download the Domino REST API
in the HCL Domino REST API documentation.
-
Follow the links to the installation procedure based on your preferred installation platform:
-
Complete all the post-installation tasks
.
For more information, see the Installation and configuration page in the HCL Domino REST API documentation
.
Install Volt Foundry
Starting from Volt MX Go v10, install the supported version of Volt Foundry using available installation mechanisms. The use of Helm charts and a single container solution are also supported for installing Volt Foundry.
A Volt MX Go license must be used to activate Volt Foundry in the My HCLSoftware Portal for Volt MX Go features to work.
For using an installer
Before you begin
You have downloaded the Volt Foundry installer. The minimum supported version is v10.0.1.
For more information, see Download HCL Volt MX Go installers.
Procedure
For installing Volt Foundry, click the link to the installation guide corresponding to your installation platform and follow the installation steps.
Important
-
Make sure to check all the details and complete all the applicable procedures indicated in the sections in the installation guides.
-
After completing the installation, a Volt MX Go license must be used to activate Volt Foundry in the My HCLSoftware Portal for Volt MX Go features to work. For more information, see the license activation guide
on the Volt MX documentation.
For using Helm charts on a supported Kubernetes platform
Before you begin
-
You have downloaded the Volt Foundry Helm charts. The minimum supported version is v10.0.1.
For more information, see Download HCL Volt MX Go installers.
Note
If you want VoltScript enabled for Volt Foundry, proceed to Enable VoltScript in Volt Foundry before proceeding with the following prerequisites and the installation procedure.
-
You have obtained the authentication token from the HCL Container Repository.
- You have completed all the installation prerequisites
.
- You have reviewed the configuration parameters and identified their required values as you must provide them during the installation. For more information, see Configuration
.
Procedure
-
Click the link to the installation guide and follow the installation steps.
Volt Foundry Container Helm installation guide
Note
Make sure to check all the details and complete all the applicable steps indicated in the installation guide.
-
After completing all applicable steps in the installation guide, update the
values.yaml
file.- Locate the
values.yaml
file in the Volt Foundry directory. - Open the
values.yaml
file with your preferred editor and locate the line containing theimageRegistry:
key. - Change the value of the
imageRegistry:
key to"hclcr.io/voltmxgo
. - Save your changes and close the file.
- Locate the
-
Execute the
helm upgrade foundry
command to upgrade the running images to use Volt MX Go.
Important
After completing the installation, a Volt MX Go license must be used to activate Volt Foundry in the My HCLSoftware Portal for Volt MX Go features to work. For more information, see the license activation guide on the Volt MX documentation.
For single container solution
For more information, see Volt Foundry Single Container Solution in the Volt MX Documentation.
Before you begin
- You have obtained the authentication token from the HCL Container Repository.
- You have completed all the installation prerequisites
.
- You have reviewed the configuration parameters and identified their required values as you must provide them during the installation. For more information, see Configuration
.
-
You have downloaded the Volt Foundry Single Container install script. The minimum supported version is v10.0.1
For more information, see Download HCL Volt MX Go installers.
Procedure
-
Click the link to the installation guide and follow the installation steps.
Volt Foundry Single Container Solution installation guide
Note
- The installation guides indicate installation files and installation file download locations. You must use the installer you downloaded as indicated in the Before you begin section.
- Make sure to check all the details and complete all the applicable steps indicated in the installation guide.
-
Update the
docker-compose.yml
file.- Locate the
docker-compose.yml
file in the Volt Foundry directory. - Open the
docker-compose.yml
file with your preferred editor and locate the line containing theimage:
key. -
Change the value of the
image:
key from"hclcr.io/voltmx/voltmx-foundry-db:<version>_GA"
to"hclcr.io/voltmxgo/voltmx-foundry-db:<version>_GA"
, wherein <version> corresponds to the Volt Foundry release version.For example,
"hclcr.io/voltmxgo/voltmx-foundry-db:10.0.0.1_GA"
. -
Save your changes and close the file.
- Locate the
-
Stop the existing images by running the command
docker compose down
. - Restart the images by running the command
docker compose up -d
.
Important
After completing the installation, a Volt MX Go license must be used to activate Volt Foundry in the My HCLSoftware Portal for Volt MX Go features to work. For more information, see the license activation guide on the Volt MX documentation.
Next step
Before proceeding, make sure you have activated Volt Foundry using a Volt MX Go license in the My HCLSoftware Portal for the Volt MX Go features to work. For more information, see the license activation guide on the Volt MX documentation.
After completing the installation of Domino REST API and Volt Foundry, proceed to Install Volt Iris.