`backup-restore volume-backup create`

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

Create a backup of IBM® Cloud Pak for Data volumes.

Syntax

cpd-cli backup-restore volume-backup create <${PROJECT_CPD_INST_OPERANDS}-backup-name> \
[--cleanup-completed-resources=true|false] \
[--dry-run=true|false] \
[--image-prefix=<image-registry-prefix>] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--pvc-selectors=<key1=value1,key2=value2,...>] \
[--scale-wait-timeout=<h,m,s>] \
[--skip-backup-size-check=true|false] \
[--skip-quiesce=true|false] \
[--wait-timeout=<h,m,s>] \
[--verbose]

Arguments

Argument	Description
`<${PROJECT_CPD_INST_OPERANDS}-backup-name>`	The name of the volume to create a backup for.

Table 1: Command arguments

Options

Option	Description
`--cleanup-completed-resources`	When set to "true", deletes completed Kubernetes jobs and pods. Status Optional. Syntax `--cleanup-completed-resources=true\|false` Default value `false` Valid values false Does not delete completed Kubernetes jobs and pods. `true` Deletes completed Kubernetes jobs and pods.
`--dry-run`	Executes a dry-run without running the command. Status Optional. Syntax `--dry-run=true\|false` Default value `false` Valid values `false` A dry run is not executed before running the command. `true` A dry run is executed before running the command.
`--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=<image-registry-prefix>` Default value `icr.io/cpopen/cpd` Valid values icr.io/cpopen/cpd registry.redhat.io/ubi8 ${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 `${PROJECT_CPD_INST_OPERANDS}` Valid values A valid project (namespace) name.
`--pvc-selectors` `-l`	A list of comma separated PVC labels to use as a filter (for example, "-l key1=value1,key2=value2"). Status Optional. Syntax `--pvc-selectors=<key1=value1,key2=value2,...>` Default value No default. Valid values A list of comma separated PVC labels to use as a filter (for example, "-l key1=value1,key2=value2").
`--scale-wait-timeout`	The scale wait timeout duration ('h' for hours, 'm' for minutes, 's' for seconds). Status Optional. Syntax `--scale-wait-timeout=<h,m,s>` Default value `6m0s` Valid values Any valid duration string. Examples: 1m, 30m, 1h, 2h45m
`--skip-backup-size-check`	Skip the backup size check on the local file storage. Status Optional. Syntax `--skip-backup-size-check=true\|false` Default value `false` Valid values `false` Do not skip the backup size check on the local file storage. `true` Skip the backup size check on the local file storage.
`--skip-quiesce`	Skip quiesce and unquiesce steps. Status Optional. Syntax `--skip-quiesce=true\|false` Default value `false` Valid values `false` Does not skip quiesce and unquiesce steps. `true` Skips quiesce and unquiesce steps.
`--skip-root-squash-check`	Skips the check if root_squash is set on the local file storage. Status Optional. Syntax `--skip-root-squash-check=true\|false` Default value `false` Valid values `false` Does not skip the check is `root_squash` is set on the local file storage. `true` Skips the check if root_squash is set on the local file storage.
`--wait-timeout`	The wait timeout setting ('h' for hours, 'm' for minutes, 's' for seconds). Status Optional. Syntax `--wait-timeout=<h,m,s>` Default value `6m0s` Valid values Any valid duration string. Examples: 1m, 30m, 1h, 2h45m
`--verbose`	Logs include more detailed messages. Status Optional. Syntax `--verbose` Default value No default. Valid values Not applicable.

Table 2: Command options

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.

Volume backup for the ${PROJECT_CPD_INST_OPERANDS} namespace.

The backup name should include the namespace name as its prefix so to avoid potential collision between namespaces with the same backup name.

cpd-cli backup-restore volume-backup create <${PROJECT_CPD_INST_OPERANDS}-backup-name> \
--namespace=${PROJECT_CPD_INST_OPERANDS}