From 19356335eede72c232219dc6fdf2153347efc1ec Mon Sep 17 00:00:00 2001 From: Mario Lenz Date: Tue, 18 Feb 2025 20:26:00 +0100 Subject: [PATCH] Deprecate vmware_cluster_ha --- .github/workflows/extra-docs-linting.yml | 2 +- .../2321-deprecate-vmware_cluster_ha.yml | 3 + galaxy.yml | 2 +- meta/runtime.yml | 4 + plugins/modules/vmware_cluster_ha.py | 4 + .../targets/vmware_cluster_ha/aliases | 3 - .../targets/vmware_cluster_ha/tasks/main.yml | 303 ------------------ 7 files changed, 13 insertions(+), 308 deletions(-) create mode 100644 changelogs/fragments/2321-deprecate-vmware_cluster_ha.yml delete mode 100644 tests/integration/targets/vmware_cluster_ha/aliases delete mode 100644 tests/integration/targets/vmware_cluster_ha/tasks/main.yml diff --git a/.github/workflows/extra-docs-linting.yml b/.github/workflows/extra-docs-linting.yml index ba6c63f60d..359f1a9c51 100644 --- 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.9.0' + 'vmware.vmware>=1.10.0' - name: Run collection docs linter run: antsibull-docs lint-collection-docs . --plugin-docs --skip-rstcheck diff --git a/changelogs/fragments/2321-deprecate-vmware_cluster_ha.yml b/changelogs/fragments/2321-deprecate-vmware_cluster_ha.yml new file mode 100644 index 0000000000..8158e81c67 --- /dev/null +++ b/changelogs/fragments/2321-deprecate-vmware_cluster_ha.yml @@ -0,0 +1,3 @@ +deprecated_features: + - vmware_cluster_ha - the module has been deprecated and will be removed in community.vmware 7.0.0 + (https://github.com/ansible-collections/community.vmware/pull/2321). diff --git a/galaxy.yml b/galaxy.yml index 25eddc8472..efb6db4ea4 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -18,7 +18,7 @@ tags: - vmware - virtualization dependencies: - vmware.vmware: ">=1.9.0,<2.0.0" + vmware.vmware: ">=1.10.0,<2.0.0" repository: https://github.com/ansible-collections/community.vmware.git homepage: https://github.com/ansible-collections/community.vmware issues: https://github.com/ansible-collections/community.vmware/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc diff --git a/meta/runtime.yml b/meta/runtime.yml index ce8295a6d8..83722e235c 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -210,6 +210,10 @@ plugin_routing: deprecation: removal_version: 7.0.0 warning_text: Use vmware.vmware.cluster_info instead. + vmware_cluster_ha: + deprecation: + removal_version: 7.0.0 + warning_text: Use vmware.vmware.cluster_ha instead. vmware_cluster_vcls: deprecation: removal_version: 6.0.0 diff --git a/plugins/modules/vmware_cluster_ha.py b/plugins/modules/vmware_cluster_ha.py index cad1eb5198..f1b81572d2 100644 --- a/plugins/modules/vmware_cluster_ha.py +++ b/plugins/modules/vmware_cluster_ha.py @@ -14,6 +14,10 @@ DOCUMENTATION = r''' --- module: vmware_cluster_ha +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_ha) instead. short_description: Manage High Availability (HA) on VMware vSphere clusters description: - Manages HA configuration on VMware vSphere clusters. diff --git a/tests/integration/targets/vmware_cluster_ha/aliases b/tests/integration/targets/vmware_cluster_ha/aliases deleted file mode 100644 index b1682114ea..0000000000 --- a/tests/integration/targets/vmware_cluster_ha/aliases +++ /dev/null @@ -1,3 +0,0 @@ -cloud/vcenter -needs/target/prepare_vmware_tests -zuul/vmware/vcenter_only diff --git a/tests/integration/targets/vmware_cluster_ha/tasks/main.yml b/tests/integration/targets/vmware_cluster_ha/tasks/main.yml deleted file mode 100644 index 0fbe0cfcbe..0000000000 --- a/tests/integration/targets/vmware_cluster_ha/tasks/main.yml +++ /dev/null @@ -1,303 +0,0 @@ -# Test code for the vmware_cluster module. -# Copyright: (c) 2017, Abhijeet Kasurde -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - -- import_role: - name: prepare_vmware_tests - -# Setup: Create test cluster -- name: Create test cluster - vmware.vmware.cluster: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - state: present - -- name: Enable HA - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - register: enable_ha_result - -- name: Ensure HA is enabled - assert: - that: - - enable_ha_result.changed - -- name: Disable HA - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: false - register: disable_ha_result - -- name: Ensure HA is disabled - assert: - that: - - disable_ha_result.changed - -- name: Change APD response to "restartAggressive" (check-mode) - vmware_cluster_ha: &change_apd_response - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - apd_response: 'restartAggressive' - check_mode: true - register: change_apd_response_check - -- assert: - that: - - change_apd_response_check.changed - -- name: Change APD response to "restartAggressive" - vmware_cluster_ha: *change_apd_response - register: change_apd_response - -- assert: - that: - - change_apd_response.changed - -- name: Change APD response to "restartAggressive" again (idempotency) - vmware_cluster_ha: *change_apd_response - register: change_apd_response_again - -- assert: - that: - - not change_apd_response_again.changed - -- name: Change APD response back to default - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - -- name: Change PDL response to "restartAggressive" (check-mode) - vmware_cluster_ha: &change_pdl_response - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - pdl_response: 'restartAggressive' - check_mode: true - register: change_pdl_response_check - -- assert: - that: - - change_pdl_response_check.changed - -- name: Change PDL response to "restartAggressive" - vmware_cluster_ha: *change_pdl_response - register: change_pdl_response - -- assert: - that: - - change_pdl_response.changed - -- name: Change PDL response to "restartAggressive" again - vmware_cluster_ha: *change_pdl_response - register: change_pdl_response_again - -- assert: - that: - - not change_pdl_response_again.changed - -- name: Change PDL response back to default - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - -- name: Enable Slot based Admission Control - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - slot_based_admission_control: - failover_level: 1 - register: enable_slot_based_admission_control_result - -- name: Ensure Admission Cotrol is enabled - assert: - that: - - enable_slot_based_admission_control_result.changed - -- name: Enable Cluster resource Percentage based Admission Control - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - reservation_based_admission_control: - auto_compute_percentages: false - failover_level: 1 - cpu_failover_resources_percent: 33 - memory_failover_resources_percent: 33 - register: enable_percentage_based_admission_control_result - -- name: Ensure Admission Cotrol is enabled - assert: - that: - - enable_percentage_based_admission_control_result.changed - -- name: Set Isolation Response to powerOff - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - host_isolation_response: 'powerOff' - register: isolation_response_poweroff_result - -- name: Ensure Isolation Response is enabled - assert: - that: - - isolation_response_poweroff_result.changed - -- name: Set Isolation Response to shutdown - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - host_isolation_response: 'shutdown' - register: isolation_response_shutdown_result - -- name: Ensure Isolation Response is enabled - assert: - that: - - isolation_response_shutdown_result.changed - -- name: Change advanced setting "number of heartbeat datastores" (check-mode) - vmware_cluster_ha: &change_num_heartbeat_ds - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - advanced_settings: - 'das.heartbeatDsPerHost': '4' - check_mode: true - register: change_num_heartbeat_ds_check - -- assert: - that: - - change_num_heartbeat_ds_check.changed - -- name: Change advanced setting "number of heartbeat datastores" - vmware_cluster_ha: *change_num_heartbeat_ds - register: change_num_heartbeat_ds - -- assert: - that: - - change_num_heartbeat_ds.changed - -- name: Change advanced setting "number of heartbeat datastores" again - vmware_cluster_ha: *change_num_heartbeat_ds - register: change_num_heartbeat_ds_again - -- assert: - that: - - not change_num_heartbeat_ds_again.changed - -- name: Change advanced setting "das.includeFTcomplianceChecks" (check-mode) - vmware_cluster_ha: &change_includeFTcomplianceChecks - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: true - advanced_settings: - 'das.includeFTcomplianceChecks': 'False' - check_mode: true - register: change_includeFTcomplianceChecks_check - -- assert: - that: - - change_includeFTcomplianceChecks_check.changed - -- name: Change advanced setting "das.includeFTcomplianceChecks" - vmware_cluster_ha: *change_includeFTcomplianceChecks - register: change_includeFTcomplianceChecks - -- assert: - that: - - change_includeFTcomplianceChecks.changed - -- name: Change advanced setting "das.includeFTcomplianceChecks" again - vmware_cluster_ha: *change_includeFTcomplianceChecks - register: change_includeFTcomplianceChecks_again - -- assert: - that: - - not change_includeFTcomplianceChecks_again.changed - -- name: Disable HA - vmware_cluster_ha: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - enable: false - register: disable_ha_result - -- name: Ensure HA is disabled - assert: - that: - - disable_ha_result.changed - -# Delete test cluster -- name: Delete test cluster - vmware.vmware.cluster: - validate_certs: false - hostname: "{{ vcenter_hostname }}" - username: "{{ vcenter_username }}" - password: "{{ vcenter_password }}" - datacenter_name: "{{ dc1 }}" - cluster_name: test_cluster_ha - state: absent