diff --git a/README.md b/README.md index 2cac6b5b..6e7dc411 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ Name | Description [cloud.aws_ops.aws_setup_credentials](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/aws_setup_credentials/README.md)|A role to define credentials for aws modules. [cloud.aws_ops.awsconfig_detach_and_delete_internet_gateway](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/awsconfig_detach_and_delete_internet_gateway/README.md)|A role to detach and delete the internet gateway you specify from virtual private cloud. [cloud.aws_ops.awsconfig_multiregion_cloudtrail](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/awsconfig_multiregion_cloudtrail/README.md)|A role to create/delete a Trail for multiple regions. +[cloud.backup_create_plan](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/backup_create_plan/README.md)|A role to create an AWS backup plan. +[cloud.backup_select_resources](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/backup_create_plan/README.md)|A role to select resources to back up with an existing backup plan. [cloud.aws_ops.customized_ami](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/customized_ami/README.md)|A role to manage custom AMIs on AWS. [cloud.aws_ops.ec2_instance_terminate_by_tag](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/ec2_instance_terminate_by_tag/README.md)|A role to terminate the EC2 instances based on a specific tag you specify. [cloud.aws_ops.enable_cloudtrail_encryption_with_kms](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/enable_cloudtrail_encryption_with_kms/README.md)|A role to encrypt an AWS CloudTrail trail using the AWS Key Management Service (AWS KMS) customer managed key you specify. diff --git a/roles/backup_select_resources/README.md b/roles/backup_select_resources/README.md index d4f9bb62..0fe73045 100644 --- a/roles/backup_select_resources/README.md +++ b/roles/backup_select_resources/README.md @@ -1,7 +1,7 @@ backup_select_resources ================== -A role to configure backups for selected resources. The role requires an existing backup vault and plan, and adds selected resources to the provided plan. A set of variables for resource selections is included for use as-is or as examples for modification. This role can be combined with the backup_plan_create role to create or update a backup plan if one does not already exist. +A role to configure backups for selected resources. The role requires an existing backup vault and plan, and adds selected resources to the provided plan. A set of variables for resource selections is included for use as-is or as examples for modification. This role can be combined with the `backup_create_plan` role to create or update a backup plan if one does not already exist. (see [example playbook](#create-backup-plan-and-select-resources)). Requirements ------------ @@ -40,14 +40,32 @@ Dependencies * role: [aws_setup_credentials](../aws_setup_credentials/README.md) -Example Playbook +Example Playbooks ---------------- +### Select resources - hosts: localhost roles: - role: cloud.aws_ops.backup_select_resources vars: - plan_name: daily-backup + plan_name: my-backup-plan + selection_name: s3_buckets + selection_resources: + - "{{ all_s3_buckets }}" + +### Create backup plan and select resources + + - hosts: localhost + roles: + - role: cloud.aws_ops.backup_create_plan + plan_name: my-backup-plan + plan_rules: "{{ daily_backup }}" + + - hosts: localhost + roles: + - role: cloud.aws_ops.backup_select_resources + vars: + plan_name: my-backup-plan selection_name: s3_buckets selection_resources: - "{{ all_s3_buckets }}"