To install the Cloud Pak capabilities with the Cloud Pak operator, a cluster
administrator user must run a script to set up the cluster. They also need to provide a
non-administrator user the information that they need to be able to run the deployment script. Each
Cloud Pak capability can be installed with extra components. Postgres and OpenLDAP are always
installed.
About this task
The cluster setup script is one of several scripts that are provided to help you install the
Cloud Pak capabilities. You must be a cluster administrator to run the setup script. For more
information, see user
archetypes.
The cluster setup script identifies or creates a namespace and applies the custom resource
definitions (CRD). The script provides the administrator with the cluster hostname on the cluster
and available storage classes. This information must be provided to the user who runs the deployment
script.
Note: The admin setup script does not set any parameters in the custom resource (CR) because the
administrator might not be using the same host as the user who runs the deployment script.
A new installation of Cloud Pak for Business Automation always includes a
namespace-scoped instance of foundational services when you use the scripts.
Use the following steps to complete the set up.
Procedure
-
Log in to the target cluster as the
<cluster-admin>
user.
If you are not already logged in on OpenShift (OCP), then log in using the
oc
CLI:
oc login https://<cluster-ip>:<port> -u <cluster-admin> -p <password>
On
IBM Cloud (ROKS), if you are not already logged in use the following
command:
oc login --token=<token> --server=https://<cluster-ip>:<port>
- A script must be run to install IBM License Service and IBM Certificate Manager.
- For 23.0.1
GA Clone the
ibm-common-service-operator
scripts from Git to a client of your target
cluster.git clone -b scripts https://github.com/IBM/ibm-common-service-operator.git
Go
to the ibm-common-service-operator/cp3pt0-deployment directory.
From 23.0.1-IF001 Go to your downloaded
cert-kubernetes
folder.
cd cert-kubernetes/scripts/cpfs/installer_scripts/cp3pt0-deployment
- Log in to the target cluster from a
client.
oc login https://<CLUSTERIP>:<port> -u <ADMINISTRATOR>
- Run the following
command:
./setup_singleton.sh --enable-licensing --license-accept
- Change the directory to the extracted
cert-kubernetes/scripts folder.
cd ${PATH_TO_EXTRACTED_FILES}/cert-kubernetes/scripts
-
Run the cluster setup script and follow the prompts in the command window.
./cp4a-clusteradmin-setup.sh
- Select the platform type: ROKS (1) or OCP (2).
- Select the deployment type starter.
- Enter the name for a new project or an existing project (NAMESPACE) for the
target deployment namespace. For example,
cp4ba-starter
.If you select to create
a new project, make sure that you create the service account (SA) and security context constraints
(SCC) in that new project. For more information, see Preparing for a starter deployment.
- Enter Yes to confirm that you have an IBM Entitlement Registry key.
- Enter your IBM Entitled Registry key and login credentials (user and password). For more
information, see Preparing for a starter deployment.
Tip: If you ran the
cp4a-clusteradmin-setup.sh script and you see one or more of the following
messages, then make sure that you start Docker or Podman and run the script
again.
Error saving credentials: error storing credentials
Error: unable to connect
The Entitlement Registry key failed
The following message is displayed:
[INFO] Checking the IBM Cert-manager Operator ready or not
...
[INFO] Applying the latest IBM CP4BA Operator catalog source...
[✔] IBM CP4BA Operator catalog source Updated!
Results
When the script is finished, all of the available storage class names are displayed along with
the infrastructure node name. Take a note of the following information and provide it to the Cloud
Pak admin user as they are needed for the deployment script:
- Project name or namespace.
- Storage class names.
- Username to log in to the cluster.
Verify the deployment to make sure that all pods are Running. Using the OpenShift
CLI:
oc get pods
To get the operator log, run the following commands:
podname=$(oc get pod | grep ibm-cp4a-operator | awk '{print $1}')
oc logs $podname -c operator -n $NAMESPACE
A ClusterServiceVersion (CSV) for the operators appear in the target namespace, and APIs provided
by the operators are available to use. Run the following command to get the CSVs:
oc get csv -n $NAMESPACE
Note: The version number (23.1.0) of the installed operators corresponds to the channel for Cloud Pak for Business Automation
23.0.1.