backup-restore snapshot-restore create

Create a volume snapshot restore.

Syntax

cpd-cli backup-restore snapshot-restore create <volume-snapshot-restore-name> \
[--cleanup-completed-resources=true|false] \
[--dry-run=true|false] \
[--from-snapshot=<volume-snapshot-backup-file-name>] \
[--image-prefix=<image-registry-prefix>] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--scale-wait-timeout=<h,m,s>] \
[--skip-quiesce=true|false] \
[--wait-timeout=<h,m,s>] \
[--verbose]

Arguments

Table 1: Command arguments
Argument Description
<volume-snapshot-restore-name> The name of the volume to create a volume snapshot restore for.

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.

--from-snapshot

-s

 The snapshot or backup name from which to restore.
Status
Optional.
Syntax
--from-snapshot=<volume-snapshot-backup-file-name>
Default value
No default.
Valid values
Any valid snapshot or backup name.

--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
${PROJECT_CPD_INSTANCE}
Valid values
A valid project (namespace) name.
--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-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.
--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.

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.

Pass the --dry-run option to validate the restore before running it.
The command reports jobs or pods that are still attached to the PVCS to be restored.
cpd-cli backup-restore snapshot-restore create <volume-snapshot-restore-name> \
--namespace=${PROJECT_CPD_INSTANCE} \
--from-snapshot=<volume-snapshot-backup-file-name> \
--dry-run=true
Create a volume snapshot restore after the dry run.
cpd-cli backup-restore snapshot-restore create <volume-snapshot-restore-name> \
--namespace=${PROJECT_CPD_INSTANCE} \
--from-snapshot=<volume-snapshot-backup-file-name>