Environment variables for silent mode installation

A silent installation of the Cloud Pak operator for either a starter or production deployment needs a minimum set of environment variables. The variables must be created before the cluster setup script is run.

The following example sets the environment variables that you need to install a production deployment on an OpenShift® Container Platform.

export CP4BA_AUTO_PLATFORM="OCP"
export CP4BA_AUTO_DEPLOYMENT_TYPE="production"
export CP4BA_AUTO_FIPS_CHECK="Yes" 
export CP4BA_AUTO_PRIVATE_CATALOG="No" 
export CP4BA_AUTO_NAMESPACE="silent-install"
export CP4BA_AUTO_CLUSTER_USER="username"
export CP4BA_AUTO_ENTITLEMENT_KEY="XXXXX"
export CP4BA_AUTO_SEPARATE_OPERATOR="No"
export CP4BA_AUTO_AIRGAP_MODE="No"
Table 1. Environment variables to export
Parameters Description Example values
CP4BA_AUTO_AIRGAP_MODE Select Yes for an offline (air gap) environment. Select No for an online environment. Yes
CP4BA_AUTO_CLUSTER_USER This parameter is optional. Set an existing user on an OCP or ROKS cluster. Typically, this user is the non-admin user that runs the deployment script. The user is given the required roles to install the Cloud Pak for Business Automation custom resource. "username"
CP4BA_AUTO_CS_SERVICE_NAMESPACE The project name to install the Cloud Pak foundational services. If CP4BA_AUTO_SEPARATE_OPERATOR is set to No, you do not need to define this value.  
CP4BA_AUTO_DEPLOYMENT_TYPE Valid values are: "starter" and "production". "starter"
CP4BA_AUTO_ENTITLEMENT_KEY The IBM® entitlement key variable that is used to pull the images for OCP and ROKS platform deployments.
If you enter a value for the entitlement key, you do not need to set any of these parameters:
  • CP4BA_AUTO_PUSH_IMAGE_LOCAL_REGISTRY
  • CP4BA_AUTO_LOCAL_REGISTRY
  • CP4BA_AUTO_LOCAL_REGISTRY_PASSWORD
  • CP4BA_AUTO_LOCAL_REGISTRY_USER
 "XXXXXX"
CP4BA_AUTO_FIPS_CHECK If you plan to enable FIPS for a CP4BA deployment, you can use the cluster setup script to check that the compute nodes are FIPS enabled on the OCP cluster.

Use Yes to proceed with this check.

 No
CP4BA_AUTO_LOCAL_REGISTRY The name of the image registry. "hyc-cloud-private-daily-docker-local.artifactory.swg-devops.com"
CP4BA_AUTO_LOCAL_REGISTRY_PASSWORD The password for the username. "XXXXXX"
CP4BA_AUTO_LOCAL_REGISTRY_USER The username to use to pull the images from the image registry. "XXXX@example.com"
CP4BA_AUTO_NAMESPACE The target namespace to deploy the Cloud Pak operator. "my-namespace"
CP4BA_AUTO_OPERATOR_NAMESPACE The project name to install the CP4BA operators. If CP4BA_AUTO_SEPARATE_OPERATOR is set to No, you do not need to define this value.  
CP4BA_AUTO_PLATFORM Valid values are: "ROKS" and "OCP". "OCP"
CP4BA_AUTO_PRIVATE_CATALOG You can install CP4BA from a private catalog (namespace scope) or the global catalog namespace (GCN). The private option uses the same target namespace as the CP4BA deployment, and the GCN uses the openshift-marketplace namespace.

Use Yes to install CP4BA from a private catalog rather than in the global catalog namespace (GCN).

 No
CP4BA_AUTO_PUSH_IMAGE_LOCAL_REGISTRY The local registry where you pushed the images. Valid values are: true or false. true
CP4BA_AUTO_SEPARATE_OPERATOR Valid value: Yes/No. If the input is Yes, the script installs the CP4BA operators and the CP4BA deployments in separate namespaces. No