Prerequistes for enabling Analytics in DevOps Velocity

You can find information on the prerequiste tasks required to enable Analytics in HCL DevOps Velocity (Velocity). You can enable the Analytics feature in HCL DevOps Velocity (Velocity) by configuring Keycloak for authentication and upgrading the Velocity by using Helm. Analytics services require Keycloak authentication for secure communication.

Before enabling Analytics, you must complete the following prerequisites:

1. Install Keycloak 26.5.6.
2. Download and run the script to create the necessary clients for the Velocity application and Analytics (OpenSearch) server.
   Note: You must download the compressed file from here: keycloak-setup script. Refer to the README.md file included in the bundle for instructions to run the script.
3. Upgrade the Velocity instance by providing the Keycloak URL and OpenSearch client secret for Velocity in Keycloak.
   Here is a sample command to upgrade Velocity with the Keycloak and Analytics configuration:

   helm upgrade velocity -n <custom_namespace_name> \
                   ./accelerate-<version>-helm.tgz \
                   --set license=accept \
                   --set url.domain= <domain_name or I.P address>\
                   --set access.key=<access_key>\
                   --set mongo.url=<mongodb url>\
                   --set secrets.imagePull=<ibm-entitlement-key>\
                   --set secret.tls=<tls_secrete_name>\
                   --set rabbitmq.nodePort=31672 \
                   --set loglevel=ALL \
                   --set externalKeycloak.enabled=true \
                   --set externalKeycloak.Url=https://<keycloak_hostname>/realms/devops-velocity\
                   --set opensearch.clientSecret="<keycloak-velocity-client-secret>"
                   --set opensearch.fsGroup=1001

   Before running the Helm command, you must understand the following configuration parameters that connect Keycloak and Analytics pods:

   • externalKeycloak.enabled=true: Enables Velocity integration with an external Keycloak server. This enablement is mandatory to deploy the Analytics pods for accessing the Analytics.
   • externalKeycloak.Url=https://<keycloak_hostname>/realms/devops-velocity\: Enables connecting with Keycloak server. You must replace <keycloak_hostname> with your Keycloak server hostname or IP address.
   • opensearch.clientSecret="<keycloak-velocity-client-secret>": Enables OpenSearch clients to use Keycloak. You must replace the <keycloak-velocity-client-secret> with the secret value configured for the opensearch client in Keycloak.
   • opensearch.fsGroup=1001: Sets file system group to 1001 to ensure proper permissions for the OpenSearch setup.

   These parameters ensure that Velocity can authenticate users via Keycloak for accessing Analytics securely.

   After the upgrade, perform the following steps to ensure that Analytics is accessible:

   1. Log in to Velocity using Login with OIDC.
   2. Enter the Keycloak username and password.
   3. Click the Analytics icon from the left navigation pane to view the dashboards.