DCD-880: Add documentation to backup playbook

This commit is contained in:
Ben Partridge
2020-01-03 15:18:13 +11:00
parent a6b38cb21f
commit f3d5e19674

View File

@@ -1,3 +1,14 @@
# Runs atlassian-slingshot to backup your product instance. Should be run when there is only 1 app node (i.e server or single node cluster)
# Params
# Required
# atl_product_edition - one of "confluence", "jira", or "bitbucket".
# atl_product_family - should be the same as the "atl_product_edition"
# atl_slingshot_backup_dir - working directory for the backup, should be large enough to fit database and shared home dumps
# atl_s3_backup_bucket - s3 bucket to upload your backup to
# atl_s3_backup_region - AWS region where the s3 bucket is deployed
#
# There are other variables which can be overriden. See the tasks for details. The will be defaulted by the role defaults or the inventory group_vars
- hosts: aws_node_local
roles:
- role: create_backups