Install or upgrade the specified components. The command creates or
updates the custom resource objects with the appropriate
settings.
Extended description
To install IBM Cloud Pak® for Data, you must install the
components that comprise the platform. When you install a component, the apply-cr command creates a custom resource object with the
appropriate settings.
Run the apply-cr to install or upgrade the appropriate
components for your business needs. You can install the components in a batch by specifying a
comma-separated list of components, or you can install components individually.
Syntax
cpd-cli manage apply-cr \
--components=<comma-separated-list-of-component-names> \
--release=<version> \
--license_acceptance=true|false \
--cpd_instance_ns=<project-name> \
[--upgrade=true|false] \
[--tethered_instance_ns=${PROJECT_CPD_INSTANCE}] \
[--cpd_operator_ns=<project-name>] \
[--param-file=<file-name>] \
[--storage_vendor=ocs|portworx] \
[--storage_class=<storage-class-name>] \
[--file_storage_class=<RWX-storage-class>] \
[--block_storage_class=<RWO-storage-class>] \
[--preview=true|false] \
[-vv][-vv][-vvv]
Arguments
The apply-cr command has no arguments.
Options
| Option |
Description |
--block_storage_class |
If
the service requires block storage, specify a storage class that supports ReadWriteOnce (RWO)
access.
- Status
- For service-specific guidance, see the installation documentation for the specified components.
Required if the component requires RWO storage and one of the following statements are true:
- You are using custom storage class names on OpenShift®
Data Foundation
- You are using custom storage class names on Portworx
- You are using a different type of storage
- Syntax
--block_storage_class=<RWO-storage-class>- Default value
- No default.
- Valid values
- The name of a storage class that supports RWO access.
|
--components |
A comma-separated list of the components that you want to install or
upgrade.
- Status
- Required.
- Syntax
--components=<comma-separated-list-of-component-names>- Default value
- There is no default value. The list depends on which components you want to install or
upgrade.
- Valid values
- For the list of components, see Component IDs.
You can specify
individual components or a comma-separated list of components.
|
--cpd_instance_ns |
The
project (namespace) where you want to install the control plane and
services.
- Status
- Required.
- Syntax
--cpd_instance_ns=<project-name>- Default value
- No default. User-defined.
- Valid values
- The name of an existing project on the Red Hat®
OpenShift Container Platform cluster.
|
--cpd_operator_ns |
Specialized installations only. The project (namespace) where the IBM
Cloud Pak for Data operators exist.
- Status
- Required if both of the following statements are true:
- You are using the specialized installation, where the Cloud Pak for Data operators are in a separate namespace from the
IBM
Cloud Pak foundational services operators.
- You did not run the
setup-instance-ns
command.
- Syntax
--cpd_operator_ns=<project-name>- Default value
- No default. User-defined.
- Valid values
- The name of the project where the Cloud Pak for Data
operators are installed.
|
--file_storage_class |
If
the service requires file storage, specify a storage class that supports ReadWriteMany (RWX)
access.
- Status
- Refer to the installation documentation for the specified components for guidance.
Required
if the component requires RWX storage and one of the following statements are true:
- You are using custom storage class names on OpenShift
Data Foundation
- You are using custom storage class names on Portworx
- You are using a different type of storage
- Syntax
--file_storage_class=<RWX-storage-class>- Default value
- No default.
- Valid values
- The name of a storage class that supports RWX access.
|
--license_acceptance |
Specify whether you accept the
license terms. You must set this option to true to install the
software.
- Status
- Required.
- Syntax
--license_acceptance=true- Default value
- false
If you omit this option, the default value is used.
- Valid values
-
- false
- This value indicates that you do not accept the license terms.
If you specify --license_acceptance=false, the specified components will not be
installed.
- true
- This value indicates that you accept the license terms.
You must specify --license_acceptance=true to install the specified
components.
|
--param-file |
The fully qualified path of a file that includes additional
parameters. The file must be in the
cpd-cli-workspace/olm-utils-workspace/work directory.
- Status
- Optional.
Refer to the installation documentation for the specified components for
guidance.
- Syntax
--param-file=<file-name>- Default value
- No default. User-defined.
- Valid values
- The fully qualified path of a file that includes additional
parameters.
|
--preview |
Preview the commands that run when you issue this CLI
command. The command issues a series of
oc commands. You can optionally see the list of oc commands that
are associated with the command.
The oc commands are
saved to the preview.sh file in the cpd-cli-workspace/olm-utils-workspace/work directory.
- Status
- Optional.
- Syntax
--preview=true|false- Default value
- false
If you omit this option, the default value is
used.
- Valid values
-
- false
- Run the commands to apply the changes to your cluster.
- true
- Preview the commands without running them.
You can optionally copy the oc
commands from the output and run them yourself. However, this method is not recommended. When you
run the commands manually, you do not have access to the additional helper scripts that are included
in the underlying Ansible®
playbook.
|
--release |
The release that you want to
install or upgrade to.
- Status
- Required.
- Syntax
--release=<version>- Default value
- No default. You must specify the
release.
- Valid values
-
- 4.6.0
- 4.6.1
- 4.6.2
- 4.6.3
- 4.6.4
- 4.6.5
- 4.6.6
|
--storage_class |
The name of a RWX or RWO storage class to use when provisioning
storage during installation.
- Status
- Deprecated.
Use the following options instead:
- Syntax
--storage_class=<storage-class-name>- Default value
- No
default.
- Valid values
- The name of a RWX or RWO storage class.
|
--storage_vendor |
The type of storage that you are using. This setting uses the
recommended storage class when provisioning storage during
installation. Restriction: This option applies only if you
are using the recommended storage class names with OpenShift
Data Foundation or Portworx.
- Status
- Refer to the installation documentation for the specified components for guidance.
Recommended if you are using the recommended storage class names with OpenShift
Data Foundation or Portworx.
- Syntax
--storage_vendor=ocs|portworx- Default value
- No
default.
- Valid values
-
- ocs
- Specify
ocs if you use the recommended storage
class names for OpenShift
Data Foundation.Refer to the
installation documentation for the specified components for guidance.
- portworx
- Specify
portworx if you use the recommended storage
class names for Portworx.Refer to the
installation documentation for the specified components for guidance.
|
--tethered_instance_ns |
A
project (namespace) that is tethered to the project where IBM Cloud Pak for Data is
installed.Important: You must run the setup-tethered-ns command before you run the apply-cr
command with this option.
- Status
- Optional. Specify this option if you want to install the specified components in the tethered
project.
Restriction: Not all services can be installed in tethered projects. Review the
service documentation to determine whether the service can be installed in a tethered
project.
- Syntax
--tethered_instance_ns=${PROJECT_CPD_INSTANCE}- Default value
- No default. User-defined.
- Valid values
- The name of the project that is tethered to the project where Cloud Pak for Data is installed.
|
--upgrade |
Specify whether you are upgrading
an existing installation. You must set this option to true to upgrade the
software.
- Status
- Required when you run an upgrade.
- Syntax
--upgrade=true|false- Default value
- false
If you omit this option, the default value is
used.
- Valid values
-
- false
- Do not upgrade the specified components.
- true
- Upgrade the specified components.
|
|
-v
-vv
-vvv
|
Display verbose output. Options are listed from least verbose to the most verbose.
- Status
- Optional.
- Syntax
-
- Verbose output
-v- Very verbose output
-vv- Most verbose output
-vvv
- Default value
- Not
applicable.
- Valid values
- Not
applicable.
|
Examples
Note: The following example uses the recommended installation environment variables.
Use a script to create environment variables with the correct values
for your environment. For details, see Best practice: Setting up install variables.
- Install the specified components on a cluster that uses the recommended storage class names for
OpenShift
Data Foundation
-
cpd-cli manage apply-cr \
--components=${COMPONENTS} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--storage_vendor=ocs \
--license_acceptance=true
- Preview the
oc commands to install the specified components on a cluster that
uses Portworx storage with custom storage class
names
-
cpd-cli manage apply-cr \
--components=${COMPONENTS} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--file_storage_class=${FILE_STORAGE} \
--block_storage_class=${FILE_BLOCK} \
--license_acceptance=true \
--preview=true