oadp
install
Install IBM Software Hub 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> \
[--access-key-id=<access-key-id>] \
[--agent-image-prefix=<agent-image-prefix>] \
[--agent-pod-cpu-limit=<cdpbr-agent-cpu-limit-value>] \
[--agent-pod-cpu-request=<cdpbr-agent-cpu-request-limit-value>] \
[--agent-pod-mem-limit=<cdpbr-agent-mem-limit-value>] \
[--agent-pod-mem-request=<cdpbr-agent-mem-request-limit-value>] \
[--agent-service-account=<cpdbr-agent-service-account>] \
[--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>] \
[--backup-validation-cacert=<base64-encoded-contents-of-the-CA-cert>] \
[--bucket-name=<object-storage-bucket-name>] \
[--cpd-scheduler-namespace=<cpd-scheduler-namespace>] \
[--cpdbr-hooks-image-prefix=<cpdbr-pod-image-prefix>] \
[--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>] \
[--cpdbr-velero-plugin-image=<cpdbr-velero-plugin-image>] \
[--cpfs-image-prefix=<cpfs-image-prefix>] \
[--cpfs-image-version=<cpfs-image-version>] \
[--cs-control-namespace=<cs-control-namespace>] \
[--grant-image-puller-role=true|false] \
[--help] \
[--image-prefix=<image-registry-prefix>] \
[--oadp-version=<oadp-version>] \
[--operators-namespace=<cpd-service-operators-namespace>] \
[--prefix=<prefix-name>] \
[--rbac-only] \
[--recipe-type=all|br|metro-dr] \
[--region=<object-store-region>] \
[--s3force-path-style=true|false] \
[--s3url=<s3-storage-url>] \
[--secret-access-key=<secret-access-key>] \
[--service-account=<service-account-name>] \
[--skip-recipes]=true|false] \
[--tenant-operator-namespace=<tenant-operator-namespace>] \
[--upgrade=true|false] \
[--uploader-type=kopia|restic] \
[--velero-cpu-limit=<velero-pod-cpu-limit>] \
[--velero-cpu-request=<velero-pod-cpu-request>] \
[--velero-mem-limit=<velero-pod-mem-limit>] \
[--velero-mem-request=<velero-pod-mem-request>] \
[--wait-timeout=<h,m,s>]
# Global options
[--add_dir_header=true|false] \
[--alsologtostderr=true|false] \
[--cpd-namespace=<cpd-namespace>] \
[--kubeconfig=<kubeconfig-paths> \
[--log-level=info|debug|warn|error|panic|trace] \
[--log-backtrace-at traceLocation=<integer>] \
[--log-dir=<log_directory>] \
[--log-file=<log_file_name>] \
[--log_file_max_size=<uint>] \
[--logtostderr=true|false] \
[--namespace=<namespace-name>] \
[--one-output=true|false] \
[--skip-headers=true|false] \
[--skip-log-headers=true|false] \
[--stderrthreshold severity=<integer>] \
[--v=<integer>] \
[--verbose \
[--vmodule moduleSpec=<pattern1, pattern2, and so on>]
Arguments
| Argument | Description |
|---|---|
<trace-location> |
The stack trace location |
<severity> |
The log severity level |
Options
| Option | Description |
|---|---|
--access-key-id |
The access key of the object
store.
|
--agent-image-prefix |
The image prefix for the
cpdbr-agent.
|
--agent-pod-cpu-limit |
The CPU limit for the cpdbr-agent
pod. A value of 0 indicates unbounded.
|
--agent-pod-cpu-request |
The CPU request setting for the
cpdbr-agent pod. A value of 0 indicates unbounded.
|
--agent-pod-mem-limit |
The memory limit for the
cpdbr-agent pod. A value of 0 indicates unbounded.
|
--agent-pod-mem-request |
The memory request setting for the
cpdbr-agent pod. A value of 0 indicates unbounded.
|
--agent-service-account |
The service account for the
cpdbr-agent.
|
--api-pod-cpu-limit |
The CPU limit for the cpdbr-api
pod. A value of 0 indicates unbounded.
|
--api-pod-cpu-request |
The CPU request setting for the
cpdbr-api pod. A value of 0 indicates unbounded.
|
--api-pod-mem-limit |
The memory limit for the cpdbr-api
pod. A value of 0 indicates unbounded.
|
--api-pod-mem-request |
The memory request setting for the
cpdbr-api pod. A value of 0 indicates unbounded.
|
--backup-validation-cacert |
5.2.2 and later This option is available starting in IBM® Software Hub Version 5.2.2. The CA certificate to use to download the backup from the IBM Fusion backup service cloud object storage. Use this option to enable secure communication between the client workstation and the cloud
object storage used by the IBM Fusion
backup service.
|
--bucket-name |
The object storage bucket name
where backups are stored.
|
--component |
Specify the cpd-cli oadp
component to install.
|
--cpd-scheduler-namespace |
The project where the IBM Software
Hub scheduler is installed.
|
--cpdbr-hooks-image-prefix |
Specify the image prefix for the
cpdbr service pod.
|
--cpdbr-hooks-pod-cpu-limit |
Specify the CPU limit for the
cpdbr service pod. A value of 0 indicates unbounded.
|
--cpdbr-hooks-pod-cpu-request |
Specify the CPU request value for
the cpdbr service pod. A value of 0 indicates unbounded.
|
--cpdbr-hooks-pod-mem-limit |
Specify the memory limit for the
cpdbr service pod. A value of 0 indicates unbounded.
|
--cpdbr-hooks-pod-mem-request |
Specify the memory request value
for the cpdbr service pod. A value of 0 indicates
unbounded.
|
--cpdbr-velero-plugin-image |
Specify a cpdbr-velero-plugin
custom plugin image.
|
--cpfs-image-prefix |
The IBM Cloud Pak foundational
services utility image prefix.
|
--cpfs-image-version |
The IBM Cloud Pak foundational
services utility image version.
|
--cs-control-namespace |
The IBM Software Hub cross tenant
control namespace.
|
--foundation-namespace |
Specify the IBM Software Hub
foundational services namespace.
|
--grant-image-puller-role |
Grants IBM Software Hub instance
namespaces permission to pull images from the OADP/Velero namespace. This option is used for
air-gapped installations.
|
|
|
Display command
help.
|
--image-prefix |
Specify the image registry
prefix.
|
--oadp-version |
The OADP operator
version.
|
--operators-namespace |
Specify the IBM Software Hub
Operators namespace.
|
--prefix |
The prefix under which all data is
to be stored within the bucket.
|
--rbac-only |
In conjunction with
component=cpdbr-tenant, specifies to install only clusterroles and their bindings without installing
the cpdbr-tenant service.
|
--recipe-type |
The type of backup and restore
recipe to apply.
|
--region |
The object store
region.
|
--s3force-path-style |
Whether to force path style URLs
for S3 objects.
|
--s3url |
The S3 storage
URL.
|
--secret-access-key |
Secret key of the object
store.
|
--service-account |
Specify the service
account.
|
--skip-recipes |
Skip installing IBM Fusion backup
and restore recipes.
|
--tenant-operator-namespace |
Restrict the scope of backup or
restore commands to tenant operand namespaces that include tenant specific Cloud Pak Foundation
Service Operators and IBM Software Hub Operators only.
|
--upgrade |
Upgrade the cpdbr-tenant service
component.
|
--uploader-type |
The type of uploader used to
transfer pod volume data.
|
--velero-cpu-limit |
Specify a CPU limit for the Velero
pod. A value of 0 indicates unbounded.
|
--velero-cpu-request |
Specify a CPU request value for
the Velero pod. A value of 0 indicates unbounded.
|
--velero-mem-limit |
Specify a memory limit for the
Velero pod. A value of 0 indicates unbounded.
|
--velero-mem-request |
Specify a memory request value for
the Velero pod. A value of 0 indicates unbounded.
|
--wait-timeout |
The wait timeout setting ('h' for
hours, 'm' for minutes, 's' for seconds).
|
Global options
You can also use the following global options with this command:
| Option | Description |
|---|---|
--add_dir_header |
Add the file directory to the
header of log messages.
|
--alsologtostderr |
Log to standard error as well as
files.
Note: This option has no effect when
--logtostderr=true. |
--cpd-namespace |
The IBM Software Hub namespace in
which the utility operates.
|
--kubeconfig |
Paths to a kubeconfig. Only
required if out-of-cluster.
|
--log-level |
The command log
level.
|
--log-backtrace-at traceLocation |
When logging hits line file:N,
emit a stack trace.
|
--log-dir |
If non-empty, write log files in
this directory.
|
--log-file |
If non-empty, use this log
file.
|
--log_file_max_size |
The maximum size, in MB, that a
log file can grow to. If you specify 0, the maximum file size is
unlimited.
|
--logtostderr |
Log to standard error instead of
files.
|
--namespace
|
The namespace where OADP is
installed.
|
--one-output |
Specifies whether to only write
logs to their native severity level.
|
--skip-headers |
Specifies whether to avoid header
prefixes in log messages.
|
--skip-log-headers |
Specifies whether to avoid header
prefixes when opening log files.
Note: This option has no effect when
--logtostderr=true. |
--stderrthreshold severity |
Logs at or above the specified
threshold. Go to stderr when writing to files and stderr.
|
--v
|
Number for the log level
verbosity.
|
--verbose |
Logs include more detailed
messages.
|
--vmodule moduleSpec |
Comma-separated list of pattern=N
settings for file-filtered logging.
|
Examples
It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For more information, see Setting up installation environment variables.
After installing IBM Fusion, NetApp Trident protect, or Portworx Enterprise, 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=registry.redhat.io/ubi9 \ --log-level=warn
- Install the
cpdbr-hooksservice for the Cloud Pak for Data control plane namespace. -
cpd-cli oadp install \ --cpd-namespace=zen \ --component=cpdbr-hooks \ --cpdbr-hooks-image-prefix=icr.io/cpopen/cpd \ --log-level=warn - Install the
cpdbr-ops-hooksservice 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 - Install the cpdbr-tenant service when using IBM Fusion for backup and restore
-
cpd-cli oadp install \ --component=cpdbr-tenant \ --cpdbr-hooks-image-prefix=icr.io/cpopen/cpd \ --tenant-operator-namespace=${PROJECT_CPD_INST_OPERATORS} \ --recipe-type=br \ --log-level=debug \ --verbose - Upgrade the cpdbr-tenant service when using IBM Fusion for backup and restore
-
cpd-cli oadp install \ --upgrade=true \ --component=cpdbr-tenant \ --cpdbr-hooks-image-prefix=icr.io/cpopen/cpd \ --tenant-operator-namespace=${PROJECT_CPD_INST_OPERATORS} \ --recipe-type=br \ --log-level=debug \ --verbose