cpd-cli manage

Important: IBM® Cloud Pak for Data Version 4.5 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.5 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

manage is a plug-in to the IBM Cloud Pak for Data command-line interface (cpd-cli). Use the manage commands to install and manage the Cloud Pak for Data software on your Red Hat® OpenShift® Container Platform cluster.

Commands

Command Description
add-cred-to-global-pull-secret Update the global image pull secret to enable the cluster to pull images from your private container registry.
add-icr-cred-to-global-pull-secret Update the global image pull secret to enable the cluster to pull images from the IBM Entitled Registry.
apply-cr Install or upgrade the specified components. The command creates or updates the custom resource objects with the appropriate settings.
apply-crio Apply the required Container Runtime Interface (CRI-O) settings to your cluster nodes.
apply-db2-kubelet Apply the required kubelet configuration to all cluster nodes to allow Db2U to make unsafe sysctl changes for kernel parameters.
apply-entitlement Give the License Service (provided by IBM Cloud Pak foundational services) information about the type of IBM Cloud Pak for Data license that you purchased.
apply-icsp Required for private container registries. If you mirrored images to a private container registry, create the required image content source policy to enable the cluster to pull the images from your private container registry.
apply-olm Create or update the catalog sources, cluster service versions, and operator subscriptions for the specified components.
apply-scc Create a custom SCC for the specified component and bind it to a service account in the Cloud Pak for Data control plane namespace.
collect-state Capture data from any projects (namespaces) that you are authorized to access.
delete-cr Uninstall the specified components from the specified project (namespace). This command deletes the custom resources that are associated with the components.
delete-images Remove images that are no longer needed from the private container registry or from the intermediary container registry.
delete-olm-artifacts Remove the OLM artifacts for the specified components. The artifacts include catalog sources, cluster service versions, and operator subscriptions.
get-cpd-instance-details Get the URL for the Cloud Pak for Data web client and the credentials of the default administrator (admin).
get-cr-status Get the status of the components that are installed in the specified project (namespace).
get-license Get the URL where you can view the specified Cloud Pak for Data license.
get-olm-artifacts Get the list of catalog sources and operator subscriptions that are on the cluster.
list-components Get the list of components that are supported by the cpd-cli manage commands.
list-dependents Get the list of components that are dependent on the specified component. For example, see the list of components that are dependent on the common core dservices.
list-images Get the list of images that are associated with the specified components.
list-prereqs Get the list of components that are a prerequisite for the specified component. For example, see the list of components that are a prerequisite for Watson Knowledge Catalog.
login-entitled-registry Log in to the IBM Entitled Registry before mirroring images to a private container registry.
login-private-registry Log in to your private container registry before mirroring images to it.
login-to-ocp Log in to OpenShift Container Platform from the current cpd-cli session. This command uses the same arguments as the oc login command.
mirror-images Mirror the images for the specified components to your private container registry.
setup-iam-integration Specify whether you want to use the IBM Cloud Pak foundational services IAM Service to connect to your identity provider (IdP).
setup-instance-ns Enable the project (namespace) where the IBM Cloud Pak for Data operators are installed to watch the project where you plan to install the control plane and services.
setup-route Replace the default self-signed TLS certificate with a custom TLS certificate or customize the route to the platform.
setup-tethered-ns Tether a project (namespace) to the project where the IBM Cloud Pak for Data control plane is installed.
update-cr Update the contents of the custom resources for the specified component.