Install a service

Before you perform a logical backup, you need to install the backup and restore service by referring to this topic.

Prerequisites

• You have obtained the backup and restore 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 obtain the package of the same version as that of the OceanBase cluster. For example, if the version of the OceanBase cluster to back up is V2.2.52, we recommend that you obtain the package oceanbase-data-maintain-2.2.52-20210331185950.el7.x86_64.rpm.

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

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

Procedure

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

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

3. Specify the parameters in the Basic Configurations section.

   

   Parameter	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 a service type. Valid values: Backup: Only the backup service is installed. Recovery: Only the restore service is installed. Backup & Recovery: Both the backup and restore services are installed.
   Cleanup Threshold for Service Log Files	An alert is triggered to remind you to clean up logs when the size of service log files reaches 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 the parameters in the Storage Configuration section. Then, click Test to verify whether the parameters are properly set.

   

   Parameter	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. Valid values: * OSS: Alibaba Cloud Object Storage Service, a cloud storage service. * File: physical storage.
   Storage Directory	The directory where backup files are stored. The admin user must have read and write permissions on 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 pair used to access the OSS bucket.

5. Specify the parameters in the Backup Configuration section.

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

   Note

   The backup MetaDB is a third-party database that contains tables for backup and restore 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, a backup MetaDB is also created.

   

   • Specify the parameters in the Common section or use the default values.

     

     Cluster List URL refers to the URL of the cluster where the MetaDB is located.

   • Specify the parameters in the Others section or use the default values.

     

6. Specify the parameters in the Restore Configuration section.

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

     Note

     The restore MetaDB is a third-party database. The system schedules and controls restore tasks by querying the control tables in the MetaDB. Backup and restore MetaDBs can be deployed on the same MetaDB server.

     

   • Specify the parameters in the Others section or use the default values.

     

7. Click Install.