Installing IBM Cloud Pak for Data
After you install IBM Cloud Pak foundational services for the instance, you can install the IBM Cloud Pak for Data control plane and services.
- Installation phase
- Setting up a client workstation
- Setting up a cluster
- Collecting required information
- Preparing to run installs from a private container registry
- Preparing the cluster for Cloud Pak for Data
- Preparing to install an instance of Cloud Pak for Data
- Installing an instance of Cloud Pak for Data
- Who needs to complete this task?
-
Instance administrator An instance administrator can complete this task.
- When do you need to complete this task?
-
Repeat as needed If you plan to install multiple instances of Cloud Pak for Data, you must repeat this task for each instance that you plan to install.
Before you begin
Ensure that you source the environment variables before you run the commands in this task.
About this task
- Install the Cloud Pak for Data control plane before you install the services in the instance
- Install the Cloud Pak for Data control plane and the services at the same time.
If you plan to integrate Cloud Pak for Data with the IBM Cloud Pak foundational services Identity Management Service, decide whether the name of the default administrator account is important to you.
cpadmin
.- If you install the Cloud Pak for Data control plane and
services at the same time, you must update the name of the default administrator user account to
admin
to enable the services to access and manage the objects that they created during the installation. - If you install the Cloud Pak for Data control plane and
integrate with the Identity Management Service before you
install the services, you can use the default
cpadmin
account.
Procedure
-
Run the
cpd-cli manage login-to-ocp
command to log in to the cluster as a user with sufficient permissions to complete this task. For example:cpd-cli manage login-to-ocp \ --username=${OCP_USERNAME} \ --password=${OCP_PASSWORD} \ --server=${OCP_URL}
Tip: Thelogin-to-ocp
command takes the same input as theoc login
command. Runoc login --help
for details. - Review the license terms for Cloud Pak for Data. The Cloud Pak for Data licenses are available online. Run the appropriate command to get the URL for your license:
Enterprise Edition
cpd-cli manage get-license \ --release=${VERSION} \ --license-type=EE
Standard Edition
cpd-cli manage get-license \ --release=${VERSION} \ --license-type=SE
- Install the operators in the operators project for the instance. Tip: Before you run this command against your cluster, you can preview the
oc
commands that this command will issue on your behalf by running the command with the--preview=true
option.The
oc
commands are saved to thepreview.sh
file in thework
directory.
IBM Cloud Pak for Data platform operator and service operators
cpd-cli manage apply-olm \ --release=${VERSION} \ --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \ --components=${COMPONENTS}
IBM Cloud Pak for Data platform operator only
cpd-cli manage apply-olm \ --release=${VERSION} \ --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \ --components=cpd_platform
Wait for thecpd-cli
to return the following message before proceeding to the next step:[SUCCESS]... The apply-olm command ran successfully.
If the
apply-olm
command fails, see Troubleshooting the apply-olm command during installation or upgrade. - Install the operands in the operands project for the instance: Tip: Before you run this command against your cluster, you can preview the
oc
commands that this command will issue on your behalf by running the command with the--preview=true
option.The
oc
commands are saved to thepreview.sh
file in thework
directory.The command that you run depends on the storage on your cluster:
Red Hat OpenShift Data Foundation storage
Create the custom resources for the specified components.
- Cloud Pak for Data control plane and services (no installation options)
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
IBM Storage Fusion Data Foundation storage
Create the custom resources for the specified components.
- Cloud Pak for Data control plane and services (no installation options)
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
IBM Storage Fusion Global Data Platform storage
Create the custom resources for the specified components.
When you use IBM Storage Fusion storage, both
${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typically
.ibm-spectrum-scale-sc
- Cloud Pak for Data control plane and services (no installation options)
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
IBM Storage Scale Container Native storage
Create the custom resources for the specified components.
When you use IBM Storage Scale Container Native storage, both
${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typically
.ibm-spectrum-scale-sc
- Cloud Pak for Data control plane and services (no installation options)
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
Portworx storage
Create the custom resources for the specified components.
- Cloud Pak for Data control plane and services (no installation options)
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --storage_vendor=portworx \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --storage_vendor=portworx \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --storage_vendor=portworx \ --license_acceptance=true
NFS storage
When you use IBM Storage Scale Container Native storage, both
${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typically
.managed-nfs-storage
Create the custom resources for the specified components.
- Cloud Pak for Data control plane and services
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
AWS EFS storage only
Create the custom resources for the specified components.
When you use only EFS storage, both
${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typically
.efs-nfs-client
- Cloud Pak for Data control plane and services
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
AWS EFS and EBS storage
Create the custom resources for the specified components.
- Cloud Pak for Data control plane and services
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
NetApp Trident
Create the custom resources for the specified components.
When you use NetApp Trident storage, both
${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typically
.ontap-nas
- Cloud Pak for Data control plane and services
-
By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Cloud Pak for Data control plane and services (with installation options)
-
Run the following command if you created an
install-options.yml
file.By default, the
apply-cr
installs up to 4 components at the same time. You can adjust this setting by specifying the--parallel_num
option.cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=${COMPONENTS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true \ --param-file=/tmp/work/install-options.yml
- Cloud Pak for Data control plane only
-
cpd-cli manage apply-cr \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --components=cpd_platform \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
Wait for thecpd-cli
to return the following message before proceeding to the next step:[SUCCESS]... The apply-cr command ran successfully.
- Confirm that the status of the operands is
Completed
:cpd-cli manage get-cr-status \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS}
- Get the URL and default credentials of the web client:
cpd-cli manage get-cpd-instance-details \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --get_admin_initial_credentials=true
What to do next
If you want to tether projects to this instance of Cloud Pak for Data, complete Tethering projects to the IBM Cloud Pak for Data control plane.
Ensure that you complete the Post-installation setup (Day 1 operations).
If you did not install any services when you installed the control plane, ensure that you install the services that you want to use. See the instructions for installing each service individually in Services.