From c4fad80f2aa868d6bb86aaffe3230f5c95afe340 Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Fri, 24 Jun 2022 22:23:13 +0200 Subject: [PATCH 1/3] Rename aws_acm to acm_certificate --- README.md | 4 ++-- changelogs/fragments/1263-acm_certificate.yml | 3 +++ ... community.aws.acm_certificate_info_module.rst} | 14 +++++++------- ...st => community.aws.acm_certificate_module.rst} | 8 ++++---- meta/runtime.yml | 8 ++++++++ plugins/modules/{aws_acm.py => acm_certificate.py} | 3 +-- .../{aws_acm_info.py => acm_certificate_info.py} | 8 ++++---- .../targets/{aws_acm => acm_certificate}/aliases | 2 +- .../{aws_acm => acm_certificate}/defaults/main.yml | 0 .../{aws_acm => acm_certificate}/meta/main.yml | 0 .../tasks/full_acm_test.yml | 0 .../{aws_acm => acm_certificate}/tasks/main.yml | 0 12 files changed, 30 insertions(+), 20 deletions(-) create mode 100644 changelogs/fragments/1263-acm_certificate.yml rename docs/{community.aws.aws_acm_info_module.rst => community.aws.acm_certificate_info_module.rst} (99%) rename docs/{community.aws.aws_acm_module.rst => community.aws.acm_certificate_module.rst} (99%) rename plugins/modules/{aws_acm.py => acm_certificate.py} (99%) rename plugins/modules/{aws_acm_info.py => acm_certificate_info.py} (98%) rename tests/integration/targets/{aws_acm => acm_certificate}/aliases (77%) rename tests/integration/targets/{aws_acm => acm_certificate}/defaults/main.yml (100%) rename tests/integration/targets/{aws_acm => acm_certificate}/meta/main.yml (100%) rename tests/integration/targets/{aws_acm => acm_certificate}/tasks/full_acm_test.yml (100%) rename tests/integration/targets/{aws_acm => acm_certificate}/tasks/main.yml (100%) diff --git a/README.md b/README.md index 55aa511e596..fe5b349a91c 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ Name | Description ### Modules Name | Description --- | --- -[community.aws.aws_acm](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_acm_module.rst)|Upload and delete certificates in the AWS Certificate Manager service -[community.aws.aws_acm_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_acm_info_module.rst)|Retrieve certificate information from AWS Certificate Manager service +[community.aws.acm_certificate](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.acm_certificate_module.rst)|Upload and delete certificates in the AWS Certificate Manager service +[community.aws.acm_certificate_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.acm_certificate_info_module.rst)|Retrieve certificate information from AWS Certificate Manager service [community.aws.aws_api_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_api_gateway_module.rst)|Manage AWS API Gateway APIs [community.aws.aws_api_gateway_domain](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_api_gateway_domain_module.rst)|Manage AWS API Gateway custom domains [community.aws.aws_application_scaling_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_application_scaling_policy_module.rst)|Manage Application Auto Scaling Scaling Policies diff --git a/changelogs/fragments/1263-acm_certificate.yml b/changelogs/fragments/1263-acm_certificate.yml new file mode 100644 index 00000000000..bb16dab2258 --- /dev/null +++ b/changelogs/fragments/1263-acm_certificate.yml @@ -0,0 +1,3 @@ +minor_changes: +- aws_acm - the ``aws_acm`` module has been renamed to ``acm_certificate``, ``aws_acm`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1263). +- aws_acm_info - the ``aws_acm_info`` module has been renamed to ``acm_certificate_info``, ``aws_acm_info`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1263). diff --git a/docs/community.aws.aws_acm_info_module.rst b/docs/community.aws.acm_certificate_info_module.rst similarity index 99% rename from docs/community.aws.aws_acm_info_module.rst rename to docs/community.aws.acm_certificate_info_module.rst index 11f52f052dc..3fc76548c3a 100644 --- a/docs/community.aws.aws_acm_info_module.rst +++ b/docs/community.aws.acm_certificate_info_module.rst @@ -1,9 +1,9 @@ -.. _community.aws.aws_acm_info_module: +.. _community.aws.acm_certificate_info_module: -************************** -community.aws.aws_acm_info -************************** +********************************** +community.aws.acm_certificate_info +********************************** **Retrieve certificate information from AWS Certificate Manager service** @@ -17,7 +17,7 @@ Version added: 1.0.0 Synopsis -------- -- Retrieve information for ACM certificates +- Retrieve information for ACM certificates. - Note that this will not return information about uploaded keys of size 4096 bits, due to a limitation of the ACM API. @@ -157,7 +157,7 @@ Parameters -
The domain name of an ACM certificate to limit the search to
+
The domain name of an ACM certificate to limit the search to.

aliases: name
@@ -249,7 +249,7 @@ Parameters -
Status to filter the certificate results
+
Status to filter the certificate results.
diff --git a/docs/community.aws.aws_acm_module.rst b/docs/community.aws.acm_certificate_module.rst similarity index 99% rename from docs/community.aws.aws_acm_module.rst rename to docs/community.aws.acm_certificate_module.rst index 7b8d78ffd5d..0bdf0d3feeb 100644 --- a/docs/community.aws.aws_acm_module.rst +++ b/docs/community.aws.acm_certificate_module.rst @@ -1,9 +1,9 @@ -.. _community.aws.aws_acm_module: +.. _community.aws.acm_certificate_module: -********************* -community.aws.aws_acm -********************* +***************************** +community.aws.acm_certificate +***************************** **Upload and delete certificates in the AWS Certificate Manager service** diff --git a/meta/runtime.yml b/meta/runtime.yml index 3bdd4fe0c8c..978b2f4c2dc 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -1,6 +1,8 @@ requires_ansible: '>=2.9.10' action_groups: aws: + - acm_certificate + - acm_certificate_info - aws_acm - aws_acm_info - aws_api_gateway @@ -200,6 +202,12 @@ action_groups: - wafv2_web_acl_info plugin_routing: modules: + aws_acm: + # Deprecation for this alias should not *start* prior to 2024-09-01 + redirect: community.aws.acm_certificate + aws_acm_info: + # Deprecation for this alias should not *start* prior to 2024-09-01 + redirect: community.aws.acm_certificate_info ec2_elb: redirect: community.aws.elb_instance ec2_instance: diff --git a/plugins/modules/aws_acm.py b/plugins/modules/acm_certificate.py similarity index 99% rename from plugins/modules/aws_acm.py rename to plugins/modules/acm_certificate.py index 33c8d5fe903..90cde3636d3 100644 --- a/plugins/modules/aws_acm.py +++ b/plugins/modules/acm_certificate.py @@ -27,7 +27,7 @@ DOCUMENTATION = r''' --- -module: aws_acm +module: acm_certificate short_description: Upload and delete certificates in the AWS Certificate Manager service version_added: 1.0.0 description: @@ -176,7 +176,6 @@ - amazon.aws.aws - amazon.aws.ec2 - amazon.aws.tags.deprecated_purge - ''' EXAMPLES = ''' diff --git a/plugins/modules/aws_acm_info.py b/plugins/modules/acm_certificate_info.py similarity index 98% rename from plugins/modules/aws_acm_info.py rename to plugins/modules/acm_certificate_info.py index 8d61dde4d3c..c5604fddd0e 100644 --- a/plugins/modules/aws_acm_info.py +++ b/plugins/modules/acm_certificate_info.py @@ -7,11 +7,11 @@ DOCUMENTATION = r''' -module: aws_acm_info +module: acm_certificate_info short_description: Retrieve certificate information from AWS Certificate Manager service version_added: 1.0.0 description: - - Retrieve information for ACM certificates + - Retrieve information for ACM certificates. - Note that this will not return information about uploaded keys of size 4096 bits, due to a limitation of the ACM API. options: certificate_arn: @@ -24,13 +24,13 @@ type: str domain_name: description: - - The domain name of an ACM certificate to limit the search to + - The domain name of an ACM certificate to limit the search to. aliases: - name type: str statuses: description: - - Status to filter the certificate results + - Status to filter the certificate results. choices: ['PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED'] type: list elements: str diff --git a/tests/integration/targets/aws_acm/aliases b/tests/integration/targets/acm_certificate/aliases similarity index 77% rename from tests/integration/targets/aws_acm/aliases rename to tests/integration/targets/acm_certificate/aliases index 359ddb286c4..26ae3a05950 100644 --- a/tests/integration/targets/aws_acm/aliases +++ b/tests/integration/targets/acm_certificate/aliases @@ -3,4 +3,4 @@ cloud/aws -aws_acm_info +acm_certificate_info diff --git a/tests/integration/targets/aws_acm/defaults/main.yml b/tests/integration/targets/acm_certificate/defaults/main.yml similarity index 100% rename from tests/integration/targets/aws_acm/defaults/main.yml rename to tests/integration/targets/acm_certificate/defaults/main.yml diff --git a/tests/integration/targets/aws_acm/meta/main.yml b/tests/integration/targets/acm_certificate/meta/main.yml similarity index 100% rename from tests/integration/targets/aws_acm/meta/main.yml rename to tests/integration/targets/acm_certificate/meta/main.yml diff --git a/tests/integration/targets/aws_acm/tasks/full_acm_test.yml b/tests/integration/targets/acm_certificate/tasks/full_acm_test.yml similarity index 100% rename from tests/integration/targets/aws_acm/tasks/full_acm_test.yml rename to tests/integration/targets/acm_certificate/tasks/full_acm_test.yml diff --git a/tests/integration/targets/aws_acm/tasks/main.yml b/tests/integration/targets/acm_certificate/tasks/main.yml similarity index 100% rename from tests/integration/targets/aws_acm/tasks/main.yml rename to tests/integration/targets/acm_certificate/tasks/main.yml From df6ef0ac40bbeaba87d494a6ba818209e0351954 Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Sat, 25 Jun 2022 11:41:14 +0200 Subject: [PATCH 2/3] Update unit tests --- .../modules/{test_aws_acm.py => test_acm_certificate.py} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename tests/unit/plugins/modules/{test_aws_acm.py => test_acm_certificate.py} (96%) diff --git a/tests/unit/plugins/modules/test_aws_acm.py b/tests/unit/plugins/modules/test_acm_certificate.py similarity index 96% rename from tests/unit/plugins/modules/test_aws_acm.py rename to tests/unit/plugins/modules/test_acm_certificate.py index 5b0f86abf15..81fe59c53a8 100644 --- a/tests/unit/plugins/modules/test_aws_acm.py +++ b/tests/unit/plugins/modules/test_acm_certificate.py @@ -20,8 +20,8 @@ from pprint import pprint -from ansible_collections.community.aws.plugins.modules.aws_acm import chain_compare -from ansible_collections.community.aws.plugins.modules.aws_acm import pem_chain_split +from ansible_collections.community.aws.plugins.modules.acm_certificate import chain_compare +from ansible_collections.community.aws.plugins.modules.acm_certificate import pem_chain_split from ansible.module_utils._text import to_text From 7891edd5cc493877685c6adf88995cc9f7ef2077 Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Sat, 25 Jun 2022 12:27:21 +0200 Subject: [PATCH 3/3] add note about rename --- plugins/modules/acm_certificate.py | 2 ++ plugins/modules/acm_certificate_info.py | 2 ++ 2 files changed, 4 insertions(+) diff --git a/plugins/modules/acm_certificate.py b/plugins/modules/acm_certificate.py index 90cde3636d3..6b48579d5bc 100644 --- a/plugins/modules/acm_certificate.py +++ b/plugins/modules/acm_certificate.py @@ -74,6 +74,8 @@ - > Note that this may not work properly with keys of size 4096 bits, due to a limitation of the ACM API. + - Prior to release 5.0.0 this module was called C(community.aws.aws_acm). + The usage did not change. options: certificate: description: diff --git a/plugins/modules/acm_certificate_info.py b/plugins/modules/acm_certificate_info.py index c5604fddd0e..8e16162cedb 100644 --- a/plugins/modules/acm_certificate_info.py +++ b/plugins/modules/acm_certificate_info.py @@ -13,6 +13,8 @@ description: - Retrieve information for ACM certificates. - Note that this will not return information about uploaded keys of size 4096 bits, due to a limitation of the ACM API. + - Prior to release 5.0.0 this module was called C(community.aws.aws_acm_info). + The usage did not change. options: certificate_arn: description: