diff --git a/README.md b/README.md
index d9b70cd7701..d14ff02de5e 100644
--- 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.aws_ssm_parameter_store](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_ssm_parameter_store_module.rst)|Manage key-value pairs in AWS SSM parameter store
@@ -169,6 +167,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
new file mode 100644
index 00000000000..20754a7afb1
--- /dev/null
+++ 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/docs/community.aws.aws_msk_cluster_module.rst b/docs/community.aws.msk_cluster_module.rst
similarity index 99%
rename from docs/community.aws.aws_msk_cluster_module.rst
rename to docs/community.aws.msk_cluster_module.rst
index f9755f9fde6..cf768186f07 100644
--- a/docs/community.aws.aws_msk_cluster_module.rst
+++ b/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
The version of Apache Kafka.
This version should exist in given configuration.
This parameter is required when state=present.
- Update operation requires botocore version >= 1.16.19.
@@ -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 b/docs/community.aws.msk_config_module.rst
similarity index 98%
rename from docs/community.aws.aws_msk_config_module.rst
rename to docs/community.aws.msk_config_module.rst
index fa94f260715..1a666f9aacb 100644
--- a/docs/community.aws.aws_msk_config_module.rst
+++ b/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
index 3e68254a388..20e68f2a998 100644
--- 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
@@ -330,6 +332,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 b/plugins/modules/msk_cluster.py
similarity index 99%
rename from plugins/modules/aws_msk_cluster.py
rename to plugins/modules/msk_cluster.py
index 559660d786f..8a1774b25ef 100644
--- a/plugins/modules/aws_msk_cluster.py
+++ b/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 b/plugins/modules/msk_config.py
similarity index 97%
rename from plugins/modules/aws_msk_config.py
rename to plugins/modules/msk_config.py
index afaea513937..0547a2a8bbd 100644
--- a/plugins/modules/aws_msk_config.py
+++ b/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
deleted file mode 100644
index 397e3536faa..00000000000
--- a/tests/integration/targets/aws_msk_cluster/aliases
+++ /dev/null
@@ -1,4 +0,0 @@
-# Needs to install recent botocore environment
-slow
-
-cloud/aws
diff --git a/tests/integration/targets/aws_msk_config/aliases b/tests/integration/targets/aws_msk_config/aliases
deleted file mode 100644
index 397e3536faa..00000000000
--- a/tests/integration/targets/aws_msk_config/aliases
+++ /dev/null
@@ -1,4 +0,0 @@
-# Needs to install recent botocore environment
-slow
-
-cloud/aws
diff --git a/tests/integration/targets/msk_cluster/aliases b/tests/integration/targets/msk_cluster/aliases
new file mode 100644
index 00000000000..4ef4b2067d0
--- /dev/null
+++ b/tests/integration/targets/msk_cluster/aliases
@@ -0,0 +1 @@
+cloud/aws
diff --git a/tests/integration/targets/aws_msk_cluster/defaults/main.yml b/tests/integration/targets/msk_cluster/defaults/main.yml
similarity index 89%
rename from tests/integration/targets/aws_msk_cluster/defaults/main.yml
rename to tests/integration/targets/msk_cluster/defaults/main.yml
index f21818507fe..d471be58ae5 100644
--- a/tests/integration/targets/aws_msk_cluster/defaults/main.yml
+++ b/tests/integration/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/tests/integration/targets/aws_msk_cluster/meta/main.yml b/tests/integration/targets/msk_cluster/meta/main.yml
similarity index 100%
rename from tests/integration/targets/aws_msk_cluster/meta/main.yml
rename to tests/integration/targets/msk_cluster/meta/main.yml
diff --git a/tests/integration/targets/aws_msk_cluster/tasks/main.yml b/tests/integration/targets/msk_cluster/tasks/main.yml
similarity index 100%
rename from tests/integration/targets/aws_msk_cluster/tasks/main.yml
rename to tests/integration/targets/msk_cluster/tasks/main.yml
diff --git a/tests/integration/targets/aws_msk_cluster/tasks/test_create.yml b/tests/integration/targets/msk_cluster/tasks/test_create.yml
similarity index 100%
rename from tests/integration/targets/aws_msk_cluster/tasks/test_create.yml
rename to tests/integration/targets/msk_cluster/tasks/test_create.yml
diff --git a/tests/integration/targets/aws_msk_cluster/tasks/test_delete.yml b/tests/integration/targets/msk_cluster/tasks/test_delete.yml
similarity index 100%
rename from tests/integration/targets/aws_msk_cluster/tasks/test_delete.yml
rename to tests/integration/targets/msk_cluster/tasks/test_delete.yml
diff --git a/tests/integration/targets/aws_msk_cluster/tasks/test_update.yml b/tests/integration/targets/msk_cluster/tasks/test_update.yml
similarity index 100%
rename from tests/integration/targets/aws_msk_cluster/tasks/test_update.yml
rename to tests/integration/targets/msk_cluster/tasks/test_update.yml
diff --git a/tests/integration/targets/msk_config/aliases b/tests/integration/targets/msk_config/aliases
new file mode 100644
index 00000000000..4ef4b2067d0
--- /dev/null
+++ b/tests/integration/targets/msk_config/aliases
@@ -0,0 +1 @@
+cloud/aws
diff --git a/tests/integration/targets/aws_msk_config/defaults/main.yml b/tests/integration/targets/msk_config/defaults/main.yml
similarity index 78%
rename from tests/integration/targets/aws_msk_config/defaults/main.yml
rename to tests/integration/targets/msk_config/defaults/main.yml
index 264a2430061..92aad4bd87b 100644
--- a/tests/integration/targets/aws_msk_config/defaults/main.yml
+++ b/tests/integration/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/tests/integration/targets/aws_msk_config/meta/main.yml b/tests/integration/targets/msk_config/meta/main.yml
similarity index 100%
rename from tests/integration/targets/aws_msk_config/meta/main.yml
rename to tests/integration/targets/msk_config/meta/main.yml
diff --git a/tests/integration/targets/aws_msk_config/tasks/main.yml b/tests/integration/targets/msk_config/tasks/main.yml
similarity index 100%
rename from tests/integration/targets/aws_msk_config/tasks/main.yml
rename to tests/integration/targets/msk_config/tasks/main.yml