database-backup-auth-pass |
The password or access key for the SFTP server or object-store that you specified in
database-backup-host. The password is converted and stored in Base64 encoded
format.For example:
apicup subsys set <subsystem_name> database-backup-auth-pass '<password>'
Note: You cannot use the `=` sign to assign the password to
database-backup-auth-pass.
If you change this value later, to apply the change you must run
apicup subsys db-reload <subsystem_name>
after you
run: apicup subsys install <subsystem_name>
|
database-backup-auth-ssh-key |
Applies to SFTP only.
OpenSSH private key. Changing this value restarts the management database.
Important:
- Use
apicup certs to set this value. Do not use apicup
subsys.
- Only OpenSSH keys are supported.1
apicup certs set <subsystem_name> database-backup-auth-ssh-key <ssh private key filepath>
|
database-backup-auth-user |
The username or secret key ID for the host that you specify in
database-backup-host.apicup subsys set <subsystem_name> database-backup-auth-user <username>
If you change this value later, to apply the change you must run
apicup subsys db-reload <subsystem_name>
after you
run: apicup subsys install <subsystem_name>
|
database-backup-host |
Not required if database-backup-protocol=local.
Specify your SFTP server hostname or object-store endpoint with the corresponding object-store
region in the format <S3endpoint>/<S3region>. Examples:
-
apicup subsys set <subsystem_name> database-backup-host=sftp.example.com
-
apicup subsys set <subsystem_name> database-backup-host=s3.ibm.com/eu-west-2
-
apicup subsys set <subsystem_name> database-backup-host=s3.eu-gb.cloud-object-storage.appdomain.cloud/eu-standard
|
database-backup-path |
Not required if database-backup-protocol=local.
The path to the location of the backup.
- SFTP: The absolute path of the folder on the SFTP server, beginning with
/.
apicup subsys set mgmt database-backup-path=<full path to backups directory>
- Object-store: The bucket on your object-store, in the format
bucket-name/folder. The use of subdirectories in the bucket name is not
supported.Ensure that the bucket is empty.
When your deployment includes a management
subsystem in two different clusters (with active databases), the two management subsystems cannot
use the same object-store bucket name in the database backup configurations. Each management
subsystem must use a unique object-store bucket name.
apicup subsys set <subsystem_name> database-backup-path=<bucket-name/folder>
|
database-backup-port |
Applies to SFTP only.
The port for the protocol to connect to the
database-backup-host. The default value is
22.apicup subsys set mgmt database-backup-port=<port_number>
|
database-backup-protocol |
Set to objstore, sftp, or local.
Default is local.
apicup subsys set <subsystem_name> database-backup-protocol=<protocol>
|
database-backup-schedule |
Cron schedule for when database backups are run. The format for the schedule
is: * * * * * *
- - - - - -
| | | | | |
| | | | | +----- day of week (0 - 6) (Sunday=0)
| | | | +------- month (1 - 12)
| | | +--------- day of month (1 - 31)
| | +----------- hour (0 - 23)
| +------------- min (0 - 59)
+-------------- sec (0 - 59)
The default is an empty string, which means no backups are taken.
The time zone for backups is UTC.
This example schedules a backup to run daily at
01:00: apicup subsys set <subsystem_name> database-backup-schedule="0 0 1 * * *"
|
database-backup-certs |
Applies to object-store only.
If your object-store has a custom CA certificate, then you must configure your management
subsystem to trust this certificate.
- Log in to one of your management
VMs:
ssh apicadm@<management hostname>
- Switch to the
root user:sudo -i
- Follow the steps for creating a Kubernetes secret that contains your object-store's CA
certificate, as described for Kubernetes platforms in step 2 on Configuring management database backups. Use
default for the
<namespace> variable.
- Exit from the VM, and use apicup to set
database-backup-certs to the Kubernetes secret that you
created:apicup subsys set <subsystem_name> database-backup-certs=mgmt-custom-objstore-ca
|
database-backup-s3-uri-style |
Applies to object-store only.
Optional: Specifies whether the URI is in the form
of host or path.
apicup subsys set <subsystem_name> database-backup-s3-uri-style='<host|path>'
Supported
values:
|
database-backup-repo-retention-full |
The number of days of backups to retain.
For example, if database-backup-repo-retention-full is set to 30, then backups
for the last 30 days are retained. Older backups are deleted.
After restoration, all existing backups will be excluded from retention management and the count
of new backups resets to zero. New backups will be managed according to the value defined in
database-backup-repo-retention-full.
Minimum value: 1 Maximum value: 9999999 Default: none
|