oadp backup precheck

Run the backup precheck command before any subsequent backup steps.

Extended Description

The backup precheck command checks that the primary instance of every EDB Postgres cluster is in sync with its replicas.

If the check fails, the backup precheck command reports the error and exits with a non-zero exit code. Otherwise, it returns successfully with a zero exit code.

The backup precheck command also logs the following information:
  1. The OpenShift® and Kubernetes version numbers.
  2. The Cloud Pak for Data version number.

This command is also available in oadp REST mode.

Syntax

cpd-cli oadp backup precheck \
[--backup-type] \
[--edb-sync-retries] \
[--edb-sync-retry-wait-duration] \
[--exclude-checks] \
[--help] \
[--ignore-warnings=true|false] \
[--include-checks] \
[--include-namespaces=<project-name1,project-name2,...>] \
[--tenant-operator-namespace=<project-name>]

# 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

Table 1: Global options arguments
Argument Description
<trace-location> The stack trace location
<severity> The log severity level

Options

Table 1: Command options
Option Description
--backup-type The type of object that is being backed up.
Status
Optional.
Syntax
--backup-type=<backup-object-type>
Default value
cpd
Valid values
cpd
The object that is being backed up is an IBM Software Hub instance.
singleton
The object that is being backed up is an IBM Software Hub singleton. For example, the scheduling service.
--edb-sync-retries Number of times to retry EDB Postgres cluster sync check upon failure.
Status
Optional.
Syntax
--edb-sync-retries=<integer>
Default value
5
Valid values
Any positive integer
--edb-sync-retry-wait-duration Wait duration of EDB Postgres cluster sync check retries upon failure.
Status
Optional.
Syntax
--edb-sync-retry-wait-duration=<h,m,s>
Default value
1s
Valid values
Any valid duration string. Examples: 1m, 30m, 1h, 2h45m
--exclude-checks Comma-separated list of checks to skip.
Status
Optional.
Syntax
--exclude-checks=<check1,check2,...>
Default value
No default.
Valid values
OcVersion, CpdCliOadpVersion, OadpOperatorCSV, EdbClustersInSync

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--ignore-warnings When set to `true`, any backups that have warnings will not be flagged as errors during restore precheck.
Status
Optional.
Syntax
--ignore-warnings=true|false
Default value
false
Valid values
true|false
--include-checks Comma-separated list of checks to run. Checks that are not specified are not run.
Status
Optional.
Syntax
--include-checks=<check1,check2,...>
Default value
No default.
Valid values
OcVersion, CpdCliOadpVersion, OadpOperatorCSV, EdbClustersInSync
--include-namespaces Include the specified namespaces, including tethered namespaces, in the backup.
Status
Optional.
Syntax
--include-namespaces=<project-name1,project-name2,...>
Default value
${PROJECT_CPD_INST_OPERANDS}
Valid values
Any valid project names. (Comma-separated string array.)
--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.
Status
Optional.
Syntax
--tenant-operator-namespace
Default value
No default.
Valid values

A valid namespace name.

Note: The following command is an alternative to using this option:
cpd-cli oadp client config set cpd-namespace=<cpd-namespace-name>

However, the option takes precedence over this command.
Notes:
  • Only the --tenant-operator-namespace option or the --include-namespaces option can be used at a time. Running the command with both flags returns an error.
  • Check tethered namespaces.

Global options

You can also use the following global options with this command:

Table 2: Command global options
Option Description
--add_dir_header Add the file directory to the header of log messages.
Status
Optional.
Syntax
--add_dir_header=true|false
Default value
false
Valid values
false
Do not add the file directory to the header of log messages.
true
Add the file directory to the header of log messages.
--alsologtostderr Log to standard error as well as files.
Status
Optional.
Syntax
--alsologtostderr=true|false
Default value
false
Valid values
false
Do not log to standard error as well as files.
true
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.
Status
Optional.
Syntax
--cpd-namespace=<cpd-namespace>
Default value
No default value.
Valid values
A valid IBM® Software Hub namespace.
Tip: The following command is an alternative to using this option:
cpd-cli oadp client config set cpd-namespace=<cpd-namespace-name>
However, the option takes precedence over the command.
--kubeconfig Paths to a kubeconfig. Only required if out-of-cluster.
Status
Optional.
Syntax
--kubeconfig=<kubeconfig-paths>
Default value
No default.
Valid values
Valid kubeconfig paths.
--log-level The command log level.
Status
Optional.
Syntax
--log-level=info|debug|warn|error|panic|trace
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.
--log-backtrace-at traceLocation When logging hits line file:N, emit a stack trace.
Status
Optional.
Syntax
--log-backtrace-at traceLocation=<integer>
Default value

0.

Valid values
Any positive integer.
--log-dir If non-empty, write log files in this directory.
Status
Optional.
Syntax
--log-dir=<log_directory>
Default value
No default.
Valid values
A valid directory.
Note: This option has no effect when --logtostderr=true.
--log-file If non-empty, use this log file.
Status
Optional.
Syntax
--log-file=<log_file_name>
Default value
No default.
Valid values
A valid directory.
Note: This option has no effect when --logtostderr=true.
--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.
Status
Optional.
Syntax
--log_file_max_size=<uint>
Default value
1800.
Valid values
A valid unsigned integer.
Note: This option has no effect when --logtostderr=true.
--logtostderr Log to standard error instead of files.
Status
Optional.
Syntax
--logtostderr=true|false
Default value
true
Valid values
true
Log to standard error instead of files.
false
Log to files.
--namespace

-n

 The namespace where OADP is installed.
Status
Optional.
Syntax
--namespace=<oadp-namespace>
Default value
No default value.
Valid values
Valid namespace name.
Tip: The following command is an alternative to using this option:
cpd-cli oadp client config set namespace=<OADP-operator-namespace>
However, the option takes precedence over the command.
--one-output Specifies whether to only write logs to their native severity level.
Status
Optional.
Syntax
--one-output=true|false
Default value
false
Valid values
false
Write logs to their native severity level and also to each lower severity level.
true
Write logs only to their native severity level.
Note: This option has no effect when --logtostderr=true.
--skip-headers Specifies whether to avoid header prefixes in log messages.
Status
Optional.
Syntax
--skip-headers
Default value
false
Valid values
false
Do not avoid header prefixes in log messages.
true
Avoid header prefixes in log messages.
--skip-log-headers Specifies whether to avoid header prefixes when opening log files.
Status
Optional.
Syntax
--skip-log-headers
Default value
false
Valid values
false
Do not avoid headers when opening log files.
true
Avoid headers 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.
Status
Optional.
Syntax
--stderrthreshold severity=<integer>
Default value
2
Valid values
Any positive integer.
Note: This option has no effect when --logtostderr=true or .--alsologtostderr=false
--v

-v

 Number for the log level verbosity.
Status
Optional.
Syntax
--v=<integer>
Default value
No default.
Valid values
Any valid positive integer.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.
--vmodule moduleSpec Comma-separated list of pattern=N settings for file-filtered logging.
Status
Optional.
Syntax
--vmodule moduleSpec=<pattern1, pattern2, and so on>
Default value
No default.
Valid values

Examples

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

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.

Run backup precheck.
cpd-cli oadp backup precheck \
--tenant-operator-namespace ${PROJECT_CPD_INST_OPERATORS} \
--include-checks=EdbClustersInSync \
--edb-sync-retries 10 \
--edb-sync-retry-wait-duration 2s \
--verbose
Run backup precheck, excluding checking that EDB Postgres clusters are in sync.
cpd-cli oadp backup precheck \
--tenant-operator-namespace ${PROJECT_CPD_INST_OPERATORS} \
--exclude-checks=EdbClustersInSync
--verbose