Rename MSK modules (ansible-collections#1311)

Rename MSK modules SUMMARY In line with the naming guidelines, drop the aws_ prefix from the MSK modules ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_msk_cluster.py plugins/modules/msk_cluster.py plugins/modules/aws_msk_config.py plugins/modules/msk_config.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None> Reviewed-by: Markus Bergholz <[email protected]>
abikouo · Jul 5, 2022 · c6936e8 · c6936e8
1 parent 3043bca
commit c6936e8
Show file tree

Hide file tree

Showing 20 changed files with 43 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -48,8 +48,6 @@ Name | Description
 [community.aws.autoscaling_scheduled_action](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_scheduled_action_module.rst)|Create, modify and delete ASG scheduled scaling actions
 [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_inspector_target](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_inspector_target_module.rst)|Create, Update and Delete Amazon Inspector Assessment Targets
-[community.aws.aws_msk_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_cluster_module.rst)|Manage Amazon MSK clusters
-[community.aws.aws_msk_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_config_module.rst)|Manage Amazon MSK cluster configurations.
 [community.aws.aws_region_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_region_info_module.rst)|Gather information about AWS regions.
 [community.aws.aws_secret](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_secret_module.rst)|Manage secrets stored in AWS Secrets Manager
 [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
@@ -166,6 +164,8 @@ Name | Description
 [community.aws.lambda_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.lambda_info_module.rst)|Gathers AWS Lambda function details
 [community.aws.lambda_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.lambda_policy_module.rst)|Creates, updates or deletes AWS Lambda policy statements.
 [community.aws.lightsail](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.lightsail_module.rst)|Manage instances in AWS Lightsail
+[community.aws.msk_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.msk_cluster_module.rst)|Manage Amazon MSK clusters
+[community.aws.msk_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.msk_config_module.rst)|Manage Amazon MSK cluster configurations
 [community.aws.networkfirewall](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.networkfirewall_module.rst)|manage AWS Network Firewall firewalls
 [community.aws.networkfirewall_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.networkfirewall_info_module.rst)|describe AWS Network Firewall firewalls
 [community.aws.networkfirewall_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.networkfirewall_policy_module.rst)|manage AWS Network Firewall policies

diff --git a/changelogs/fragments/1311-rename-msk.yml b/changelogs/fragments/1311-rename-msk.yml
@@ -0,0 +1,3 @@
+minor_changes:
+- aws_msk_cluster - the ``aws_msk_cluster`` module has been renamed to ``msk_cluster``, ``aws_msk_cluster`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1311).
+- aws_msk_config - the ``aws_msk_config`` module has been renamed to ``msk_config``, ``aws_msk_config`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1311).
diff --git a/.../community.aws.aws_msk_cluster_module.rst → docs/community.aws.msk_cluster_module.rst b/.../community.aws.aws_msk_cluster_module.rst → docs/community.aws.msk_cluster_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_msk_cluster_module:
+.. _community.aws.msk_cluster_module:
 
 
-*****************************
-community.aws.aws_msk_cluster
-*****************************
+*************************
+community.aws.msk_cluster
+*************************
 
 **Manage Amazon MSK clusters**
 
@@ -18,6 +18,7 @@ Version added: 2.0.0
 Synopsis
 --------
 - Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) clusters.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_msk_cluster``. The usage did not change.
 
 
 
@@ -842,7 +843,6 @@ Parameters
                         <div>The version of Apache Kafka.</div>
                         <div>This version should exist in given configuration.</div>
                         <div>This parameter is required when <em>state=present</em>.</div>
-                        <div>Update operation requires botocore version &gt;= 1.16.19.</div>
                 </td>
             </tr>
             <tr>
@@ -903,7 +903,7 @@ Examples
 
     # Note: These examples do not set authentication details, see the AWS Guide for details.
 
-    - aws_msk_cluster:
+    - msk_cluster:
         name: kafka-cluster
         state: present
         version: 2.6.1
@@ -918,7 +918,7 @@ Examples
         configuration_arn: arn:aws:kafka:us-east-1:000000000001:configuration/kafka-cluster-configuration/aaaaaaaa-bbbb-4444-3333-ccccccccc-1
         configuration_revision: 1
 
-    - aws_msk_cluster:
+    - msk_cluster:
         name: kafka-cluster
         state: absent
 

diff --git a/docs/community.aws.aws_msk_config_module.rst → docs/community.aws.msk_config_module.rst b/docs/community.aws.aws_msk_config_module.rst → docs/community.aws.msk_config_module.rst
@@ -1,11 +1,11 @@
-.. _community.aws.aws_msk_config_module:
+.. _community.aws.msk_config_module:
 
 
-****************************
-community.aws.aws_msk_config
-****************************
+************************
+community.aws.msk_config
+************************
 
-**Manage Amazon MSK cluster configurations.**
+**Manage Amazon MSK cluster configurations**
 
 
 Version added: 2.0.0
@@ -18,6 +18,7 @@ Version added: 2.0.0
 Synopsis
 --------
 - Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) cluster configurations.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_msk_config``. The usage did not change.
 
 
 
@@ -315,7 +316,7 @@ Examples
 
     # Note: These examples do not set authentication details, see the AWS Guide for details.
 
-    - aws_msk_config:
+    - msk_config:
         name: kafka-cluster-configuration
         state: present
         kafka_versions:
@@ -327,7 +328,7 @@ Examples
           default.replication.factor: 3
           zookeeper.session.timeout.ms: 18000
 
-    - aws_msk_config:
+    - msk_config:
         name: kafka-cluster-configuration
         state: absent
 

diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -190,6 +190,8 @@ action_groups:
   - lambda_policy
   - lightsail
   - lightsail_static_ip
+  - msk_cluster
+  - msk_config
   - networkfirewall
   - networkfirewall_info
   - networkfirewall_policy
@@ -333,6 +335,12 @@ plugin_routing:
     aws_kms_info:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.kms_key_info
+    aws_msk_cluster:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.msk_cluster
+    aws_msk_config:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.msk_config
     aws_s3_bucket_info:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.s3_bucket_info

diff --git a/plugins/modules/aws_msk_cluster.py → plugins/modules/msk_cluster.py b/plugins/modules/aws_msk_cluster.py → plugins/modules/msk_cluster.py
@@ -9,11 +9,13 @@
 
 DOCUMENTATION = r"""
 ---
-module: aws_msk_cluster
+module: msk_cluster
 short_description: Manage Amazon MSK clusters
 version_added: "2.0.0"
 description:
     - Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) clusters.
+    - Prior to release 5.0.0 this module was called C(community.aws.aws_msk_cluster).
+      The usage did not change.
 author:
     - Daniil Kupchenko (@oukooveu)
 options:
@@ -31,7 +33,6 @@
             - The version of Apache Kafka.
             - This version should exist in given configuration.
             - This parameter is required when I(state=present).
-            - Update operation requires botocore version >= 1.16.19.
         type: str
     configuration_arn:
         description:
@@ -212,7 +213,7 @@
 EXAMPLES = r"""
 # Note: These examples do not set authentication details, see the AWS Guide for details.
 
-- aws_msk_cluster:
+- community.aws.msk_cluster:
     name: kafka-cluster
     state: present
     version: 2.6.1
@@ -227,7 +228,7 @@
     configuration_arn: arn:aws:kafka:us-east-1:000000000001:configuration/kafka-cluster-configuration/aaaaaaaa-bbbb-4444-3333-ccccccccc-1
     configuration_revision: 1
 
-- aws_msk_cluster:
+- community.aws.msk_cluster:
     name: kafka-cluster
     state: absent
 """

diff --git a/plugins/modules/aws_msk_config.py → plugins/modules/msk_config.py b/plugins/modules/aws_msk_config.py → plugins/modules/msk_config.py
@@ -9,11 +9,13 @@
 
 DOCUMENTATION = r"""
 ---
-module: aws_msk_config
-short_description: Manage Amazon MSK cluster configurations.
+module: msk_config
+short_description: Manage Amazon MSK cluster configurations
 version_added: "2.0.0"
 description:
     - Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) cluster configurations.
+    - Prior to release 5.0.0 this module was called C(community.aws.aws_msk_config).
+      The usage did not change.
 author:
     - Daniil Kupchenko (@oukooveu)
 options:
@@ -47,7 +49,7 @@
 EXAMPLES = r"""
 # Note: These examples do not set authentication details, see the AWS Guide for details.
 
-- aws_msk_config:
+- community.aws.msk_config:
     name: kafka-cluster-configuration
     state: present
     kafka_versions:
@@ -59,7 +61,7 @@
       default.replication.factor: 3
       zookeeper.session.timeout.ms: 18000
 
-- aws_msk_config:
+- community.aws.msk_config:
     name: kafka-cluster-configuration
     state: absent
 """

diff --git a/tests/integration/targets/aws_msk_cluster/aliases b/tests/integration/targets/aws_msk_cluster/aliases
diff --git a/tests/integration/targets/aws_msk_config/aliases b/tests/integration/targets/aws_msk_config/aliases
diff --git a/tests/integration/targets/msk_cluster/aliases b/tests/integration/targets/msk_cluster/aliases
@@ -0,0 +1 @@
+cloud/aws
diff --git a/...targets/aws_msk_cluster/defaults/main.yml → ...ion/targets/msk_cluster/defaults/main.yml b/...targets/aws_msk_cluster/defaults/main.yml → ...ion/targets/msk_cluster/defaults/main.yml
@@ -6,7 +6,7 @@ vpc_subnets:
   - '10.{{ 256 | random(seed=resource_prefix) }}.101.0/24'
 vpc_subnet_name_prefix: "{{ resource_prefix }}"
 
-msk_config_name: "{{ resource_prefix }}-config"
+msk_config_name: "{{ resource_prefix }}-msk-cluster"
 msk_cluster_name: "{{ tiny_prefix }}-msk-cluster"
 msk_version: 2.6.0
 msk_broker_nodes: 2

diff --git a/...ion/targets/aws_msk_cluster/meta/main.yml → ...gration/targets/msk_cluster/meta/main.yml b/...ion/targets/aws_msk_cluster/meta/main.yml → ...gration/targets/msk_cluster/meta/main.yml
diff --git a/...on/targets/aws_msk_cluster/tasks/main.yml → ...ration/targets/msk_cluster/tasks/main.yml b/...on/targets/aws_msk_cluster/tasks/main.yml → ...ration/targets/msk_cluster/tasks/main.yml
diff --git a/...ets/aws_msk_cluster/tasks/test_create.yml → ...targets/msk_cluster/tasks/test_create.yml b/...ets/aws_msk_cluster/tasks/test_create.yml → ...targets/msk_cluster/tasks/test_create.yml
diff --git a/...ets/aws_msk_cluster/tasks/test_delete.yml → ...targets/msk_cluster/tasks/test_delete.yml b/...ets/aws_msk_cluster/tasks/test_delete.yml → ...targets/msk_cluster/tasks/test_delete.yml
diff --git a/...ets/aws_msk_cluster/tasks/test_update.yml → ...targets/msk_cluster/tasks/test_update.yml b/...ets/aws_msk_cluster/tasks/test_update.yml → ...targets/msk_cluster/tasks/test_update.yml
diff --git a/tests/integration/targets/msk_config/aliases b/tests/integration/targets/msk_config/aliases
@@ -0,0 +1 @@
+cloud/aws
diff --git a/.../targets/aws_msk_config/defaults/main.yml → ...tion/targets/msk_config/defaults/main.yml b/.../targets/aws_msk_config/defaults/main.yml → ...tion/targets/msk_config/defaults/main.yml
@@ -1,5 +1,5 @@
 ---
-msk_config_name: "{{ resource_prefix }}-config"
+msk_config_name: "{{ resource_prefix }}-msk-config"
 msk_configs:
   - auto.create.topics.enable: true
     zookeeper.session.timeout.ms: 18000

diff --git a/...tion/targets/aws_msk_config/meta/main.yml → ...egration/targets/msk_config/meta/main.yml b/...tion/targets/aws_msk_config/meta/main.yml → ...egration/targets/msk_config/meta/main.yml
diff --git a/...ion/targets/aws_msk_config/tasks/main.yml → ...gration/targets/msk_config/tasks/main.yml b/...ion/targets/aws_msk_config/tasks/main.yml → ...gration/targets/msk_config/tasks/main.yml