Troubleshooting the Assistant chat Helm chart installation

Edit online

You can check and debug the deploy.sh script, pods, Red Hat OpenShift Container Platform (RedHat OCP) , image pull errors, database connections, and more.

Using the debug script

If you are using the deploy.sh script, use the built-in debug command to gather comprehensive diagnostic information. This command collects pod status and problems, logs, environment variables, events, and configuration details to help identify issues.
bash
./deploy.sh -d <pod-name>

Debugging pods and clusters by using co commands

Common causes to problems include missing or invalid values in the values.yaml file, insufficient cluster resources, or image pull errors. Missing environment variables or insufficient resources can also cause restarts.

  1. Log in to Red Hat Open Shift: 
    bash
oc login -u <oc-username> -p <oc-password> <oc-cluster-api>

    If you see a warning about an insecure connection, add --insecure-skip-tls-verify=true to the command.

  2. Describe the problematic pod:
    bash
oc describe pod <pod-name> -n <namespace>
  3. Retrieve container logs:
    bash
oc logs deployment/z-database-assistant -c <container-name> -n <namespace>
  4. Verify that all required fields in the values.yaml file are populated.

Image pull errors

  1. Verify the image pull secret and registry credentials:
    bash
oc get secret zdba-image-pull-secret -n <namespace> -o yaml
  2. Ensure that env.entitlementKey in the values.yaml file is set to your valid IBM Cloud API key.

Database connection issues

  1. Check the PostgreSQL container logs:
    bash
oc logs deployment/z-database-assistant -c postgres -n <namespace>
  2. If you are using persistent storage (dbdata.enabled: true), verify that the storage class is available and the PVC is bound.

Route not accessible

  1. Get the route configuration:
    bash
oc get routes -n <namespace>
oc describe route engine -n <namespace>
  2. Ensure that the route host name is accessible from your network and that TLS termination is configured correctly.
  3. To view route details after deployment, run ./deploy.sh -r.

    The deployment creates multiple routes for different services. Use the engine route to access the main UI.

If you need more help, contact IBM Software Support with relevant deployment details, including pod status, logs, and configuration by running this command: deploy.sh -d.