Contents
1 Introduction
This document describes how to create a backup of the Atlas configuration for the Cloud Execution Environment (CEE).
The script that creates the backup is invoked by the atlas backup-create command. For more information about the atlas command and its subcommands, refer to the Atlas Software Management Guide.
The Atlas configuration backup is generated by using the atlas command, executed on the Atlas Virtual Machine (VM). The generated backup contains key configuration files. The backup can be used to restore the Atlas configuration to a previous state, if needed.
- Note:
- According to default configuration, Atlas creates periodic backup twice a day, using the password defined in the BACKUP_PASSWORD variable in localrc. The default password is randomly generated and can be changed in localrc. The password is required for the periodic backup and restore procedures. Periodic backup can be disabled and the time interval for taking these backups can be configured in localrc. To make the changes in localrc, refer to Atlas SW Installation.
For instructions on restoring Atlas using a backup, refer to the document Atlas Restore.
Refer to the document Backup and Restore Overview for more information on Atlas backup, including the following:
- Backup contents
- Backup sizes and locations
- Retention policies
- Procedure durations
- Recommended backup strategy
For an overview of all backup and restore options available in CEE, refer to the Backup and Restore Overview.
1.1 Prerequisites
This section describes the prerequisites which must be fulfilled before a backup of the Atlas configuration files can be taken.
1.1.1 Conditions
Before the backup procedure can be performed, the following conditions must apply:
- The user must have root access to be able to run the atlas command.
- The location of a predefined persistent storage must be known.
2 Atlas Backup
The backup feature saves the configuration files and folders contained in the CEE Atlas image in a directory of encrypted tar files.
The command syntax is as follows:
atlas backup-create [--name <backup_name>] --p <backup_password>
atlas backup-create [--name <backup_name>] --p⇒
<backup_password>
The optional parameter --name can be used to name the backup. The default name is AtlasBackup. The backup name can only contain letters, numbers, and underscores. No special characters are allowed.
The positional parameter --p is used to encrypt the backup.
To back up the Atlas configuration, do the following:
- Log on to the Atlas VM.
- Start the backup procedure by issuing the following command:
atlasadm@atlas:~$ sudo atlas backup-create --name <backup_name> --p <backup_password>
atlasadm@atlas:~$ sudo atlas backup-create --name⇒ <backup_name> --p <backup_password>
The following is displayed in the terminal window:
Tue 02 May 2017 08:48:23 INFO: Creating Backup ⇒ "AtlasBackup" with ID=1493707703... Tue 02 May 2017 08:48:23 INFO: Backing up password ⇒ configuration, home directories and database... Tue 02 May 2017 08:48:58 INFO: Done. Tue 02 May 2017 08:49:05 INFO: Encrypting... Tue 02 May 2017 08:49:05 INFO: Done. Tue 02 May 2017 08:49:05 INFO: Uploading Backup ⇒ "AtlasBackup" of size 654M to Swift... Tue 02 May 2017 08:49:15 INFO: Done. Tue 02 May 2017 08:49:15 INFO: Backup Complete!
- By using the following command, verify that the backup
file has been created:
atlasadm@atlas:~$ sudo atlas backup-list
The command displays the following in the current terminal window:
+--------------+------------------------+--------------+--------+--------------+------------+ | ID | Name | Storage | Size | Date | Time | +--------------+------------------------+--------------+--------+--------------+------------+ | 1493707703 | AtlasBackup | SWIFT | 654M | 2-May-2017 | 08:49:05 | +--------------+------------------------+--------------+--------+--------------+------------+
- Save the ID and the password of the backup for future
use.
- Note:
- The ID is used for downloading the backup files from Swift and for restoring Atlas from the backup, as described in Atlas Restore. The password is used for restoring Atlas from backup.
3 Deleting Backup
This section describes how to delete an Atlas backup.
The command syntax is as follows:
atlas backup-delete --d <id> [--all]
The positional parameter --d is the ID of the backup to be deleted
The optional parameter --all can be used to delete a backup uploaded to Swift as well as the local backup. If unspecified, only the local backup is deleted.
An example of the command is:atlasadm@atlas:~$ sudo atlas backup-delete --d 1493707703 --all
atlasadm@atlas:~$ sudo atlas backup-delete --d ⇒
1493707703 --all
An example of the printout is:
Tue 02 May 2017 10:09:20 INFO: Deleting Backup 1493707703 Tue 02 May 2017 10:09:24 INFO: Backup Delete Complete! +--------------+------------------------+--------------+--------+--------------+----------+ | ID | Name | Storage | Size | Date | Time | +--------------+------------------------+--------------+--------+--------------+----------+ +--------------+------------------------+--------------+--------+--------------+----------+ |
As the backup is deleted with the --all option, it is deleted from Swift as well:
root@atlas:/var/archives/# swift list AtlasBackups | grep <id>
root@atlas:/var/archives/# ⇒
swift list AtlasBackups | grep <id>
An example of the command is:
root@atlas:/var/archives/# swift list AtlasBackups | grep 1493707703
root@atlas:/var/archives/# ⇒
swift list AtlasBackups | grep 1493707703
There is no output printed.