`manage`

Install and manage the IBM® Software Hub software on your Red Hat® OpenShift® Container Platform cluster.

Commands

Component IDs
When you run the cpd-cli manage commands, you must specify the components that you want to manage.
manage add-cred-to-global-pull-secret
Update the global image pull secret to enable the cluster to pull images from your private container registry.
manage 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.
manage apply-cluster-component-hpa-config
Update the horizontal pod autoscaling (HPA) configuration for the specified shared cluster component.
manage apply-cluster-component-scale-config
Change the scaling configuration of a shared cluster component.
manage apply-cluster-components
Install or upgrade the cluster-wide components.
manage apply-cr
Install or upgrade the specified components. The command creates or updates the custom resource objects with the appropriate settings.
manage apply-db2-kubelet
Apply the required kubelet configuration to all cluster nodes to allow Db2U to make unsafe sysctl changes for kernel parameters.
manage apply-entitlement
Give the License Service (provided by IBM Cloud Pak® foundational services) information about the type of license that you purchased.
manage apply-hpa-config
Update the horizontal pod autoscaling (HPA) configuration for the specified components.
manage 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.
manage apply-olm
Create or update the catalog sources, cluster service versions, and operator subscriptions for the specified components.
manage apply-privileged-monitoring-service
Deploy the privileged monitoring service for an instance of IBM Software Hub.
manage apply-rsi-patches
Apply all active resource specification injection (RS) patches in the specified project.
manage apply-scale-config
Change the scaling configuration for one or more components associated with an instance of IBM Software Hub.
manage apply-scc
Create a custom SCC for the specified component and bind it to a service account in the IBM Software Hub control plane namespace.
manage apply-scheduler
Install or upgrade the scheduling service.
manage apply-service-monitor
Deploy the service monitors for an instance of IBM Software Hub.
manage authorize-instance-topology
Apply the required roles and role bindings to the projects that are associated with an instance of IBM Software Hub.
manage case-download
Download CASE packages to a client workstation.
manage clean-workspace
Clean the olm-utils-workspace/work directory by removing all of the files and folders, except for the log files, in the directory.
manage collect-state
Capture data from any projects (namespaces) that you are authorized to access.
manage copy-image
Copy an image from one location to another.
manage create-physical-location
Install the IBM Software Hub agents on a remote cluster so that users can run workloads on the remote cluster.
manage create-proxy-config
Create the resources that are needed to provide your proxy configuration to IBM Software Hub.
manage create-rsi-patch
Create or update a resource specification injection (RSI) patch.
manage delete-cluster-scoped-resources
Generate the list of cluster-scoped resources for the specified components. You can use this information to safely delete cluster-scoped resources that you no longer need.
manage delete-cr
Uninstall the specified components from the specified project (namespace). This command deletes the custom resources that are associated with the components.
manage delete-images
Remove images that are no longer needed from the private container registry or from the intermediary container registry.
manage delete-olm-artifacts
Remove the OLM artifacts for the specified components. The artifacts include catalog sources, cluster service versions, and operator subscriptions.
manage delete-physical-location
Remove the IBM Software Hub agents from the physical location.
manage delete-platform-ca-certs
Remove the cpd-platform-ca-certs secret from pods. Then delete the cpd-platform-ca-certs secret and any other artifacts generated by the gen-platform-ca-certs command.
manage delete-privileged-monitoring-service
Remove the privileged monitoring service for an instance of IBM Software Hub.
manage delete-proxy
Delete the resources that contain your HTTP proxy configuration.
manage delete-rsi-patch
Delete RSI patches that are defined in the specified project.
manage delete-service-monitor
Remove the service monitors from an instance of IBM Software Hub.
manage deploy-knative-eventing
Install or upgrade the Red Hat OpenShift Serverless Knative Eventing software on the cluster.
manage disable-proxy
Disable the HTTP proxy configuration for an instance of IBM Software Hub.
manage edit-physical-location
Edit the attributes of a registered physical location.
manage enable-cpd-config-ac
Enable the IBM Software Hub configuration admission controller in the specified project and in any projects that are tethered to the project.
manage enable-proxy
Apply your HTTP proxy configuration to an instance of IBM Software Hub.
manage gen-platform-ca-certs
Update the cpd-platform-ca-certs secret with the contents of the zen-ca-cert-secret secret and inject the contents of the cpd-platform-ca-certs secret into IBM Software Hub pods.
manage get-cluster-component-scale-config
Get the current scaling configuration for the specified shared cluster component.
manage get-cpd-instance-details
Get the URL for the IBM Software Hub web client and the credentials of the default administrator (admin).
manage get-cr-status
Get the status of the components that are installed in the specified project (namespace).
manage get-k8s-details
Get detailed information about the Kubernetes (K8s) objects that are associated with IBM Software Hub. Each object is described in a module.
manage get-license
Get the URL where you can view the specified license.
manage get-olm-artifacts
Get the list of catalog sources and operator subscriptions that are on the cluster.
manage get-proxy-config
Get the details of the HTTP proxy configuration and the RSI patches that define the configuration.
manage get-rsi-patch-info
Get information about RSI patches that are defined in the specified project.
manage get-rsi-patch-logs
Extract and display the logs from the RSI webhook pod.
manage get-physical-locations
Get information about one or more physical locations that are associated with an instance of IBM Software Hub.
manage get-scale-config
Get the current scaling configuration for the specified components.
manage install-components
Install or upgrade the specified components. The command creates or updates the operators and custom resource objects with the appropriate settings.
manage install-cpd-config-ac
Install the IBM Software Hub configuration admission controller by creating an instance-scoped webhook.
manage list-components
Get the list of components that are supported by the cpd-cli manage commands.
manage 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 services.
manage list-deployed-components
Get the list of components that are deployed in a project.
manage list-images
Get the list of images that are associated with the specified components.
manage list-platform-ca-certs-pods
List the pods where the secret has been injected and the pods where the secret injection failed.
manage 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 IBM Knowledge Catalog.
manage load-image
Load a saved image to the container runtime on the client workstation.
manage login-entitled-registry
Log in to the IBM Entitled Registry before mirroring images to a private container registry.
manage login-private-registry
Log in to your private container registry before mirroring images to it.
manage 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.
manage mirror-images
Mirror the images for the specified components to your private container registry.
manage pull-image
Pull an image from a registry and load it in the container runtime on your workstation.
manage register-physical-location
Give the primary instance of IBM Software Hub (also called the hub) information about the remote physical location and establish mutual trust between the primary instance and the remote physical location.
manage remove-entitlement
Tell the License Service to stop tracking usage information for the specified license.
manage remove-knative-eventing
Remove the Red Hat OpenShift Serverless Knative Eventing software from the cluster.
manage restart
Restart the specified components and any dependencies. The component will be restarted after the dependencies are restarted.
manage restart-container
Ensure that the CLI is running the latest version of the olm-utils-play image.
manage save-image
Save an image as a compressed TAR file in the work directory.
manage setup-iam-integration
Use the IBM Cloud Pak foundational services Identity Management Service to connect to your identity provider (IdP).
manage setup-instance
Prepare the projects where you plan to install IBM Software Hub.
manage setup-instance-topology
Prepare the projects where you plan to run IBM Software Hub.
manage setup-mcg
Create the secrets that services with a dependency on Multicloud Object Gateway will use to connect to Multicloud Object Gateway.
manage setup-route
Replace the default self-signed TLS certificate with a custom TLS certificate or customize the route to the platform.
manage setup-tethered-ns
Tether a project (namespace) to the project where the IBM Software Hub control plane is installed.
manage show-minimum-rbac
Show the minimum role-based access control (RBAC) for the components that you plan to install.
manage shutdown
Shut down the specified components and any dependencies. The component will be shut down after the dependencies are shut down.
manage test-image
Confirm that the image exists in the specified location.
manage uninstall-components
Uninstall the specified components.
manage uninstall-cpd-config-ac
Uninstall the IBM Software Hub configuration admission controller.
manage update-cr
Update the contents of the custom resources for the specified component.

Parent topic: cpd-cli command reference