Restore

The Airctl restore process is essential for reinstating the entire management plane, including its critical data and state files, leveraging previously captured backups. This comprehensive process ensures system recovery and data integrity in case of any unexpected system issues or migrations.

Command Syntax

The restore command in Airctl follows a specific syntax:

airctl restore [--backupdir backup_dir_path] --config airctl-config.yaml --verbose

• --backupdir backup_dir_path: Specifies the directory path containing the backup files. By default, it looks for the backup.tar.gz file within /tmp.
• --config airctl-config.yaml: References the Airctl configuration file, ensuring alignment with the required configurations during restoration.

Detailed Restore Process

Purpose

The restore process aims to reinstate the management plane along with its complete dataset and state files from a previously captured backup.

Steps Involved

1. Command Invocation

   • Execute the airctl restore command, specifying the backup directory path (--backupdir) if different from the default location (/tmp).
   • Use the --config flag to reference the airctl-config.yaml file, ensuring the restoration aligns with the necessary configurations.

2. Backup Source

   • The restore command detects and selects the backup.tar.gz file from the specified backup directory or the default /tmp location.

3. Restoration Process

   • The restoration process reinstates critical components, including state files, MySQL databases, Consul data, and other configurations integral to the management plane.

Usage Example:

airctl restore --backupdir /path/to/backup --config airctl-config.yaml --verbose

Change in externalIP

If the externalIP in the airctl-config.yaml is changed on the new management plane, all the attached nodes need to be updated with the new IP. It can be done by running the following command:

airctl configure-hosts --skip-docker-img-import --skip-docker-install --skip-yum-repo-install --verbose

Change is externalIP might be required in the use case such as, if the management plane is restored to a different network and VIP for management plane is changed.

Verification

• Post-restoration, verify the successful completion by checking the system's operational status and the presence of critical components.

The Airctl restore process is crucial for system recovery, ensuring data integrity, and reinstating the management plane from previously captured backups. By following the provided steps and utilizing the appropriate command syntax, users can confidently restore the system to a known, stable state, mitigating potential data loss or system disruptions.