backup-restore unquiesce

Unquiesce Kubernetes workloads such as deployments, StatefulSets, cronjobs, jobs, and pods.

Extended description

The unquiesce command unquiesces deployments and StatefulSets for the specified namespace. The command calls unquiesce hooks or scales up resources.

Syntax

cpd-cli backup-restore unquiesce \
[--dry-run=true|false] \
[--ignore-hooks] \
[--image-prefix=<image-registry-prefix>] \
[--log-level=info|debug|warn|error|panic] \
[--namespace=<namespace-name>] \
[--values=<yaml-file-name1,yaml-file-name2,...>] \
[--verbose] \
[--wait=true|false] \
[--wait-timeout=<h,m,s>]

Arguments

The unquiesce command has no arguments.

Options

Option Description
--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.
--ignore-hooks Quiesce through scale down.
Status
Optional.
Syntax
--ignore-hooks
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.

--values

-r

 Specify values in one or more YAML files.
Status
Optional.
Syntax
--values=<yaml-file-name1,yaml-file-name2,...>
Default value
No default.
Valid values
One or more YAML file names.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.
--wait When set to "true", wait for the operation to complete.
Status
Optional.
Syntax
--wait=true|false
Default value
false
Valid values
false
Do not wait for the operation to complete.
true
Wait for the operation to complete.
--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

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.

Unquiesce deployments and StatefulSets for the ${PROJECT_CPD_INSTANCE} namespace (calls unquiesce hooks or scales up resources).
cpd-cli backup-restore unquiesce \
--namespace=${PROJECT_CPD_INSTANCE}