Setting up the cluster for the control plane
If you plan to install control plane on IBM® Cloud Pak for Data, a cluster administrator must set up the cluster for control plane.
Before you begin
Required role: To complete this task, you must be a cluster administrator.
Before you set up the cluster for control plane, ensure that:
- The cluster meets the minimum requirements for installing control plane. For details, see System requirements.
- The machine from which you will run the commands meets the requirements described in Preparing your installation node.
- On air-gapped clusters: You completed the steps in Preparing for air-gapped installations to download the required files for the service.
./cpd-cli adm --help
cpd-cli
)
command-line interface requires the oc
command-line interface. If you have not used
the oc
command-line interface on this machine, ensure that it works:- On the machine from which you will run the commands, log in to the cluster as an
administrator:
oc login OpenShift_URL:port
- Run a command to ensure that the
oc
command-line interface can communicate with the cluster:oc get nodes
- Log out of the cluster:
oc logout
Procedure
- Set up the cluster for control plane by completing the appropriate task for your environment:
- Complete the tasks listed in What to do next
Preparing clusters connected to the internet
From your installation node:
- Change to the directory where you placed the Cloud Pak for Data command-line interface and the repo.yaml file.
- Log in to your Red Hat® OpenShift® cluster as an
administrator:
oc login OpenShift_URL:port
- Run the
following command to see a preview of the list of resources that must be created on the
cluster:
./cpd-cli adm \ --repo ./repo.yaml \ --assembly lite \ --arch Cluster_architecture \ --namespace Project \ --latest-dependency
Important: By default, this command gets the latest version of the assembly. If you want to install a specific version of control plane, add the following line to your command after the--assembly
flag:--version Assembly_version \
Additionally, you can remove the
--latest-dependency
flag to get the minimum required version of any software that control plane is dependent on.Tell the person who will install control plane whether you used either of these flags. The
install
command must be run with the same flags.Replace the following values:
Variable Replace with Assembly_version The version of control plane that you want to install. The assembly versions are listed in System requirements for Cloud Pak for Data.Cluster_architecture Specify the architecture of your cluster hardware: - For x86-64 hardware, remove this flag or specify x86_64
- For POWER hardware, specify ppc64le
- For IBM Z hardware, specify s390x
Project The project where the Cloud Pak for Data control plane is installed. The command returns a list of the changes that you must make to your cluster to ensure that control plane can run on your cluster.
- Make the
necessary changes to your cluster. You can choose one of the following methods to make the
changes:
- To automatically apply the changes to your cluster:
- Re-run the
cpd adm
command with the--apply
flag:./cpd-cli adm \ --repo repo.yaml \ --assembly lite \ --arch Cluster_architecture \ --namespace Project \ --apply
Replace the variables with the same values that you used the last time you ran the command.
- To manually apply the changes to your cluster:
- Follow the appropriate procedures from the Red Hat OpenShift documentation to complete the required tasks.
Preparing air-gapped clusters
From your installation node:
- Change to the directory where you placed the Cloud Pak for Data command-line interface.
- Log in to your Red Hat OpenShift cluster as an
administrator:
oc login OpenShift_URL:port
- Run
the following command to see a preview of the list of resources that must be created on the
cluster:
./cpd-cli adm \ --assembly lite \ --arch Cluster_architecture \ --namespace Project \ --load-from Image_directory_location \ --latest-dependency
Note: If the assembly was downloaded using thedelta-images
command, remove the--latest-dependency
flag from the command. If you don't remove the--latest-dependency
flag you will get an error indicating that the flag cannot be used.Tell the person who will install control plane whether you used the
--latest-dependency
flag. If you run this command with the--latest-dependency
flag, theinstall
command must also be run with the flag.Replace the following values:
Variable Replace with Cluster_architecture Specify the architecture of your cluster hardware: - For x86-64 hardware, remove this flag or specify x86_64
- For POWER hardware, specify ppc64le
- For IBM Z hardware, specify s390x
Project The project where the Cloud Pak for Data control plane is installed. Image_directory_location The location of the cpd-cli-workspace directory. The command returns a list of the changes that you must make to your cluster to ensure that control plane can run on your cluster.
- Make the
necessary changes to your cluster. You can choose one of the following methods to make the
changes:
- To automatically apply the changes to your cluster:
- Re-run the
cpd adm
command with the--apply
flag:./cpd-cli adm \ --assembly lite \ --arch Cluster_architecture \ --namespace Project \ --load-from Image_directory_location \ --latest-dependency \ --apply
Replace the variables with the same values that you used the last time you ran the command.
- To manually apply the changes to your cluster:
- Follow the appropriate procedures from the Red Hat OpenShift documentation to complete the required tasks.
Results
When you run the cpd-cli adm
command with the --apply
flag, the
following OpenShift service accounts are
created (including the necessary SCC bindings and the configuration of all of the necessary
resources):
Service account | GET permissions | PUT/POST/DELETE permissions | Elevated security context |
---|---|---|---|
cpd-viewer-sa |
Y | N | N |
cpd-editor-sa |
Y | Y | N |
cpd-admin-sa |
Y | Y | Y |
cpd-norbac-sa |
N | N | N |
What to do next
cpd-admin-role
to the
project administration
user:oc adm policy add-role-to-user cpd-admin-role Project_admin --role-namespace=Project -n Project
Variable | Replace with |
---|---|
Project_admin | The user name of the project administrator who will install the Cloud Pak for Data control plane. |
Project | The project where you will install the Cloud Pak for Data control plane. |