Recommended: Validating your production deployment

Instead of manually checking all the URLs and certificates that are created by your deployment, you can run a script to validate these objects automatically in a few minutes.

About this task

The post-installation script ( is found in the cert-kubernetes repository. The script helps you to assess the readiness of your CP4BA deployment, and to retrieve and validate connection information to all its services. For more information about downloading cert-kubernetes, see Preparing a client to connect to the cluster.

After you downloaded the CASE package and extracted the cert-kubernetes archive, change directory to the /scripts folder under ibm-cp-automation/inventory/cp4aOperatorSdk/files/deploy/crs/cert-kubernetes. The /scripts folder is the root folder ($ROOT_FOLDER) of the post-installation script.

The script has three modes for a production deployment type:

The precheck mode gets some basic information about the cluster, the console, and the client.
The status mode gets the status of all the components from the custom resource (Ready | Not Ready | Not Installed).
The console mode gets the console connection information from the URLs and credentials.

The script can be run with the following options:

./ --help
   --precheck         This mode gives information about the cluster and the client.
   --status           This mode gives the status of the services of the CP4BA deployment. 
   --console          This mode gives the service URLs of the consoles in the CP4BA deployment.  

When you run the script in the status or console mode, the commands display information about the Cloud Pak for Business Automation version and interim fix number of the installed CP4BA deployment. The output also includes the list of CP4BA capabilities that are installed.

If no CP4BA production deployments are found on the cluster, then information about the cluster is displayed along with the following message:

No resources found for CP4BA Production deployment types.

If no CP4BA production deployments are found in the namespace in which you run the script, then information about the cluster is displayed along with the following message:

No CP4BA Production deployment found in namespace NAMESPACE.


  1. Make sure that you downloaded the cert-kubernetes repository to a Linux® based machine (CentOS Stream/RHEL/MacOS) or a client to a Linux-based machine.
  2. Make sure that you are in the $ROOT_FOLDER under cert-kubernetes.
  3. Log in to the target cluster as the <cluster-admin> user.

    Using the Red Hat OpenShift CLI:

    oc login https://<cluster-ip>:<port> -u <cluster-admin> -p <password>

    On ROKS, if you are not already logged in:

    oc login --token=<token> --server=https://<cluster-ip>:<port>
  4. Check the values for the environment variables in the /helper/post-install/ script under the $ROOT_FOLDER.

    The variable that is the most important to check is for the foundational services namespace, as it can be customized and can be either cluster-scoped or namespace-scoped. The default value is set to ibm-common-services, which is for a cluster-scoped instance. If you installed foundational services in a custom namespace, you must change the value for your CP4BA deployment. The following example sets cp4ba-project as the requested namespace-scoped instance.


    Depending on the pattern that you installed, you can also add values for the usernames and passwords in the file.

  5. Run the script in the "precheck" mode.
    ./ --precheck
  6. Run the script in the "status" mode.
    ./ --status
    The status of the listed components can be one of the following values:
    • Ready is used to indicate that the component is installed successfully and ready to use.
    • Not Ready is used to indicate that the component is not installed yet and is not ready to be used.
    • Not Installed is used to indicate that the component is not included in the CP4BA deployment.
    • Not found is used when the status value of the resource is missing. A Not found value usually indicates that the operator is changing the status.
  7. Run the script in the "console" mode.
    ./ --console

    The output provides valuable information about the available consoles, which can be shared and distributed to administrators and users who request access to the Cloud Pak for Business Automation capabilities.

What to do next

Some capabilities need you to follow post-deployment steps. For more information, see Completing post-installation tasks.