From 7d469654dbe4ebe079717cadfa7c652e8f124968 Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Mon, 22 Apr 2024 14:15:21 -0400 Subject: [PATCH] Fix doc link --- README.md | 44 +++++++++---------- playbooks/README.md | 8 ++-- .../move_vm_from_on_prem_to_aws/README.md | 4 +- playbooks/webapp/README.md | 2 +- .../README.md | 2 +- .../README.md | 4 +- roles/backup_create_plan/README.md | 2 +- roles/backup_select_resources/README.md | 2 +- roles/clone_on_prem_vm/README.md | 2 +- roles/create_rds_global_cluster/README.md | 8 ++++ roles/customized_ami/README.md | 6 +++ roles/deploy_flask_app/README.md | 2 +- roles/ec2_instance_terminate_by_tag/README.md | 4 +- .../README.md | 2 +- .../README.md | 2 +- roles/manage_transit_gateway/README.md | 2 +- roles/manage_vpc_peering/README.md | 2 +- roles/move_objects_between_buckets/README.md | 2 +- 18 files changed, 57 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index cd708fba..1ed537b8 100644 --- a/README.md +++ b/README.md @@ -17,35 +17,35 @@ Click on the name of a role, playbook, or rulebook to view that content's docume ### Roles 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. -[cloud.aws_ops.manage_vpc_peering](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/manage_vpc_peering/README.md)|A role to create, delete and accept existing VPC peering connections. -[cloud.aws_ops.moving_objects_between_buckets](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/moving_objects_between_buckets/README.md)|A role to move objects from one bucket to another bucket. -[cloud.aws_ops.awsconfig_apigateway_with_lambda_integration](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/awsconfig_apigateway_with_lambda_integration/README.md)|A role to create/delete an API gateway with lambda function integration. -[cloud.aws_ops.manage_transit_gateway](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/manage_transit_gateway/README.md)|A role to create/delete transit_gateway with vpc and vpn attachments. -[cloud.aws_ops.deploy_flask_app](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/deploy_flask_app/README.md)|A role to deploy a flask web application on AWS. -[cloud.aws_ops.create_rds_global_cluster](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/create_rds_global_cluster/README.md)|A role to create, delete aurora global cluster with a primary cluster and a replica cluster in different regions. -[cloud.aws_ops.clone_on_prem_vm](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/clone_on_prem_vm/README.md)|A role to clone an existing on prem VM using the KVM hypervisor. -[cloud.aws_ops.import_image_and_run_aws_instance](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/import_image_and_run_aws_instance/README.md)|A role that imports a local .raw image into an Amazon Machine Image (AMI) and run an AWS EC2 instance. +[cloud.aws_ops.aws_setup_credentials](roles/aws_setup_credentials/README.md)|A role to define credentials for aws modules. +[cloud.aws_ops.awsconfig_detach_and_delete_internet_gateway](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](roles/awsconfig_multiregion_cloudtrail/README.md)|A role to create/delete a Trail for multiple regions. +[cloud.backup_create_plan](roles/backup_create_plan/README.md)|A role to create an AWS backup plan. +[cloud.backup_select_resources](roles/backup_create_plan/README.md)|A role to select resources to back up with an existing backup plan. +[cloud.aws_ops.customized_ami](roles/customized_ami/README.md)|A role to manage custom AMIs on AWS. +[cloud.aws_ops.ec2_instance_terminate_by_tag](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](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. +[cloud.aws_ops.manage_vpc_peering](roles/manage_vpc_peering/README.md)|A role to create, delete and accept existing VPC peering connections. +[cloud.aws_ops.moving_objects_between_buckets](roles/moving_objects_between_buckets/README.md)|A role to move objects from one bucket to another bucket. +[cloud.aws_ops.awsconfig_apigateway_with_lambda_integration](roles/awsconfig_apigateway_with_lambda_integration/README.md)|A role to create/delete an API gateway with lambda function integration. +[cloud.aws_ops.manage_transit_gateway](roles/manage_transit_gateway/README.md)|A role to create/delete transit_gateway with vpc and vpn attachments. +[cloud.aws_ops.deploy_flask_app](roles/deploy_flask_app/README.md)|A role to deploy a flask web application on AWS. +[cloud.aws_ops.create_rds_global_cluster](roles/create_rds_global_cluster/README.md)|A role to create, delete aurora global cluster with a primary cluster and a replica cluster in different regions. +[cloud.aws_ops.clone_on_prem_vm](roles/clone_on_prem_vm/README.md)|A role to clone an existing on prem VM using the KVM hypervisor. +[cloud.aws_ops.import_image_and_run_aws_instance](roles/import_image_and_run_aws_instance/README.md)|A role that imports a local .raw image into an Amazon Machine Image (AMI) and run an AWS EC2 instance. ### Playbooks Name | Description --- | --- -[cloud.aws_ops.eda](https://github.com/ansible-collections/cloud.aws_ops/blob/main/playbooks/README.md)|A set of playbooks to restore AWS Cloudtrail configurations, created for use with the [cloud.aws_manage_cloudtrail_encryption rulebook](https://github.com/ansible-collections/cloud.aws_ops/blob/main/extensions/eda/rulebooks/AWS_MANAGE_CLOUDTRAIL_ENCRYPTION.md). -[cloud.aws_ops.webapp](https://github.com/ansible-collections/cloud.aws_ops/blob/main/playbooks/webapp/README.md)|A set of playbooks to create, delete, or migrate a webapp on AWS. -[cloud.aws_ops.upload_file_to_s3](https://github.com/ansible-collections/cloud.aws_ops/blob/main/playbooks/UPLOAD_FILE_TO_S3.md)|A playbook to upload a local file to S3. -[cloud.aws_ops.move_vm_from_on_prem_to_aws](https://github.com/ansible-collections/cloud.aws_ops/blob/main/playbooks/move_vm_from_on_prem_to_aws/README.md)|A playbook to migrate an existing on prem VM running on KVM hypervisor to AWS. +[cloud.aws_ops.eda](playbooks/README.md)|A set of playbooks to restore AWS Cloudtrail configurations, created for use with the [cloud.aws_manage_cloudtrail_encryption rulebook](extensions/eda/rulebooks/AWS_MANAGE_CLOUDTRAIL_ENCRYPTION.md). +[cloud.aws_ops.webapp](playbooks/webapp/README.md)|A set of playbooks to create, delete, or migrate a webapp on AWS. +[cloud.aws_ops.upload_file_to_s3](playbooks/UPLOAD_FILE_TO_S3.md)|A playbook to upload a local file to S3. +[cloud.aws_ops.move_vm_from_on_prem_to_aws](playbooks/move_vm_from_on_prem_to_aws/README.md)|A playbook to migrate an existing on prem VM running on KVM hypervisor to AWS. ### Rulebooks Name | Description --- | --- -[cloud.aws_ops.aws_manage_cloudtrail_encryption](https://github.com/ansible-collections/cloud.aws_ops/blob/main/extensions/eda/rulebooks/AWS_MANAGE_CLOUDTRAIL_ENCRYPTION.md)|An Event-Driven Ansible rulebook to ensure that an existing encrypted AWS Cloudtrail trail will not be deleted or have its encryption removed. +[cloud.aws_ops.aws_manage_cloudtrail_encryption](extensions/eda/rulebooks/AWS_MANAGE_CLOUDTRAIL_ENCRYPTION.md)|An Event-Driven Ansible rulebook to ensure that an existing encrypted AWS Cloudtrail trail will not be deleted or have its encryption removed. ## Installation and Usage @@ -134,4 +134,4 @@ This collection is tested using GitHub Actions. To know more about CI, refer to GNU General Public License v3.0 or later -See [LICENSE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENSE](LICENSE) to see the full text. diff --git a/playbooks/README.md b/playbooks/README.md index f548a9ea..477804d9 100644 --- a/playbooks/README.md +++ b/playbooks/README.md @@ -2,12 +2,12 @@ ## EDA playbooks -Playbooks to restore canceled or deleted cloudtrail resources, intended for use with the EDA [aws_manage_cloudtrail_encryption rulebook](https://github.com/ansible-collections/cloud.aws_ops/blob/main/extensions/eda/rulebooks/AWS_MANAGE_CLOUDTRAIL_ENCRYPTION.md) +Playbooks to restore canceled or deleted cloudtrail resources, intended for use with the EDA [aws_manage_cloudtrail_encryption rulebook](../extensions/eda/rulebooks/AWS_MANAGE_CLOUDTRAIL_ENCRYPTION.md) -* **aws_restore_cloudtrail_encryption**: Playbook to restore encryption to an existing AWS Cloudtrail trail using the [enable_cloudtrail_encryption_with_kms role](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/enable_cloudtrail_encryption_with_kms/README.md). -* **aws_restore_cloudtrail**: Playbook to re-create and encrypt a deleted AWS Cloudtrail trail using the [awsconfig_multiregion_cloudtrail](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/awsconfig_multiregion_cloudtrail/README.md) and [enable_cloudtrail_encryption_with_kms](https://github.com/ansible-collections/cloud.aws_ops/blob/main/roles/enable_cloudtrail_encryption_with_kms/README.md) roles. +* **aws_restore_cloudtrail_encryption**: Playbook to restore encryption to an existing AWS Cloudtrail trail using the [enable_cloudtrail_encryption_with_kms role](../roles/enable_cloudtrail_encryption_with_kms/README.md). +* **aws_restore_cloudtrail**: Playbook to re-create and encrypt a deleted AWS Cloudtrail trail using the [awsconfig_multiregion_cloudtrail](../roles/awsconfig_multiregion_cloudtrail/README.md) and [enable_cloudtrail_encryption_with_kms](../roles/enable_cloudtrail_encryption_with_kms/README.md) roles. * **aws_restore_kms_key**: Playbook to cancel deletion of a KMS key and re-enable it. ## Webapp playbooks -Playbooks to create, delete, or migrate a webapp on AWS. See [webapp playbooks README](https://github.com/ansible-collections/cloud.aws_ops/blob/main/playbooks/webapp/README.md) for details and usage. +Playbooks to create, delete, or migrate a webapp on AWS. See [webapp playbooks README](webapp/README.md) for details and usage. diff --git a/playbooks/move_vm_from_on_prem_to_aws/README.md b/playbooks/move_vm_from_on_prem_to_aws/README.md index 57e9947a..5e81668f 100644 --- a/playbooks/move_vm_from_on_prem_to_aws/README.md +++ b/playbooks/move_vm_from_on_prem_to_aws/README.md @@ -4,12 +4,12 @@ A playbook to migrate an existing on prem VM running on KVM hypervisor to AWS. ## Requirements -This playbook uses the ``cloud.aws_ops.clone_on_prem_vm`` role to clone an existing VM on prem using the KVM hypervisor and the ``cloud.aws_ops.import_image_and_run_aws_instance`` role to import a local .raw image into an Amazon machine image (AMI) and run an AWS EC2 instance. For a complete list of requirements, see [clone_on_prem_vm](../clone_on_prem_vm/README.md#Requirements) and [import_image_and_run_aws_instance](../roles/import_image_and_run_aws_instance/REAME.md#Requirements), respectively. +This playbook uses the ``cloud.aws_ops.clone_on_prem_vm`` role to clone an existing VM on prem using the KVM hypervisor and the ``cloud.aws_ops.import_image_and_run_aws_instance`` role to import a local .raw image into an Amazon machine image (AMI) and run an AWS EC2 instance. For a complete list of requirements, see [clone_on_prem_vm](../../roles/clone_on_prem_vm/README.md#Requirements) and [import_image_and_run_aws_instance](../../roles/import_image_and_run_aws_instance/REAME.md#Requirements), respectively. ## Playbook Variables -For a full list of accepted variables see: [clone_on_prem_vm](../clone_on_prem_vm/README.md#Role-Variables) and respectively [import_image_and_run_aws_instance](../roles/import_image_and_run_aws_instance/REAME.md#Role-Variables). +For a full list of accepted variables see: [clone_on_prem_vm](../../roles/clone_on_prem_vm/README.md#Role-Variables) and respectively [import_image_and_run_aws_instance](../../roles/import_image_and_run_aws_instance/REAME.md#Role-Variables). ## Example Usage diff --git a/playbooks/webapp/README.md b/playbooks/webapp/README.md index 4ef00579..faff8660 100644 --- a/playbooks/webapp/README.md +++ b/playbooks/webapp/README.md @@ -147,7 +147,7 @@ To delete the webapp: `webapp_ha_aurora.yaml` playbook deploys the flask app to a cross region high availability architecture. The playbook replicates the app deployment to a second region. The backend is an Aurora global cluster. For adding the write forwarding feature, aurora-mysql can be used. Default db engine is aurora-postgresql. The app in each region is configured to access the associated Aurora cluster. In front of the two regions, route53 records are added to provide cross region DNS (failover scenario). -Along with the [above](https://github.com/redhat-cop/cloud.aws_ops/blob/main/playbooks/webapp/README.md#playbook-variables) variables, following variables are needed for this playbook: +Along with the [above](README.md#playbook-variables) variables, following variables are needed for this playbook: * **rds_instance_class** (str): DB instance class for the aurora db instances. Default: `db.r5.large` * **rds_global_cluster_name** (str): Name of the global cluster. Default: "{{ resource_prefix }}-global-cluster" diff --git a/roles/awsconfig_apigateway_with_lambda_integration/README.md b/roles/awsconfig_apigateway_with_lambda_integration/README.md index c59c3d66..cf6f6a8f 100644 --- a/roles/awsconfig_apigateway_with_lambda_integration/README.md +++ b/roles/awsconfig_apigateway_with_lambda_integration/README.md @@ -42,7 +42,7 @@ AWS User Account with permission to create API gateway, lambda function and IAM GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. ## Author Information diff --git a/roles/awsconfig_detach_and_delete_internet_gateway/README.md b/roles/awsconfig_detach_and_delete_internet_gateway/README.md index ae49cac2..5f668d07 100644 --- a/roles/awsconfig_detach_and_delete_internet_gateway/README.md +++ b/roles/awsconfig_detach_and_delete_internet_gateway/README.md @@ -35,9 +35,9 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ -- Ansible Cloud Content Team \ No newline at end of file +- Ansible Cloud Content Team diff --git a/roles/backup_create_plan/README.md b/roles/backup_create_plan/README.md index cde20ff6..c830ae7f 100644 --- a/roles/backup_create_plan/README.md +++ b/roles/backup_create_plan/README.md @@ -61,7 +61,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ diff --git a/roles/backup_select_resources/README.md b/roles/backup_select_resources/README.md index 9ca71702..0cb15ed9 100644 --- a/roles/backup_select_resources/README.md +++ b/roles/backup_select_resources/README.md @@ -81,7 +81,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ diff --git a/roles/clone_on_prem_vm/README.md b/roles/clone_on_prem_vm/README.md index 2a1da0ab..be21b800 100644 --- a/roles/clone_on_prem_vm/README.md +++ b/roles/clone_on_prem_vm/README.md @@ -69,7 +69,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ diff --git a/roles/create_rds_global_cluster/README.md b/roles/create_rds_global_cluster/README.md index fbaa88f4..15d7c072 100644 --- a/roles/create_rds_global_cluster/README.md +++ b/roles/create_rds_global_cluster/README.md @@ -104,4 +104,12 @@ Example Playbook License ------- + GNU General Public License v3.0 or later + +See [LICENCE](../../LICENSE) to see the full text. + +Author Information +------------------ + +- Ansible Cloud Content Team diff --git a/roles/customized_ami/README.md b/roles/customized_ami/README.md index 810ff52d..6f764380 100644 --- a/roles/customized_ami/README.md +++ b/roles/customized_ami/README.md @@ -56,3 +56,9 @@ License GNU General Public License v3.0 or later +See [LICENCE](../../LICENSE) to see the full text. + +Author Information +------------------ + +- Ansible Cloud Content Team diff --git a/roles/deploy_flask_app/README.md b/roles/deploy_flask_app/README.md index 2a54087a..8f1c060b 100644 --- a/roles/deploy_flask_app/README.md +++ b/roles/deploy_flask_app/README.md @@ -89,7 +89,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ diff --git a/roles/ec2_instance_terminate_by_tag/README.md b/roles/ec2_instance_terminate_by_tag/README.md index f90bcd19..878964f8 100644 --- a/roles/ec2_instance_terminate_by_tag/README.md +++ b/roles/ec2_instance_terminate_by_tag/README.md @@ -44,9 +44,9 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ -- Ansible Cloud Content Team \ No newline at end of file +- Ansible Cloud Content Team diff --git a/roles/enable_cloudtrail_encryption_with_kms/README.md b/roles/enable_cloudtrail_encryption_with_kms/README.md index 57871fdf..05db621b 100644 --- a/roles/enable_cloudtrail_encryption_with_kms/README.md +++ b/roles/enable_cloudtrail_encryption_with_kms/README.md @@ -46,7 +46,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.azure_roles/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ diff --git a/roles/import_image_and_run_aws_instance/README.md b/roles/import_image_and_run_aws_instance/README.md index e4ff6d3f..0b139e93 100644 --- a/roles/import_image_and_run_aws_instance/README.md +++ b/roles/import_image_and_run_aws_instance/README.md @@ -120,7 +120,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ diff --git a/roles/manage_transit_gateway/README.md b/roles/manage_transit_gateway/README.md index 672bc14c..f876316d 100644 --- a/roles/manage_transit_gateway/README.md +++ b/roles/manage_transit_gateway/README.md @@ -91,7 +91,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ diff --git a/roles/manage_vpc_peering/README.md b/roles/manage_vpc_peering/README.md index c7c91d85..2b7d7da1 100644 --- a/roles/manage_vpc_peering/README.md +++ b/roles/manage_vpc_peering/README.md @@ -103,7 +103,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------ diff --git a/roles/move_objects_between_buckets/README.md b/roles/move_objects_between_buckets/README.md index fbbf1893..4d466920 100644 --- a/roles/move_objects_between_buckets/README.md +++ b/roles/move_objects_between_buckets/README.md @@ -70,7 +70,7 @@ License GNU General Public License v3.0 or later -See [LICENCE](https://github.com/ansible-collections/cloud.aws_ops/blob/main/LICENSE) to see the full text. +See [LICENCE](../../LICENSE) to see the full text. Author Information ------------------