Deploying CDP Admin UI

This section describes the steps to configure and deploy the HCL CDP Admin UI on an AKS cluster using the provided Helm chart.

Before you begin

The required HCL CDP Helm charts and container images must be downloaded and pushed to the container registry. For more information, see the Downloading HCL CDP Artifacts section.

Create the CDP UI secret in HashiCorp Vault with the following sample key-value structure and update with actual values:

{
  "AKAMAI_HOST": "",
  "AKAMAI_KEY": "",
  "AKAMAI_KEY_NAME": "",
  "AKAMAI_PATH": "",
  "AKAMAI_PURGE_AUTH_KEY": "",
  "API_KEY_1": "", "API_KEY_2": "", "API_KEY_3": "",
  "API_KEY_4": "", "API_KEY_5": "", "API_KEY_6": "",
  "API_SECRET_1": "", "API_SECRET_2": "", "API_SECRET_3": "",
  "API_SECRET_4": "", "API_SECRET_5": "", "API_SECRET_6": "",
  "AUTH_TOKEN": "",
  "NEXTAUTH_SECRET": "",
  "NEXT_PUBLIC_CLIENTID": "",
  "NEXT_PUBLIC_CLIENTSECRET": "",
  "NEXT_PUBLIC_CLIENT_ID": "",
  "NEXT_PUBLIC_CLIENT_SECRET": "",
  "NEXT_PUBLIC_FROALA_SECRET": "",
  "NEXT_PUBLIC_GOOGLE_CLIENT_ID": "",
  "NEXT_PUBLIC_GOOGLE_CLIENT_SECRET": "",
  "NEXT_PUBLIC_RECAPTCHA_KEY": "",
  "REACT_APP_CLIENT_ID": "",
  "REACT_APP_S3_ACCESS_KEY_ID": "",
  "REACT_APP_S3_SECRET_KEY": "",
  "auAuthKey": "", "auEndpoint": "",
  "host": "",
  "muAuthKey": "", "muEndpoint": "",
  "password": "",
  "sesEmail": "", "sesPassword": "",
  "smtpFrom": "", "smtpHost": "", "smtpPassword": "", "smtpPort": "", "smtpUser": "",
  "usAuthKey": "", "usEndpoint": "",
  "user": ""
}

Procedure

  1. Configure chart-location/cdp-admin-ui/values.yaml with the environment-specific configuration.
  2. Enable ConfigMaps and configure the required CDP UI application URLs.
  3. Update the CDP UI container image repository and required image version/tag.
  4. Verify the image pull secret exists.
    kubectl get secret hclcr-cred -n cdp-dev-app
  5. Enable Ingress and configure the required hostname, path, and TLS settings.
  6. Ensure the vault-creds Secret exists.
    kubectl get secret vault-creds -n cdp-dev-app
  7. The init container retrieves the ui secret from CDP_Secrets and writes it to /etc/secrets/mysecrets.json.
  8. Verify or create the namespace.
    kubectl get namespace cdp-dev-app

    If the namespace does not exist, create it:

    kubectl create namespace cdp-dev-app
  9. Install CDP UI using Helm.
    helm install cdp-admin-ui \
      chart-location/cdp-admin-ui \
      -f chart-location/cdp-admin-ui/values.yaml \
      -n cdp-dev-app
  10. Verify the Helm release status.
    helm list -n cdp-dev-app

    Expected status: deployed.

  11. Verify the deployment and pods.
    kubectl get deployment -n cdp-dev-app
    kubectl get pods -n cdp-dev-app -l k8s-app=admin-ui

    Expected pod status: READY 1/1, STATUS Running.