2.8.1 Set the Volume Backup Location

This topic describes how to set the location where volume backups are stored.

Volume backups are stored in Oracle Cloud Infrastructure (OCI) object storage. To use volume backups you must have access to OCI Object Storage Service, and then specify the service details as attributes of the Exascale cluster.

To set the location where volume backups are stored, use the ESCLI chcluster command and specify the following attributes:

  • backupObjectStoreNamespace: Specifies the OCI object store namespace that contains the backup resources, which is the top-level container for all storage buckets and objects.
  • backupCompartmentName: Specifies the name of the OCI compartment that contains the backup resources.
  • backupCompartmentOcid: Specifies the OCI unique identifier (OCID) for the compartment that contains the backup resources.
  • backupObjectStoreBucketName: Specifies the name of the OCI object store bucket that contains the backup resources.
  • backupUserOcid: Specifies the OCID for the backup user. The backup user is the OCI user that provides access to Object Storage Service for the Exascale volume backup service.
  • backupUserPubKeyFprint: Specifies the public key fingerprint in base64 format for the backup user.
  • backupUserPrivKey: Specifies the private key in PEM format for authenticating the backup user.
  • regionIdentifier: Specifies the OCI region that contains the Exascale cluster resources.
  • tenancyOcid: Specifies the OCID for the tenancy that contains the Exascale cluster resources.
  • backupEndpoint: Optionally specifies the API endpoint URL for Object Storage Service. If specified, this value overrides the regionIdentifier value for volume backup purposes.

Because of the complex parameter values that are involved, consider using a file to contain the command. For example:

$ cat command.txt
chcluster --attributes 
backupObjectStoreNamespace=exampledbaas,
backupCompartmentName=bkupComp,
backupCompartmentOcid=ocid1.compartment.oc1..aaaaaaaa********************a2h4p6upiwtwtg6ehl7lo6mjqlj6zdvq,
backupObjectStoreBucketName=bkupBucket,
backupUserOcid=ocid1.user.oc1..aaaaaaaa********************qfacrpincf433r2koe37u5qgsidl6tra,
backupUserPrivKey=PEM-format-private-key-string,
backupUserPubKeyFprint=1e:1f:da:ee:**:**:**:**:**:**:**:**:e6:0c:1a:25,
regionIdentifier=us-phoenix-1,
tenancyOcid=ocid1.tenancy.oc1..aaaaaaaa********************7lb5gbw5icbm5lwwncxs6uhjqhzexg2a

$ escli --wallet admin-user-wallet-location `cat command.txt`