Installing the Cloud Pak for Data control plane from cpd-cli

A project administrator can install the control plane service on IBM® Cloud Pak for Data.

Before you begin

Required role: To complete this task, you must be an administrator of the project (namespace) where you will deploy control plane.

Before you install control plane, ensure that:

A cluster administrator has completed the steps in Setting up the cluster for the control plane.
The cluster meets the minimum requirements for installing control plane. For details, see System requirements.

Tip: For a list of all available options, enter the following command:

./cpd-cli install --help

If you are running the installation on an air-gapped cluster, ensure that a Red Hat® OpenShift® administrator has completed the steps in Preparing for air-gapped installations to download the required files for the Cloud Pak for Data control plane.

Procedure

Complete the appropriate steps to install control plane on your environment:
- Installing on clusters connected to the internet
- Installing on air-gapped clusters
Verifying that the installation completed successfully
Checking for available patches
Complete the tasks listed in What to do next

Installing on 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 a project administrator:
```
oc login OpenShift_URL:port
```

Run the following command to see a preview of what will be installed when you install the service.

Important: If you are using the internal Red Hat OpenShift registry and you are using the default self-signed certificate, specify the --insecure-skip-tls-verify flag to prevent x509 errors.

./cpd-cli install \
--repo ./repo.yaml \
--assembly lite \
--arch Cluster_architecture \
--namespace Project \
--storageclass Storage_class_name \
--transfer-image-to Registry_location \
--cluster-pull-prefix Registry_from_cluster \
--ask-push-registry-credentials \
--latest-dependency \
--dry-run

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 \

The --latest-dependency flag gets the latest version of the dependent assemblies. If you remove the --latest-dependency flag, the installer will get the minimum version of the dependent assemblies.

Ensure that you use the same flags that your cluster administrator used when they completed Setting up the cluster for the control plane. If your cluster administrator used the --version flag, ensure that you specify the same version of the assembly.

If you are installing with Portworx storage, add the following line to your installation command after the --storageclass flag:

--override-config portworx \

If you are installing with OpenShift Container Storage, add the following line to your installation command after the --storageclass flag:

--override-config ocs \

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`	Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
`Storage_class_name`	Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
`Registry_location`	Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
`Registry_from_cluster`	Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.

Rerun the previous command without the --dry-run flag to install the service.

Installing on 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 a project administrator:
```
oc login OpenShift_URL:port
```

Run the following command to see a preview of what will be installed when you install the service.

Important: If you are using the internal Red Hat OpenShift registry:

Do not specify the --ask-pull-registry-credentials parameter.
If you are using the default self-signed certificate, specify the --insecure-skip-tls-verify flag to prevent x509 errors.

./cpd-cli install \
--assembly lite \
--arch Cluster_architecture \
--namespace Project \
--storageclass Storage_class_name \
--cluster-pull-prefix Registry_from_cluster \
--ask-pull-registry-credentials \
--load-from Image_directory_location \
--latest-dependency \
--dry-run

Note: If the assembly was downloaded using the delta-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.

Ask your cluster administrator whether they specified the --latest-dependency flag when they completed Setting up the cluster for the control plane. If they ran the adm command with the --latest-dependency flag, you must also run the install command with the flag.

If you are installing with Portworx storage, add the following line to your installation command after the --storageclass flag:

--override-config portworx \

If you are installing with OpenShift Container Storage, add the following line to your installation command after the --storageclass flag:

--override-config ocs \

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`	Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
`Storage_class_name`	Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
`Registry_from_cluster`	Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
`Image_directory_location`	The location of the cpd-cli-workspace directory. Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.

Rerun the previous command without the --dry-run flag to install the service.

Verifying that the installation completed successfully

From your installation node:

Run the following command:
```
./cpd-cli status \
--assembly lite \
--namespace Project
```
Replace Project with the value you used in when you installed control plane.
- If the installation completed successfully, the status of the assembly and the modules in the assembly is Ready.
- If the installation failed, contact IBM Support for assistance.

Checking for available patches

Determine whether there are any patches available for the version of control plane that you installed:

Clusters connected to the internet

Run the following command to check for patches:

./cpd-cli status \
--repo ./repo.yaml \
--namespace Project \ 
--assembly lite \
--patches \
--available-updates

Air-gapped clusters

See the list of Available patches for the control plane.

If you need to apply patches to the service, follow the guidance in Applying patches.

What to do next

By default, the route to the Cloud Pak for Data web client has the following format:

https://namespace-cpd-namespace.apps.cluster-subdomain/zen/

After you install the Cloud Pak for Data control plane, complete the Post-installation tasks.

After you finish all of the post-installation tasks, you can install services on Cloud Pak for Data.