Update links in the README #111

GomathiselviS · 2024-04-22T18:18:21Z

This PR corrects some of the incorrect links and updates all links to relative ones.

mandar242 · 2024-04-22T20:57:12Z

README.md

+[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.


Suggested change

[cloud.backup_select_resources](roles/backup_create_plan/README.md)|A role to select resources to back up with an existing backup plan.

[cloud.backup_select_resources](roles/backup_select_resources/README.md)|A role to select resources to back up with an existing backup plan.

Suggested change

[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.backup_select_resources](roles/backup_create_plan/README.md)|A role to select resources to back up with an existing backup plan.

hakbailey · 2024-04-23T00:37:11Z

README.md

+[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.


Suggested change

[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.backup_select_resources](roles/backup_create_plan/README.md)|A role to select resources to back up with an existing backup plan.

hakbailey · 2024-04-23T00:37:37Z

README.md

+[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.


Suggested change

[cloud.backup_create_plan](roles/backup_create_plan/README.md)|A role to create an AWS backup plan.

[cloud.aws_ops.backup_create_plan](roles/backup_create_plan/README.md)|A role to create an AWS backup plan.

hakbailey · 2024-04-23T00:40:13Z

README.md

+[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.


Suggested change

[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.move_objects_between_buckets](roles/move_objects_between_buckets/README.md)|A role to move objects from one bucket to another bucket.

hakbailey · 2024-04-23T00:44:06Z

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)


Suggested change

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)

Playbooks to restore canceled or deleted cloudtrail resources, intended for use with the EDA [aws_manage_cloudtrail_encryption rulebook](../extensions/eda/AWS_MANAGE_CLOUDTRAIL_ENCRYPTION.md)

hakbailey · 2024-04-23T01:09:51Z

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.


Suggested change

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.

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/README.md#Requirements), respectively.

hakbailey · 2024-04-23T01:10:31Z

playbooks/move_vm_from_on_prem_to_aws/README.md



 ## 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).


Suggested change

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).

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/README.md#Role-Variables).

hakbailey · 2024-04-23T01:11:54Z

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.


Suggested change

See [LICENCE](../../LICENSE) to see the full text.

See [LICENSE](../../LICENSE) to see the full text.

There are a bunch more cases of this typo below that we should probably update.

alinabuzachis · 2024-04-23T16:00:48Z

Unrelated to this PR, but the integration tests fail with:

fatal: [testhost]: FAILED! => {
    "msg": "The task includes an option with an undefined variable. The error was: 'dict object' has no attribute 'arn'\n\nThe error appears to be in '/home/runner/collections/ansible_collections/cloud/aws_ops/roles/backup_select_resources/tasks/main.yaml': line 54, column 7, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n\n    - name: Set backup role ARN\n      ^ here\n"
}

Would you like to have a look in this PR @GomathiselviS? The fix may be trivial.

GomathiselviS · 2024-04-24T20:26:54Z

Unrelated to this PR, but the integration tests fail with:

fatal: [testhost]: FAILED! => {
    "msg": "The task includes an option with an undefined variable. The error was: 'dict object' has no attribute 'arn'\n\nThe error appears to be in '/home/runner/collections/ansible_collections/cloud/aws_ops/roles/backup_select_resources/tasks/main.yaml': line 54, column 7, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n\n    - name: Set backup role ARN\n      ^ here\n"
}

Would you like to have a look in this PR @GomathiselviS? The fix may be trivial.

I will work on this in a separate PR. Thank you for pointing out the failure.

I am dismissing the change request because I have addressed the review comments and got 2 approvals.

github-actions bot added the safe to test label Apr 22, 2024

GomathiselviS requested review from hakbailey and alinabuzachis April 22, 2024 18:50

mandar242 reviewed Apr 22, 2024

View reviewed changes

mandar242 approved these changes Apr 22, 2024

View reviewed changes

hakbailey previously requested changes Apr 23, 2024

View reviewed changes

GomathiselviS requested a review from hakbailey April 23, 2024 14:37

alinabuzachis approved these changes Apr 23, 2024

View reviewed changes

GomathiselviS added 4 commits April 26, 2024 08:32

Fix doc link

7d46965

fix eda link

c3484e5

Add changelog

a69135f

Fix more incorrect links and typo

b2e0012

GomathiselviS force-pushed the doc_fix branch from 85c8128 to b2e0012 Compare April 26, 2024 15:32

GomathiselviS merged commit b193b26 into redhat-cop:main Apr 26, 2024
21 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update links in the README #111

Update links in the README #111

GomathiselviS commented Apr 22, 2024

mandar242 Apr 22, 2024

hakbailey Apr 23, 2024

hakbailey Apr 23, 2024

hakbailey Apr 23, 2024

hakbailey Apr 23, 2024

hakbailey Apr 23, 2024

hakbailey Apr 23, 2024

hakbailey Apr 23, 2024

hakbailey Apr 23, 2024

hakbailey Apr 23, 2024

alinabuzachis commented Apr 23, 2024 •

edited

Loading

GomathiselviS commented Apr 24, 2024

	[cloud.backup_select_resources](roles/backup_create_plan/README.md)\|A role to select resources to back up with an existing backup plan.
	[cloud.backup_select_resources](roles/backup_select_resources/README.md)\|A role to select resources to back up with an existing 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.backup_select_resources](roles/backup_create_plan/README.md)\|A role to select resources to back up with an existing backup plan.

	[cloud.backup_create_plan](roles/backup_create_plan/README.md)\|A role to create an AWS backup plan.
	[cloud.aws_ops.backup_create_plan](roles/backup_create_plan/README.md)\|A role to create an AWS backup plan.

	[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.move_objects_between_buckets](roles/move_objects_between_buckets/README.md)\|A role to move objects from one bucket to another bucket.

	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)
	Playbooks to restore canceled or deleted cloudtrail resources, intended for use with the EDA [aws_manage_cloudtrail_encryption rulebook](../extensions/eda/AWS_MANAGE_CLOUDTRAIL_ENCRYPTION.md)

	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).
	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/README.md#Role-Variables).

	See [LICENCE](../../LICENSE) to see the full text.
	See [LICENSE](../../LICENSE) to see the full text.

Update links in the README #111

Update links in the README #111

Conversation

GomathiselviS commented Apr 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alinabuzachis commented Apr 23, 2024 • edited Loading

GomathiselviS commented Apr 24, 2024

alinabuzachis commented Apr 23, 2024 •

edited

Loading