Agent--Halo
1.1 Create Halo Instance
Prerequisites
- Created a user.
- Created a storage repository.
- Created a service plan.
- The Halo service is already installed and accessible.
Steps
Step 1: Click [Backup Service] - [Database] from the system menu, then select the "Server Name" to enter the database instance page.
Step 2: Click [Instance].
Step 3: Click the [Add] button in the top right corner of [Instance], and a pop-up window will appear.
Step 4: Fill in the required parameters as shown below:
| Parameter Name | Description | Configuration Principle |
|---|---|---|
| Database Type | Single choice, required, default is MySQL | Choose XiHe |
| Server Name | Dropdown, required | Select the server name where Halo is installed |
| Instance Name | Text box, required, customizable | No length or special character restrictions |
| DB Username | Username input box, required | Enter the Halo username |
| Password | Password box, required | Enter the Halo password |
| Port | Input box, required | Default port is 1921 |
| Maintenance DB | Input box, required | Default value is halo0root |
| Binary Directory | Input box, required | Enter the correct Halo binary directory |
| Database Directory | Input box, required | Enter the correct Halo database directory |
| Archive Log Dir | Input box, path format | Enter the correct archive log directory |
Step 5: Click [Confirm]. A success message will appear.
1.2 Create Halo Backup Object Set
Prerequisites
- A Halo instance has been created.
Steps
Step 1: Click [Backup Service] - [Database] - [Server Name] - [Backup Set] from the system menu.
Step 2: Click the [Add] button in the top right corner of [Backup Set], and a pop-up window will appear.
Step 3: Fill in the required parameters as shown below:
| Parameter Name | Description | Configuration Principle |
|---|---|---|
| Instance | Dropdown, required | Select the XiHe instance |
| Backup Set Name | Text box, required | Up to 50 characters, no special characters |
| Database | Automatically displays all databases under instance | Select one or more databases |
| Data Stream | Numeric type | Maximum 200, recommended 4 |
| Configuration | Single choice, required | Choose Simple or Advanced Configuration |
| Service Plan | Single choice, required | Select the appropriate plan |
Step 4: Click [Confirm]. A success message will appear.
1.3 Halo Database Backup
Prerequisites
- The Halo backup set is configured.
Steps
Step 1: Click [Backup Service] - [Database] - [Server Name] - [Backup Set] from the system menu.
Step 2: Select the backup set and click [Operation] - [Backup].
Step 3: Choose [Database] and click [Confirm]. A message "Backup job submitted successfully" will appear.
Step 4: After the backup job starts successfully, go to [Monitoring Center] - [Jobs] - [Active Jobs] to view the backup job.
Step 5: After the backup is completed, go to [Monitoring Center] - [Jobs] - [Job History] to view the completed backup job with a "Completed" status.
1.4 Halo Database Recovery
Prerequisites
- A backup of the Halo database has been completed.
- System database recovery is not supported.
Steps
Step 1: Click [Backup Service] - [Database] - [Server Name] - [Instance] from the system menu.
Step 2: Select [Instance], and click [Operation] - [Restore].
Step 3: A restore window will pop up. Choose a restore point based on the time range, select [Database] and [Backup Time], and click [Next] (cross-backup set recovery is not supported).
Step 4: Set the recovery options and click [Confirm].
Step 5: Fill in the required parameters as shown below:
| Parameter Name | Description | Configuration Principle |
|---|---|---|
| Recovery Option | Default is Cross-Machine Recovery | Choose Source Machine Recovery or Cross-Machine Recovery |
| Target Host | Default is Cross-Machine Recovery. Select the target host from the list of client nodes with the Halo service installed | Supports cross-machine; if source machine is selected, target host is grayed out; recover to disk |
| Target Instance | Linked with the target host, select a successfully created Halo instance under the target host | Default instance for the source machine, grayed out |
| Recovery Streams | Numeric type | Maximum 200, recommended 4 |
Step 6: After the job starts successfully, go to [Monitoring Center] - [Jobs] - [Active Jobs] to view the job.
Step 7: Once the job is completed, go to [Monitoring Center] - [Jobs] - [Job History] to view the job and its status.
1.5 Restore Halo Database to Disk
Prerequisites
- A backup of the Halo database has been completed.
Steps
Step 1: Click [Backup Service] - [Database] - [Server Name] - [Instance] from the system menu.Step 2: Select [Instance], and click [Operation] - [Restore].Step 3: A restore window will pop up. Choose a restore point based on the time range, select [Database] and [Backup Time], and click [Next] (cross-backup set recovery is not supported).Step 4: Set the recovery options and click [Confirm].
Step 5: Fill in the required parameters as shown below:
| Parameter Name | Description | Configuration Principle |
|---|---|---|
| Recovery Option | Default is Cross-Machine Recovery | Choose Restore to Disk |
| Target Host | Dropdown, single choice, required | Select the appropriate host from all registered client nodes |
| Temporary Directory | Path format, required | Specify the disk path on the target host |
| Recovery Streams | Numeric type | Maximum 200, recommended 4 |
Step 6: After the job starts successfully, go to [Monitoring Center] - [Jobs] - [Active Jobs] to view the job.Step 7: Once the job is completed, go to [Monitoring Center] - [Jobs] - [Job History] to view the job and its status.