Create Backups Manually¶
Customer Managed Applies to customer-managed instances of Alation
This information applies to both Backup V1 and Backup V2.
Use the steps in this section to create an Alation backup manually on demand. The backup process creates backups based on your current backup configuration.
Depending on your Alation version, Alation will create one or two compressed backup files in the backup storage directory.
Versions prior to 2021.4—The backup process creates one Alation backup file. The name of the file uses the following format:
<timestamp_version>_alation_backup.tar.gz. For example:
Starting in version 2021.4—In addition to the Alation backup file, Alation will create a second backup file of the Event Bus component. The Event Bus backup uses the following file name format:
<timestamp_version>_alation_eb_backup.tar.gz. For example:
From version 2023.1—Alation supports more configurability for backups. By default, the backup process will create two backup files—the Alation backup and the Event Bus backup. The backup of the internal Postgres database will be included into the Alation backup. However, you can use the backup configuration capabilities and exclude the Postgres database backup from the Alation backup. In this case Alation will place the Postgres backup in a separate directory. See Manage Postgres Backups Separately for more information.
The default location for the backup files is the data2/backup directory on the Alation server (inside the Alation shell).
If you have changed the default location, look for the backups in your custom backup directory.
When creating backups, it’s important to be aware of whether your backups are incremental—see Configure Incremental Backups for more information. Incremental backups are available in Backup V2. Every time you run the backup action, Alation will create a full backup if incremental backups are disabled. If incremental backups are enabled, Alation will create a consecutive incremental backup. If you have enabled incremental backups, note that the Event Bus backup will also run every time an incremental Alation backup is created. However, the Event Bus backup itself is not incremental. The backup process creates a full Event Bus backup every time it runs.
The Alation server does not need to be stopped to run a backup.
Create a Backup¶
To create a backup:
The backup command may take a few hours depending on the size of the instance, and we recommend running it with
nohupor using a terminal multiplexer, such as Screen. If using Screen, start a Screen session:
screen -S alation-backup
Enter the Alation shell.
sudo /etc/init.d/alation shell
Change user to
sudo su alation
Run the backup command:
The compressed backup will be saved in the location configured in the
alation.backup.data_dump_dirparameter of alation_conf. The default location is /data2/backup.
Exit from the user
Exit from the Alation shell.
If the backup action fails, manually delete the staging directory for the Postgres backups—/data2/backup/pgbackup or /data2/backup/pgbackrest, depending on your version—before attempting the next backup action.
To check that the backup has been successfully created:
Go to /data2/backup/ or your configured backup storage location and ensure that there are backup files
<timestamp_version>_alation_eb_backup.tar.gzwith the current timestamp.
At regular intervals, test restoration on a separate machine.