Controller Backup and Restore¶
When deployed in a cloud environment, the Aviatrix controller is not in the data path as packet processing and encryption is done by the Aviatrix gateways.
When the controller is down or out of service, your network will continue to be operational and encrypted tunnels and OpenVPN® users stay connected and are not affected. Since most of the data logs are forwarded from the gateways directly, the loss of log information from the controller is minimal. The only impact is that you cannot build new tunnels or add new OpenVPN® users.
This loosely coupled relationship between the controller and gateways reduces the impact of the availability of the controller and simplifies your infrastructure. Since the controller stores configuration data, it should be periodically backed up to the appropriate AWS/Azure/Google account. If a replacement controller is launched, you can restore the configuration data from your backup. Note: If you have controller HA cloud formation stack running, please make sure you delete the stack prior to stopping the existing controller to avoid complication and failure in this restore operation.
How to backup configuration¶
Aviatrix stores the Controller backup in an AWS S3 bucket or an Azure Container. Before you begin, determine where you would like to store the backup and create either the S3 bucket or Azure Container.
Log in to the Controller
Click on the Settings navigation item
Click on the Maintenance sub item
Click on the Backup & Restore tab
Under the BACKUP section:
- Select the appropriate Cloud Type and Account Name
- Populate the S3 Bucket Name for AWS or Region, Storage Name, and Container Name for Azure
By default, only the latest configuration data is stored. Each time the configuration is backed up, it overwrites the previous one. If you would like to keep every copy, check the box Multiple Backup
The first time you enable this feature, the configuration will backed up to your specified location. After this, the configuration data is automatically backed up daily at 12am.
Selecting the “Multiple Backup” checkbox will enable the controller to backup up to a maximum of 3 rotating backups. Each backup filename will contain the date and time of when the backup is made. Additionally, the backup without any date and time in the filename contains a copy of the latest backup.
If you want to force an immediate backup (e.g. for a configuration change) you can accomplish this by clicking on the “Backup Now” button. If multiple backups are not enabled, each time the configuration is backed up, the backup up file will be overwritten. Otherwise, the oldest backed up will be overwritten.
It is recommended that you turn on the ‘Multiple Backup’ option. If the backup is already ‘Enabled’, go ahead and ‘Disable’ it, turn on the ‘Multiple Backup’ option and then ‘Enable’ the backup again.
How to restore configuration¶
If you are starting from a new Controller, follow these steps to get started:
- Log in to the Controller with the admin username and the default password
- Follow the initial steps to get the Controller up and running.
- Enter an email address
- Change your admin password
- Enter or skip the proxy configuration
- Allow the upgrade to run
Once you are past the initial configuration steps:
Login to the Controller
- Click on the Settings navigation item
- Click on the Maintenance sub item
- Click on the Backup & Restore tab
- Under the RESTORE section:
- Select the Cloud Type
- For AWS
- If you would like to use an existing account, please make sure you create one Access Account only with the EXACT Access Account Name that was used in your previous controller. Check the box Use Cloud Account Name and select the account. Otherwise, enter an Access Key and Secret Key
- Enter the Bucket Name and File Name of the file to restore.
- For Azure
- Enter the Subscription ID and Certificate Path
- Enter the Storage Name, Container Name, and File Name of the file to restore.
- Click Restore
How to backup configuration with AWS encrypted storage¶
AWS S3 allows uploaded backup files to be encrypted in the server side for more secure storage. The encryption is all done in the AWS S3 server side. This server side secure storage is in addition to the already encrypted Aviatrix controller backups.
1. Create AWS S3 bucket¶
2. Configure bucket server side encryption in S3 bucket properties.¶
3. Select either None, AES-256, AWS-KMS AWS/S3, or AWS-KMS Custom KMS ARN.¶
4. If AWS-KMS with Custom KMS ARN is selected, additional configuration will be needed:¶
- Create a Custom Encryption Key by going to IAM->Encryption Keys->Create Key
- Copy the custom Key KMS ARN to the S3 encryption property configuration
Make sure that the custom encryption key and the S3 bucket are in the same region.
- If IAM user is used for onboarding authentication, add user “aviatrix-role-app” into the key
OpenVPN is a registered trademark of OpenVPN Inc.