Backup

The Airctl backup process is pivotal for safeguarding the entire state, data, and configurations within the management plane. This comprehensive backup approach ensures that critical information, including MySQL databases, Consul data, and various state files, is preserved for potential restoration or system recovery.

Command Syntax

The backup command in Airctl follows a specific syntax:

airctl backup [--outdir directory_name] --config airctl-config.yaml

• --outdir: Specifies the output directory where the backup file will be stored. If omitted, the default location is /tmp.
• --config airctl-config.yaml: References the Airctl configuration file to ensure comprehensive backup with the specified configurations.

Detailed Backup Process

Purpose

The backup process aims to capture and store critical data and configurations to enable system recovery or migration to a new environment.

Steps Involved

1. Command Invocation

   • Execute the airctl backup command, ensuring the correct specification of the output directory (--outdir) or utilizing the default location.
   • Use the --config flag to reference the airctl-config.yaml file, which contains essential configuration details for the backup.

2. Backup Content

   • The backup command captures essential components such as state files, MySQL databases, Consul data, and other critical configurations integral to the management plane's functionality.

3. Backup Location

   • By default, the backup file (backup.tar.gz) is generated in the /tmp directory unless an alternative output directory is specified using the --outdir flag.

Usage Example:

airctl backup --outdir /path/to/directory --config airctl-config.yaml

Verification

After the backup process completes, confirm the presence of the generated backup.tar.gz file in the specified output directory or the default location (/tmp).

The Airctl backup process is vital for preserving the integrity and state of the management plane. By following the outlined steps and using the appropriate command syntax, users can ensure a reliable and comprehensive backup of essential system components, enabling seamless restoration or migration processes.