Skip to content

Latest commit

 

History

History
69 lines (51 loc) · 2.79 KB

README.md

File metadata and controls

69 lines (51 loc) · 2.79 KB
Raw

backup_create_plan

A role to create a backup plan and optionally a vault. A set of variables for plan rules is included for use as-is or as examples for modification. This role can be combined with the backup_select_resources role to back up a selection of resources.

Requirements

AWS User Account with the following permission:

  • backup:CreateBackupVault
  • backup:CreateBackupPlan
  • backup:DescribeBackupVault
  • backup:ListBackupPlans
  • backup:ListTags
  • backup-storage:MountCapsule
  • kms:CreateGrant
  • kms:GenerateDataKey
  • kms:Decrypt
  • kms:RetireGrant
  • kms:DescribeKey

Role Variables

  • backup_create_plan_plan_name: (Required) The name of the backup plan you want to create
  • backup_create_plan_plan_rules: (Required) A set of rules for the backup, as a list of dicts
  • backup_create_plan_plan_windows_vss_settings: Optional settings for Windows VSS backup, see AdvancedBackupSetting object in the AWS Backup API documentation for details
  • backup_create_plan_plan_tags: Optional tags to apply to all backups created with the plan
  • backup_create_plan_vault_name: The name of the vault you want to use or create. If not provided, the role will use (and create if needed) the AWS default vault for the account, named Default.
  • backup_create_plan_vault_encryption_key_arn: Optional ARN of key to use for vault encryption
  • backup_create_plan_vault_tags: Optional tags to apply to the vault

Included sample plan rules variables

These are included in vars/main.yaml for use as-is or as examples for modification.

  • backup_create_plan_hourly_backup: Rules specifying hourly continous backup at :15 UTC with 7-day retention
  • backup_create_plan_daily_backup: Rules specifying daily backup at 5am UTC with Amazon defaults for all other settings
  • backup_create_plan_weekly_backup: Rules specifying weekly backup on Mondays at 5am UTC with 90 day retention after quick transition to cold storage
  • backup_create_plan_monthly_backup: Rules specifying monthly backup at 5am UTC on 1st of month with copy to additional vault (requires an additional variable copy_vault_name be set with the name of the vault to copy to)

Dependencies

Example Playbook

- hosts: localhost
  roles:
    - role: cloud.aws_ops.backup_create_plan
      vars:
        backup_create_plan_plan_name: my-backup-plan
        backup_create_plan_plan_rules:
          - "{{ daily_backup }}"

License

GNU General Public License v3.0 or later

See LICENSE to see the full text.

Author Information

  • Ansible Cloud Content Team