Backup Configuration Parameters

Customer Managed Applies to customer-managed instances of Alation

The information on this page is given for reference only. Do not modify the parameters listed in this table unless you follow specific instructions, for example:

• Configure Incremental Backups

• Set Up a Custom Backup Schedule

• Define the Number of Backups to Retain (Backup V1, Backup V2)

Note

Modifying alation_conf parameters without specific instructions is not a safe action. For more information about alation_conf, see Using alation_conf.

Jump to the table for your current backup tool:

• Backup V2 Configuration Parameters

• Backup V1 Configuration Parameters

Backup V2 Configuration Parameters

Parameter	Value	Description
alation.backup_v2.incr_backup	True or False	Enables incremental backups. No restart is required when the value is changed.
alation.backup_v2.incr_backup_versions	Number	Sets the number of incremental backups per full backup. No restart is required when the value is changed. Default = 0, which means full backups
alation.backup.data_temp_dir	Path inside the Alation shell	Default: /data2/tmp/ Sets the working directory for the backup process. No restart is required when the value is changed.
alation.backup.data_dump_dir	Path inside the Alation shell	Default: /data2/backup/ Sets the backup storage directory on the Alation host. Compressed backup files are created in this directory. No restart is required when the value is changed.
alation.backup.data_dump_versions	Number	Defines the number of backups to keep on the backup disk. Default: 5. No restart is required when the value is changed.
alation.backup.restore_file	Path inside the Alation shell	Example: /data2/backup/<file_name.tar> Path to the backup file to be used during the restore.
alation.backup.scheduled_minute	Number 0-60 for minutes of of an hour	Default: 0 Defines minutes for the backup schedule
alation.backup.scheduled_hour	Number 0-23 for hours in a day	Defines hour for the backup schedule Default: 4 Use 24-hour format
alation.backup.scheduled_day	Comma separated values for days of week	Defines days for the backup schedule. Default: sun,mon,tue,wed,thu,fri,sat
alation.backup.enabled	True	Do not modify manually. Stores the status of the backup process on an instance. If set to False, the Alation instance is not backed up, which is an unsafe practice.
alation.backup_v2.enabled	False	Do not modify manually. Stores the status of the Backup V2 feature on an instance. True means enabled. False means disabled.
pgsql.config.backup_enabled	True	Enables the backup for the PostgreSQL component
alation.backup.post_script.enabled	True	Defines whether or not to launch the post script after the backup creation
alation.backup.post_script.path	Path to the script	/data1/site_data/s3_backup_sync.sh %f The post script is used to upload the backup .tar file to Amazon S3. It is possible to use another cloud storage. Add a custom script and provide the path to this script.
alation.backup.chef_timeout	21600	Time in seconds. Defines how long Chef waits to run commands. Backups might fail if this is too short.
alation.backup.io_nice	2	Defines what ionic value to use to not overload the disk.
alation.backup.site_data_exclusions	tmp, kvstoredb, logs, django.cache, dumps	Defines what content to exclude from the backup of the site_data folder.
alation.backup_v2.backup_space	0.0	Uncompressed file space of backup file verified during restore. Set automatically and should not be modified manually.
alation.backup_v2.incr_count	Number	Number of incremental backups completed including the initial full backup. Should not be set manually.

Backup V1 Configuration Parameters

Attribute	Value	Description
alation.backup.pg_compress	True or False	Defines whether the backup will be compressed.
alation.backup.data_dump_versions	Number	Defines the number of backups to keep on the backup disk.
alation.backup.site_data_exclusions	tmp, kvstoredb, logs, django.cache, dumps	Defines what not to backup in the site_data folder.
alation.backup.restore_file	/path/to/backup	Defines what backup file to use for restoring.
alation.backup.io_nice	0 for none, 1 for real-time, 2 for best-effort, 3 for idle	Defines what ionic value is used.
alation.backup.pg_compress_level	0 to 9	Defines the compression level for the pg_backup tool.
alation.backup.chef_timeout	Time in seconds.	Defines how long chef waits to run commands. Backups may fail if this time is too short.
alation.backup.data_dump_dir	/path/to/dir	Defines which directory the backups are saved too.
alation.backup.data_temp_dir	/path/to/dir	Defines the staging directory where backups are extracted.
alation.backup.enabled	True or False	Defines if backups are enabled.
pgsql.config.wal_keep_segments	3000 (48GB)	Defines the number of WAL segments to retain. This is useful if Postgres compression is enabled.
alation.backup.scheduled_minute	0 to 60 for number of minutes in an hour	Defines minutes of the backup schedule.
alation.backup.scheduled_hour	0 to 23 for hours in a day	Defines the hour for the backup schedule.
alation.backup.scheduled_day	Comma-separated values for Sunday to Saturday	Defines the days for the backup schedule. Default: sun,mon,tue,wed,thu,fri,sat.
alation.backup.post_script.enabled	True or False	Defines wether or not to launch the post backup script.
alation.backup.post_script.path	Path with %f used as a variable for the current backup file	Defines the path to the post backup script.