Rename batch modules (#1272)

Rename batch modules SUMMARY In line with the naming guidelines, removes the aws_ prefix from aws_batch_compute_environment, aws_batch_job_definition and aws_batch_job_queue. ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_batch_compute_environment.py plugins/modules/aws_batch_job_definition.py plugins/modules/aws_batch_job_queue.py plugins/modules/batch_compute_environment.py plugins/modules/batch_job_definition.py plugins/modules/batch_job_queue.py ADDITIONAL INFORMATION Reviewed-by: Joseph Torcasso <None>
ansible-collections · Jun 28, 2022 · 081cd7b · 081cd7b
1 parent dd8b18e
commit 081cd7b
Show file tree

Hide file tree

Showing 9 changed files with 84 additions and 71 deletions.
diff --git a/README.md b/README.md
@@ -37,9 +37,6 @@ Name | Description
 [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
-[community.aws.aws_batch_compute_environment](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_batch_compute_environment_module.rst)|Manage AWS Batch Compute Environments
-[community.aws.aws_batch_job_definition](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_batch_job_definition_module.rst)|Manage AWS Batch Job Definitions
-[community.aws.aws_batch_job_queue](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_batch_job_queue_module.rst)|Manage AWS Batch Job Queues
 [community.aws.aws_codebuild](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_codebuild_module.rst)|Create or delete an AWS CodeBuild project
 [community.aws.aws_codecommit](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_codecommit_module.rst)|Manage repositories in AWS CodeCommit
 [community.aws.aws_codepipeline](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_codepipeline_module.rst)|Create or delete AWS CodePipelines
@@ -71,6 +68,9 @@ Name | Description
 [community.aws.aws_waf_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_waf_info_module.rst)|Retrieve information for WAF ACLs, Rule , Conditions and Filters.
 [community.aws.aws_waf_rule](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_waf_rule_module.rst)|Create and delete WAF Rules
 [community.aws.aws_waf_web_acl](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_waf_web_acl_module.rst)|Create and delete WAF Web ACLs
+[community.aws.batch_compute_environment](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.batch_compute_environment_module.rst)|Manage AWS Batch Compute Environments
+[community.aws.batch_job_definition](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.batch_job_definition_module.rst)|Manage AWS Batch Job Definitions
+[community.aws.batch_job_queue](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.batch_job_queue_module.rst)|Manage AWS Batch Job Queues
 [community.aws.cloudformation_exports_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.cloudformation_exports_info_module.rst)|Read a value from CloudFormation Exports
 [community.aws.cloudformation_stack_set](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.cloudformation_stack_set_module.rst)|Manage groups of CloudFormation stacks
 [community.aws.cloudfront_distribution](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.cloudfront_distribution_module.rst)|Create, update and delete AWS CloudFront distributions

diff --git a/changelogs/fragments/1272-rename-batch.yml b/changelogs/fragments/1272-rename-batch.yml
@@ -0,0 +1,4 @@
+minor_changes:
+- aws_batch_compute_environment - the ``aws_batch_compute_environment`` module has been renamed to ``batch_compute_environment``, ``aws_batch_compute_environment`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1272).
+- aws_batch_job_definition - the ``aws_batch_job_definition`` module has been renamed to ``batch_job_definition``, ``aws_batch_job_definition`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1272).
+- aws_batch_job_queue - the ``aws_batch_job_queue`` module has been renamed to ``batch_job_queue``, ``aws_batch_job_queue`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1272).
diff --git a/....aws_batch_compute_environment_module.rst → ....aws.batch_compute_environment_module.rst b/....aws_batch_compute_environment_module.rst → ....aws.batch_compute_environment_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_batch_compute_environment_module:
+.. _community.aws.batch_compute_environment_module:
 
 
-*******************************************
-community.aws.aws_batch_compute_environment
-*******************************************
+***************************************
+community.aws.batch_compute_environment
+***************************************
 
 **Manage AWS Batch Compute Environments**
 
@@ -19,7 +19,8 @@ Synopsis
 --------
 - This module allows the management of AWS Batch Compute Environments.
 - It is idempotent and supports "Check" mode.
-- Use module :ref:`community.aws.aws_batch_compute_environment <community.aws.aws_batch_compute_environment_module>` to manage the compute environment, :ref:`community.aws.aws_batch_job_queue <community.aws.aws_batch_job_queue_module>` to manage job queues, :ref:`community.aws.aws_batch_job_definition <community.aws.aws_batch_job_definition_module>` to manage job definitions.
+- Use module :ref:`community.aws.batch_compute_environment <community.aws.batch_compute_environment_module>` to manage the compute environment, :ref:`community.aws.batch_job_queue <community.aws.batch_job_queue_module>` to manage job queues, :ref:`community.aws.batch_job_definition <community.aws.batch_job_definition_module>` to manage job definitions.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_batch_compute_environment``. The usage did not change.
 
 
 
@@ -535,7 +536,7 @@ Examples
 .. code-block:: yaml
 
     - name: My Batch Compute Environment
-      community.aws.aws_batch_compute_environment:
+      community.aws.batch_compute_environment:
         compute_environment_name: computeEnvironmentName
         state: present
         region: us-east-1

diff --git a/...y.aws.aws_batch_job_definition_module.rst → ...unity.aws.batch_job_definition_module.rst b/...y.aws.aws_batch_job_definition_module.rst → ...unity.aws.batch_job_definition_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_batch_job_definition_module:
+.. _community.aws.batch_job_definition_module:
 
 
-**************************************
-community.aws.aws_batch_job_definition
-**************************************
+**********************************
+community.aws.batch_job_definition
+**********************************
 
 **Manage AWS Batch Job Definitions**
 
@@ -19,7 +19,8 @@ Synopsis
 --------
 - This module allows the management of AWS Batch Job Definitions.
 - It is idempotent and supports "Check" mode.
-- Use module :ref:`community.aws.aws_batch_compute_environment <community.aws.aws_batch_compute_environment_module>` to manage the compute environment, :ref:`community.aws.aws_batch_job_queue <community.aws.aws_batch_job_queue_module>` to manage job queues, :ref:`community.aws.aws_batch_job_definition <community.aws.aws_batch_job_definition_module>` to manage job definitions.
+- Use module :ref:`community.aws.batch_compute_environment <community.aws.batch_compute_environment_module>` to manage the compute environment, :ref:`community.aws.batch_job_queue <community.aws.batch_job_queue_module>` to manage job queues, :ref:`community.aws.batch_job_definition <community.aws.batch_job_definition_module>` to manage job definitions.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_batch_job_definition``. The usage did not change.
 
 
 
@@ -681,13 +682,8 @@ Examples
 .. code-block:: yaml
 
     ---
-    - hosts: localhost
-      gather_facts: no
-      vars:
-        state: present
-      tasks:
     - name: My Batch Job Definition
-      community.aws.aws_batch_job_definition:
+      community.aws.batch_job_definition:
         job_definition_name: My Batch Job Definition
         state: present
         type: container

diff --git a/...munity.aws.aws_batch_job_queue_module.rst → .../community.aws.batch_job_queue_module.rst b/...munity.aws.aws_batch_job_queue_module.rst → .../community.aws.batch_job_queue_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_batch_job_queue_module:
+.. _community.aws.batch_job_queue_module:
 
 
-*********************************
-community.aws.aws_batch_job_queue
-*********************************
+*****************************
+community.aws.batch_job_queue
+*****************************
 
 **Manage AWS Batch Job Queues**
 
@@ -19,7 +19,8 @@ Synopsis
 --------
 - This module allows the management of AWS Batch Job Queues.
 - It is idempotent and supports "Check" mode.
-- Use module :ref:`community.aws.aws_batch_compute_environment <community.aws.aws_batch_compute_environment_module>` to manage the compute environment, :ref:`community.aws.aws_batch_job_queue <community.aws.aws_batch_job_queue_module>` to manage job queues, :ref:`community.aws.aws_batch_job_definition <community.aws.aws_batch_job_definition_module>` to manage job definitions.
+- Use module :ref:`community.aws.batch_compute_environment <community.aws.batch_compute_environment_module>` to manage the compute environment, :ref:`community.aws.batch_job_queue <community.aws.batch_job_queue_module>` to manage job queues, :ref:`community.aws.batch_job_definition <community.aws.batch_job_definition_module>` to manage job definitions.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_batch_job_queue``. The usage did not change.
 
 
 
@@ -207,7 +208,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>The name for the job queue</div>
+                        <div>The name for the job queue.</div>
                 </td>
             </tr>
             <tr>
@@ -353,7 +354,7 @@ Examples
 .. code-block:: yaml
 
     - name: My Batch Job Queue
-      community.aws.aws_batch_job_queue:
+      community.aws.batch_job_queue:
         job_queue_name: jobQueueName
         state: present
         region: us-east-1

diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -47,6 +47,9 @@ action_groups:
   - aws_waf_info
   - aws_waf_rule
   - aws_waf_web_acl
+  - batch_compute_environment
+  - batch_job_definition
+  - batch_job_queue
   - cloudformation_exports_info
   - cloudformation_stack_set
   - cloudfront_distribution
@@ -214,6 +217,15 @@ plugin_routing:
     aws_acm_info:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.acm_certificate_info
+    aws_batch_compute_environment:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.batch_compute_environment
+    aws_batch_job_definition:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.batch_job_definition
+    aws_batch_job_queue:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.batch_job_queue
     aws_ses_identity:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.ses_identity

diff --git a/.../modules/aws_batch_compute_environment.py → plugins/modules/batch_compute_environment.py b/.../modules/aws_batch_compute_environment.py → plugins/modules/batch_compute_environment.py
@@ -8,17 +8,18 @@
 
 DOCUMENTATION = r'''
 ---
-module: aws_batch_compute_environment
+module: batch_compute_environment
 version_added: 1.0.0
 short_description: Manage AWS Batch Compute Environments
 description:
-    - This module allows the management of AWS Batch Compute Environments.
-    - It is idempotent and supports "Check" mode.
-    - Use module M(community.aws.aws_batch_compute_environment) to manage the compute
-      environment, M(community.aws.aws_batch_job_queue) to manage job queues, M(community.aws.aws_batch_job_definition) to manage job definitions.
-
-
-author: Jon Meran (@jonmer85)
+  - This module allows the management of AWS Batch Compute Environments.
+  - It is idempotent and supports "Check" mode.
+  - Use module M(community.aws.batch_compute_environment) to manage the compute
+    environment, M(community.aws.batch_job_queue) to manage job queues, M(community.aws.batch_job_definition) to manage job definitions.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_batch_compute_environment).
+    The usage did not change.
+author:
+  - Jon Meran (@jonmer85)
 options:
   compute_environment_name:
     description:
@@ -119,14 +120,13 @@
       - The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
     type: str
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-
+  - amazon.aws.aws
+  - amazon.aws.ec2
 '''
 
 EXAMPLES = r'''
 - name: My Batch Compute Environment
-  community.aws.aws_batch_compute_environment:
+  community.aws.batch_compute_environment:
     compute_environment_name: computeEnvironmentName
     state: present
     region: us-east-1

diff --git a/plugins/modules/aws_batch_job_definition.py → plugins/modules/batch_job_definition.py b/plugins/modules/aws_batch_job_definition.py → plugins/modules/batch_job_definition.py
@@ -8,15 +8,18 @@
 
 DOCUMENTATION = r'''
 ---
-module: aws_batch_job_definition
+module: batch_job_definition
 version_added: 1.0.0
 short_description: Manage AWS Batch Job Definitions
 description:
-    - This module allows the management of AWS Batch Job Definitions.
-    - It is idempotent and supports "Check" mode.
-    - Use module M(community.aws.aws_batch_compute_environment) to manage the compute
-      environment, M(community.aws.aws_batch_job_queue) to manage job queues, M(community.aws.aws_batch_job_definition) to manage job definitions.
-author: Jon Meran (@jonmer85)
+  - This module allows the management of AWS Batch Job Definitions.
+  - It is idempotent and supports "Check" mode.
+  - Use module M(community.aws.batch_compute_environment) to manage the compute
+    environment, M(community.aws.batch_job_queue) to manage job queues, M(community.aws.batch_job_definition) to manage job definitions.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_batch_job_definition).
+    The usage did not change.
+author:
+  - Jon Meran (@jonmer85)
 options:
   job_definition_arn:
     description:
@@ -171,20 +174,14 @@
         many times.
     type: int
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-
+  - amazon.aws.aws
+  - amazon.aws.ec2
 '''
 
 EXAMPLES = r'''
 ---
-- hosts: localhost
-  gather_facts: no
-  vars:
-    state: present
-  tasks:
 - name: My Batch Job Definition
-  community.aws.aws_batch_job_definition:
+  community.aws.batch_job_definition:
     job_definition_name: My Batch Job Definition
     state: present
     type: container

diff --git a/plugins/modules/aws_batch_job_queue.py → plugins/modules/batch_job_queue.py b/plugins/modules/aws_batch_job_queue.py → plugins/modules/batch_job_queue.py
@@ -8,19 +8,22 @@
 
 DOCUMENTATION = r'''
 ---
-module: aws_batch_job_queue
+module: batch_job_queue
 version_added: 1.0.0
 short_description: Manage AWS Batch Job Queues
 description:
-    - This module allows the management of AWS Batch Job Queues.
-    - It is idempotent and supports "Check" mode.
-    - Use module M(community.aws.aws_batch_compute_environment) to manage the compute
-      environment, M(community.aws.aws_batch_job_queue) to manage job queues, M(community.aws.aws_batch_job_definition) to manage job definitions.
-author: Jon Meran (@jonmer85)
+  - This module allows the management of AWS Batch Job Queues.
+  - It is idempotent and supports "Check" mode.
+  - Use module M(community.aws.batch_compute_environment) to manage the compute
+    environment, M(community.aws.batch_job_queue) to manage job queues, M(community.aws.batch_job_definition) to manage job definitions.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_batch_job_queue).
+    The usage did not change.
+author:
+  - Jon Meran (@jonmer85)
 options:
   job_queue_name:
     description:
-      - The name for the job queue
+      - The name for the job queue.
     required: true
     type: str
   state:
@@ -53,21 +56,20 @@
     type: list
     elements: dict
     suboptions:
-        order:
-            type: int
-            description: The relative priority of the environment.
-        compute_environment:
-            type: str
-            description: The name of the compute environment.
+      order:
+        type: int
+        description: The relative priority of the environment.
+      compute_environment:
+        type: str
+        description: The name of the compute environment.
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-
+  - amazon.aws.aws
+  - amazon.aws.ec2
 '''
 
 EXAMPLES = '''
 - name: My Batch Job Queue
-  community.aws.aws_batch_job_queue:
+  community.aws.batch_job_queue:
     job_queue_name: jobQueueName
     state: present
     region: us-east-1