Installing on Kubernetes

You can install HCL Accelerate onto a Kubernetes cluster.

Before you begin

The ID that you use to install the product must be able to make changes to the host environment. The tools required by all installation scenarios include the following items:
  • Docker installed on the host system.
    Note: If you use Docker for Windows, make sure Docker is using Linux-type containers. HCL Accelerate does not support Windows-type containers.
  • Internet connection. During installation, files and container images are retrieved from remote locations. If you are unable to access the internet during installation, you can download the files beforehand and perform an offline installation. HCL Accelerate supports the following browsers: Chrome, Firefox, and Edge.
    Note: Steps to retrieve the container images from public repository to your private repository:

    Use pull command to pull the container images from public repository.

    $ docker pull public repo

    Use tag command to tag the public and private repository.

    $ docker tag public repo private repo

    Use push command to push container images to private repository.

    $ docker push private repo

    All the container images are retrieved from public to private repository.

Note: The installation files used for offline installation are not the same as those used for internet-connected installation. Ensure that you download the right file for you installation environment.

If you are performing an offline installation of HCL Accelerate, GraphQL Playground will not load for use.

In addition to the requirements for all installation scenarios, the following items are required for Kubernetes or Minikube installation:

  • Kubernetes 1.4+ with Beta APIs enabled.
  • If you want to use Minikube, it must be installed onto a hypervisor appropriate for your operating system. On Linux you might use Oracle Virtual Box; on Windows you might use Hyper-V.
  • The CLI that is used for both Minkube and Kubernetes, Kubectl, installed and configured.
  • Helm v2.6.0 or later. Helm is the Kubernetes package manager. Helm uses charts to manage Kubernetes resources, such as those that comprise HCL Accelerate.
  • MongoDB database installed with a persistent volume. Version 3.6 or later is required. Instructions for installing MongoDB are provided below. Supported MongoDB versions include 3.6, 4.0, and 4.2.
  • For Minikube, add the Minikube IP address to your hosts file and assign a host name to it. Kubernetes requires a host name rather than a simple IP address. On Linux, the file location is etc/hosts; on Windows, the location is C:\Windows\System32\drivers\etc\hosts.
  • If you are using offline installation, you need 4GB free in your /tmp or \temp directory.

Get a key. The key enables you to complete installation. Visit the HCL Accelerate web portal to obtain your key. After completing the form, you will receive a confirmation email with an access key. Store the key in a readily-available location; you use it during installation.

About this task

You install the product by running the installation script that copies the Helm chart to your environment and sets installation parameters. After the script finishes, you run Kubernetes Helm commands that pull the product images from a GitHub repository and place them into the cluster defined in the Helm chart.

Additionally, you connect your installation to a MongoDB, and configure an SSL certificate. If you are using Minikube, you also need to configure an ingress.

If you need to modify project default parameters, installation options are stored in the \<installation>\values.yaml file. Other parameters are maintained in the yaml files in the \<installation>\templates directory. For example, to configure ephemeral Argo pods, you can modify the executor parameter in the .../templates/workflow-controller-configmap.yaml file.

Note: To avoid Windows UAC permission issues, use PowerShell as administrator.


  1. Download the installation file for your environment.
    Note: For macOS and Linux installations, set the appropriate permissions before running the file: sudo chmod +x.
  2. Run the downloaded executable file.
  3. Run the installation script and respond to the prompts as described in the following steps.
    When the script starts, you are prompted to accept the license. You can explicitly accept the license without viewing it by appending the following parameter to the command:
    ./<accelerate-installation-file> --license=accept
    1. At the Please enter your HCL Accelerate access key prompt, enter your SE version access key.
      If you previously installed an SE version, the already-configured key is the default value.
      Note: Make sure that you enter the key for the right version.
    2. At the Enter your encryption key or leave blank to use the default. Key must be at least 8 characters prompt, enter your encryption key or leave blank to use the default encryption key.
      Note: The encryption key must be at least 8 characters. Save the encryption key to use for further upgrades.
    3. At the Choose the platform prompt, select Kubernetes.
    4. At the Enter the location where the HCL Accelerate files will be installed prompt, enter the location where you want to install the product files.
      Files are copied to the specified directory in a subdirectory named product_version_number.
    5. At the Please enter the hostname where you will run HCL Accelerate prompt, enter the host name where users can access the Web UI.
      The host name must resolve to a name on your DNS server, or in the server's hosts file. On Linux, the file location is etc/hosts; on Windows, the location is C:\Windows\System32\drivers\etc\hosts.
      Note: You cannot use localhost as the hostname. If you do not have any host names defined, for testing purposes you can use This location will redirect back to, which is typically used by localhost.
    6. To enforce limits on resources, set the values for the resource flags for all containers and use the customConfigFile flag to set the path of the JSON file that contains values that are specified for individual services.
      An example of an install command using the new flags follows:

      /velocity-ibm-install-1-5-5-macos --resourcesRequestsCpu 60m --customConfigFile resources.json

      You can use the following flags in the command:
      • resourceLimitsMemory
      • resourceLimitscpu
      • resourceRequestMemory
      • resourceRequestcpu
      • customConfigFile
      Note: A resources.json code example follows.
        "resources": {
          "limits": {
            "memory": {
              "default": "1Gi",
              "application-api": "3Gi"
            "cpu": {
              "application-api": "2"
          "requests": {
            "memory": {
              "release-events-ui": "256Mi"
            "cpu": {
              "multi-app-pipeline-api": "45m",
              "release-events-ui": "55m"
    The Helm chart is copied to /my_installation/version_number/velocity-version.tgz. The installation properties are saved in a file located at /home/ucv/settings.json.
  4. If you do not have a MongoDB database installed, install one now. Follow the instructions at the MongoDB GitHub repository.
    Below is a sample command for installing the MongoDB version 3.6:
         helm install velocity-mongo
         --set persistence.enabled=false, mongodbRootPassword=password
         --set image.tag=3.6 bitnami/mongodb
    Note: To install MongoDB version 4.0, change the --set image.tag=4.0
    Note: To install MongoDB version 4.2, change the --set image.tag=4.2
    Note: If Helm cannot find the chart, try running the following command: helm repo add bitnami If your organization uses a different repository, substitute it for bitnami/mongodb.
    To verify the installation, you can use the following commands:

    helm list

    helm status velocity-mongo

    To list all pods in the namespace, use the following command:

    kubectl get pods

    After the installation of MongoDB, use the below command to get the encrypted password

    kubectl get secrets velocity-mongo-mongodb -o yaml

    Search for the field mongodb-root-password: in encrypted password.

    Use the command echo -n "enter the mongodb-root-password" | base64 --decode to decrypt the encrypted password.

    Use decrypted password to connect the application.

  5. Create an SSL certificate and key and store them in the velocity-secret.yml file.
    1. Create the velocity-secret.yml file.
      Paste the following code fragment into your file:
            apiVersion: v1
             tls.crt: <BASE64 Encoded>
             tls.key: <Base64 Encoded>
           kind: Secret
             name: velocitytls
             namespace: default
           type: Opaque
      Note: Ensure the code does not contain any line breaks.
    2. Generate a public key and a private certificate.
      You can use OpenSSL to generate the certificate and key, which is installed on most Linux distros. On Windows, the easiest way to get OpenSSL is with Git. Git installs a copy in its Program Files\Git\usr\bin directory. The following example creates a certificate named certificate.pem:
      openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certificate.pem
    3. Encrypt the certificate.
      The following code fragment illustrates how to encrypt the certificate on Linux:
      cat certificate.pem | base64
    4. Copy the encrypted certificate and then paste it into the tls.crt field in the velocity-secret.yml file.
    5. Encrypt the private key and paste it into the tls.key field in the velocity-secret.yml file.
    6. Apply velocity-secret.yml file to your installation.
      You can use the kubectl command to apply your secret:
      kubectl apply -f velocity-secret.yml
      If the process is successful, you will see a message similar to the following one:
      secret/velocitytls created
  6. Enable your ingress and ensure that it points to your host by completing these steps:
    1. For a full Kubernetes installation, you can use the following two commands:
      helm repo add bitnami
      helm install velocity-ingress bitnami/nginx-ingress-controller
    2. If you are using Minikube, use the following command instead to enable the ingress: minikube addons enable ingress.
  7. Note: If you are installing HCL Accelerate in amazon elastic kubernetes service cluster, change the version of the kube from kubeVersion:'>=1.11.0' to kubeVersion:'>=1.11.0-r0' in chart.yml file.
    Determine the configuration properties for the helm install command.
    The values.yaml file is located in /my_installation/version_number/velocity-version.tgz. The following code fragment displays a typical command:
         helm install uc-velocity \
         ./velocity-<version>-helm.tgz \
         --set access.key=my_access_key \
         --set license=accept \
         --set url.domain=my_hostname \
         --set mongo.url=mongodb://mongo:mongo@velocity-mongo-mongodb:27017
         --set license=accept

    Properties depend on your environment. The following properties are required. The optional properties are given later.

    The product access key obtained earlier.

    The hostname of your node or the Ingress host name.

    The URL of the MongoDB. Specify the following parameters.
    The user ID to authenticate with the MongoDB database. For example, mongo.
    The associated password to authenticate with the MongoDB database. For example, mongo.
    If you connect to an authenticated MongoDB database, you can use authSource to specify the database where authenticated users are defined. For example, if the admin user is defined in the admin database, you can use mongodb://root:password@velocity-mongo-mongodb?authSource=admin.
    The port number for the MongoDB database. Use the value shown in the example, which is 27017.
    The MongoDB URL or the MongoDB service name if it is running within the Kubernetes cluster. For example, velocity-mongo-mongodb.
    The name of the database to be used by HCL Accelerate. For example, velocity.
    Note: If you used the install command in the previous step to install the MongoDB, use the following values for the mongo.url property.
    --set mongo.url=mongodb://mongo:mongo@velocity-mongo-mongodb:27017

    If you use the default Bitnami MongoDB, make sure to grant the MongoDB user full write privileges.

    The name space where the Helm chart is applied, and the name of Helm chart. Deprecated for Helm 3.0 or later.
    --name uc-velocity ./velocity-<version>-helm.tgz
  8. Optional: If you need to enforce limits on resources, modify the executor parameter in the velocity/templates/workflow-controller-configmap.yaml file.
    For example, to limit ephemeral Argo pods, you might use the following parameter values:
           config: |
             containerRuntimeExecutor: kubelet
             namespace: velocity
                   cpu: 1
                   memory: 2Gi
                   cpu: 50m 
                   memory: 512Mi
  9. Run the helm install command to install the HCL Accelerate images into your Kubernetes cluster.
    After you run the command, Kubernetes displays status information about the installation.

    Refer to the displayed NOTES section for the location of the Minikube administrator dashboard. You manage your Minikube installation on the admin dashboard.

What to do next

When all the containers have the status of running, the installation is complete and you can access HCL Accelerate at the URL you specified in the helm chart. You can refresh the status display by using the following kubectl command: kubectl get pods. The default admin user name is admin and the default password is admin.

The following Helm chart parameters are optional:

A random string or GUID that is used verify the authenticity of API calls and data.

Automates license acceptance. Use the value accept to accept the license.

A 32-byte Hex that is used verify the authenticity of API calls and data.
A 32-byte Hex that is used verify the authenticity of API calls and data.

The level of logging. Values for this property are: all, debug, info, warn, error, fatal, and off. The default is all.