Merge pull request #2260 from mariolenz/deprecate-vmware_cluster_info

Deprecate vmware_cluster_info
ansible-collections · Nov 30, 2024 · 290bc26 · 290bc26
2 parents 039196a + 7d61ba7
commit 290bc26
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 198 deletions.
diff --git a/.github/workflows/extra-docs-linting.yml b/.github/workflows/extra-docs-linting.yml
@@ -34,7 +34,7 @@ jobs:
       - name: Install dependent collections
         run: >
           ansible-galaxy collection install
-          'vmware.vmware>=1.6.0'
+          'vmware.vmware>=1.7.1'
 
       - name: Run collection docs linter
         run: antsibull-docs lint-collection-docs . --plugin-docs --skip-rstcheck
diff --git a/changelogs/fragments/2260-deprecate-vmware_cluster_info.yml b/changelogs/fragments/2260-deprecate-vmware_cluster_info.yml
@@ -0,0 +1,3 @@
+deprecated_features:
+  - vmware_cluster_info - the module has been deprecated and will be removed in community.vmware 7.0.0
+    (https://github.com/ansible-collections/community.vmware/pull/2260).
diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -197,6 +197,10 @@ plugin_routing:
       deprecation:
         removal_version: 6.0.0
         warning_text: Use vmware.vmware.cluster_drs_recommendations instead.
+    vmware_cluster_info:
+      deprecation:
+        removal_version: 7.0.0
+        warning_text: Use vmware.vmware.cluster_info instead.
     vmware_cluster_vcls:
       deprecation:
         removal_version: 6.0.0

diff --git a/plugins/modules/vmware_cluster_info.py b/plugins/modules/vmware_cluster_info.py
@@ -13,6 +13,10 @@
 DOCUMENTATION = r'''
 ---
 module: vmware_cluster_info
+deprecated:
+  removed_in: 7.0.0
+  why: This module has been moved to the L(new vmware.vmware collection,https://forum.ansible.com/t/5880)
+  alternative: Use M(vmware.vmware.cluster_info) instead.
 short_description: Gather info about clusters available in given vCenter
 description:
     - This module can be used to gather information about clusters in VMWare infrastructure.

diff --git a/tests/integration/targets/vmware_cluster_info/aliases b/tests/integration/targets/vmware_cluster_info/aliases
diff --git a/tests/integration/targets/vmware_cluster_info/tasks/main.yml b/tests/integration/targets/vmware_cluster_info/tasks/main.yml