oadp install

Important: IBM Cloud Pak® for Data Version 4.6 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.6 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Install Cloud Pak for Data Openshift APIs for Data Protection (OADP) backup and restore components.

Syntax

cpd-cli oadp install \
--component=<cpd-cli-oadp-component> \
--cpdbr-hooks-image-prefix=<cpdbr-pod-image-prefix> \
--foundation-namespace=<cpd-foundational-services-namespace> \
--operators-namespace=<cpd-service-operators-namespace> \
[--api-pod-cpu-limit=<cpdbr-api-cpu-limit-value>] \
[--api-pod-cpu-request=<cpdbr-api-cpu-request-limit-value>] \
[--api-pod-mem-limit=<cpdbr-api-mem-limit-value>] \
[--api-pod-mem-request=<cpdbr-api-mem-request-limit-value>] \
[--cpd-namespace=<cpd-control-plane-namespace>] \
[--cpdbr-hooks-pod-cpu-limit=<cpdbr-pod-cpu-limit>] \
[--cpdbr-hooks-pod-cpu-request=<cpdbr-pod-cpu-request>] \
[--cpdbr-hooks-pod-mem-limit=<cpdbr-pod-mem-limit>] \
[--cpdbr-hooks-pod-mem-request=<cpdbr-pod-mem-request>] \
[--grant-image-puller-role=true|false] \
[--image-prefix=<image-registry-prefix>] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--service-account=<service-account-name>] \
[--verbose]

Arguments

The install command has no arguments.

Options

Option Description
--api-pod-cpu-limit The CPU limit for the cpdbr-api pod. A value of 0 indicates unbounded.
Status
Optional.
Syntax
--api-pod-cpu-limit=<cpdbr-api-cpu-limit-value>
Default value
0
Valid values
Plain integer or fixed-point number that uses one the following quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.

Examples: 0, 100m, 256Mi, 1Gi
--api-pod-cpu-request The CPU request setting for the cpdbr-api pod. A value of 0 indicates unbounded.
Status
Optional.
Syntax
--api-pod-cpu-request=<cpdbr-api-cpu-request-limit-value>
Default value
0
Valid values
Plain integer or fixed-point number that uses one the following quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.

Examples: 0, 100m, 256Mi, 1Gi
--api-pod-mem-limit The memory limit for the cpdbr-api pod. A value of 0 indicates unbounded.
Status
Optional.
Syntax
--api-pod-mem-limit=<cpdbr-api-mem-limit-value>
Default value
0
Valid values
Plain integer or fixed-point number that uses one the following quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.

Examples: 0, 100m, 256Mi, 1Gi
--api-pod-mem-request The memory request setting for the cpdbr-api pod. A value of 0 indicates unbounded.
Status
Optional.
Syntax
--api-pod-mem-request=<cpdbr-api-mem-request-limit-value>
Default value
0
Valid values
Plain integer or fixed-point number that uses one the following quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.

Examples: 0, 100m, 256Mi, 1Gi
--component Specify the cpd-cli oadp component to install.
Status
Optional.
Syntax
--component=<cpd-cli-oadp-component>
Default value
No default.
Valid values
A valid cpd-cli oadp component name.
--cpd-namespace The Cloud Pak for Data control plane namespace in which the utility operates.
Status
Optional.
Syntax
--cpd-namespace=${PROJECT_CPD_INSTANCE}
Default value
${PROJECT_CPD_INSTANCE}
Valid values
A valid Cloud Pak for Data control plane namespace.
--cpdbr-hooks-image-prefix Specify the image prefix for the cpdbr service pod.
Status
Required.
Syntax
--cpdbr-hooks-image-prefix=<cpdbr-pod-image-prefix>
Default value
icr.io/cpopen/cpd
Valid values
  • icr.io/cpopen/cpd
  • ${PRIVATE_REGISTRY_LOCATION}
--cpdbr-hooks-pod-cpu-limit Specify the CPU limit for the cpdbr service pod. A value of 0 indicates unbounded.
Status
Required.
Syntax
--cpdbr-hooks-pod-cpu-limit=<cpdbr-pod-cpu-limit>
Default value
1
Valid values
Plain integer or fixed-point number that uses one the following quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.

Examples: 0, 100m, 256Mi, 1Gi
--cpdbr-hooks-pod-cpu-request Specify the CPU request value for the cpdbr service pod. A value of 0 indicates unbounded.
Status
Optional.
Syntax
--cpdbr-hooks-pod-cpu-request=<cpdbr-pod-cpu-request>
Default value
300m
Valid values
Plain integer or fixed-point number that uses one the following quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.

Examples: 0, 100m, 256Mi, 1Gi
--cpdbr-hooks-pod-mem-limit Specify the memory limit for the cpdbr service pod. A value of 0 indicates unbounded.
Status
Optional.
Syntax
--cpdbr-hooks-pod-mem-limit=<cpdbr-pod-mem-limit>
Default value
1Gi
Valid values
Plain integer or fixed-point number that uses one the following quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.

Examples: 0, 100m, 256Mi, 1Gi
--cpdbr-hooks-pod-mem-request Specify the memory request value for the cpdbr service pod. A value of 0 indicates unbounded.
Status
Optional.
Syntax
--cpdbr-hooks-pod-mem-request=<cpdbr-pod-mem-request>
Default value
256Mi
Valid values
Plain integer or fixed-point number that uses one the following quantity suffixes: E, P, T, G, M, k. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.

Examples: 0, 100m, 256Mi, 1Gi
--foundation-namespace Specify the Cloud Pak for Data foundational services namespace.
Status
Required.
Syntax
--foundation-namespace=<cpd-foundational-services-namespace>
Default value
ibm-common-services
Valid values
ibm-common-services
--grant-image-puller-role Grants Cloud Pak for Data instance namespaces permission to pull images from the OADP/Velero namespace. This option is used for air-gapped installations.
Status
Optional.
Syntax
--grant-image-puller-role=true|false
Default value
true
Valid values
true
Grants Cloud Pak for Data instance namespaces permission to pull images from the OADP/Velero namespace. This option is used for air-gapped installations.
false
Denies IBM Cloud Pak for Data instance namespaces permission.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--image-prefix Specify the image registry prefix.
Status
Optional.
Syntax
--image-prefix=icr.io/cpopen/cpd
Default value
icr.io/cpopen/cpd
Valid values
  • icr.io/cpopen/cpd
  • ${PRIVATE_REGISTRY_LOCATION}
--log-level The command log level.
Status
Optional.
Syntax
--log-level=info|debug|warn|error|panic
Default value
info
Valid values
debug
Debug messages are written to the log.
error
Error messages are written to the log.
info
Informative messages are written to the log.
panic
Panic messages are written to the log.
warn
Warning messages are written to the log.

--namespace

-n

 The namespace name in which the utility should operate.
Status
Optional.
Syntax
--namespace=<namespace-name>
Default value
oadp-operator
Valid values
A valid project (namespace) name.
--operators-namespace Specify the Cloud Pak for Data Operators namespace.
Status
Required.
Syntax
--operators-namespace=<cpd-service-operators-namespace>
Default value
ibm-common-services
Valid values
A valid Cloud Pak for Data Operators namespace.
--service-account Specify the service account.
Status
Optional.
Syntax
--service-account=<service-account-name>
Default value
cpdbr-api-sa
Valid values
A valid service account name.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use the recommended installation environment variables.

Use a script to create environment variables with the correct values for your environment. For more information, see Best practice: Setting up install variables.

After installing IBM Spectrum® Protect Plus install the following services to enable backup or restore for an entire Cloud Pak for Data deployment.

Install the REST service.
cpd-cli oadp install \
--image-prefix=icr.io/cpopen/cpd \
--log-level=warn
Install the cpdbr-hooks service for the Cloud Pak for Data control plane namespace.
cpd-cli oadp install \
--cpd-namespace=${PROJECT_CPD_INSTANCE} \
--component=cpdbr-hooks \
--cpdbr-hooks-image-prefix=icr.io/cpopen/cpd \
--log-level=warn
Install the cpdbr-ops-hooks service for the Cloud Pak for Data operators namespace.
cpd-cli oadp install \
--component=cpdbr-ops-hooks \
--cpdbr-hooks-image-prefix=icr.io/cpopen/cpd \
--foundation-namespace=ibm-common-services \
--operators-namespace=ibm-common-services \
--log-level=warn