Install a service

For logical backups, you must first install the backup or recovery service before you can use the backup or recovery feature.

Prerequisites

• You have got the backup and recovery service package: oceanbase-data-maintain-x.x.xx-YYYYMMDDhhmmss.el7.x86_64 or oceanbase-data-maintain-x.x.xx-YYYYMMDDhhmmss.el7.aarch64.

  Note

  We recommend that you get the package of the same version as that of the OceanBase cluster. For example, for OceanBase Database V2.2.52, get oceanbase-data-maintain-2.2.52-20210331185950.el7.x86_64.rpm.

• You have added a host as the backup and recovery server. For more information, see Add a host

• You have deployed the Network File System (NFS) server on the host. For more information, see the "Deploy NFS" topic of OceanBase Database Administrator Guide.

Install the service

1. In the left-side navigation pane, choose Backup & Recovery > Service .

2. In the upper-right corner, click Install Service .

3. Specify fields in the Basic Configurations section.

   

   Field	Description
   Service Name	The name must start with a letter and end with a letter or a digit. It can contain letters, digits, and underscores (_). It must be 2 to 32 characters in length.
   Service Version	Select an existing service version. Click Add Version to upload a new version.
   Installation Type	Select from the following installation types: Backup : Only the backup service is installed. Recovery : Only the recovery service is installed. Backup & Recovery : Both the backup and recovery services are installed.
   Cleanup Threshold for Service Log Files	An alert is triggered to remind you to clean the logs when the size of service log files reach the specified threshold. The default threshold is 80%. You can adjust the threshold as needed.
   Host	Select the host on which you want to install the service.

4. Specify fields in the Storage Configuration section. Then, click Test to verify if the fields are properly set.

   

   Field	Description
   Storage Configuration Name	The name must start with a letter and end with a letter or a digit. It can contain letters, digits, and underscores (_). It must be 2 to 32 characters in length.
   Storage Type	The type of the storage media for backup files. The following types are supported: OSS: Alibaba Cloud Object Storage Service, a cloud storage service File: physical storage
   Storage Directory	The directory where backup files are stored. The administrator must have read and write permissions to this directory.
   Alert Threshold for Backup Storage Capacity	An alert is triggered when the backup storage reaches this threshold. The default threshold is 80%. You can adjust the threshold as needed.
   Domain	This parameter is required only when the storage type is OSS. It is the domain name at which the OSS bucket can be accessed.
   User	This parameter is required only when the storage type is OSS. It is the user used to access the OSS bucket.
   AccessKey Pair	This parameter is required only when the storage type is OSS. It is the AccessKey used to access the OSS bucket.

5. Specify fields in the Backup Configuration section.

   • Specify fields in the Back up Metadatabase Configurations section as needed or use the default values.

     Note

     The backup MetaDB is a third-party metadatabase that contains tables for backup and recovery parameters and backup tasks. The system controls the initiation and cancellation of baseline and incremental data backup by checking whether any backup tasks exist in the MetaDB. It also updates the status of these tasks when they proceed.

     When you create a MetaDB, you also create a backup MetaDB.

     

   • Specify fields in the Common section as needed or use the default values.

     

     URL of Clusters refers to the URL of the cluster where the MetaDB is located.

   • Specify fields in the Others section as needed or use the default values.

     

6. Specify fields in the Restore Configuration section.

   • Specify fields in the Restore Metadatabase Configurations section as needed or use the default values.

   Note

   The recovery MetaDB is a third-party metadatabase. The system schedules and controls recovery tasks by consulting the control tables in the MetaDB.

   

   • Specify fields in the Others section as needed or use the default values.

     

7. Click Install .