Merge pull request sap-linuxlab#1151 from marcelmamula/aws-fence-16

sap_ha_pacemaker_cluster: Add fence_aws for SLES 16 and remove Tech Debt

Author: marcelmamula

roles/sap_ha_pacemaker_cluster/DEPRECATED_VARIABLES.md

@@ -46,6 +46,9 @@ All deprecated variables offer time limited backwards compatibility that will be
 | ~~sap_ha_pacemaker_cluster_healthcheck_nwas_abap_ascs_id~~<br>sap_ha_pacemaker_cluster_healthcheck_nwas_ascs_id | :heavy_check_mark: | Removal of `_abap_` |
 | ~~sap_ha_pacemaker_cluster_healthcheck_nwas_abap_ers_id~~<br>sap_ha_pacemaker_cluster_healthcheck_nwas_ers_id | :heavy_check_mark: | Removal of `_abap_` |
 | ~~sap_ha_pacemaker_cluster_storage_nfs_filesytem_type~~<br>sap_ha_pacemaker_cluster_storage_nfs_filesystem_type | :heavy_check_mark: | Typo |
+| ~~sap_ha_pacemaker_cluster_fence_agent_minimal_packages~~ | :x: | Replaced with `sap_ha_pacemaker_cluster_fence_agent_packages` |
+| ~~sap_ha_pacemaker_cluster_stonith_custom.name~~ | :x: | Replaced with `sap_ha_pacemaker_cluster_stonith_custom.id` | 
+| ~~sap_ha_pacemaker_cluster_stonith_custom.options~~ | :x: | Removed in favor of `instance_attrs` and `meta_attrs` |
 
 
 ## Status explanation:

roles/sap_ha_pacemaker_cluster/README.md

@@ -65,7 +65,8 @@ sap_ha_pacemaker_cluster_vip_client_interface: ''
 #       pcmk_host_list: ""
 
 ## The variable 'sap_ha_pacemaker_cluster_cluster_properties' is used to configure cluster properties (e.g. cib-bootstrap-options).
-# NOTE: Default values are defined by Operating System and Platforms, if the variable is not defined.
+# NOTE 1: Default values are defined by Operating System and Platforms, if the variable is not defined.
+# NOTE 2: Configuring wrong properties or disabling fencing can have adverse effects on cluster stability and data integrity.
 # Simpler definition format here which gets transformed into the 'ha_cluster' LSR native 'ha_cluster_cluster_properties' parameter.
 # sap_ha_pacemaker_cluster_cluster_properties:
 #   stonith-enabled: true

roles/sap_ha_pacemaker_cluster/defaults/main.yml

@@ -9,6 +9,12 @@ argument_specs:
 
   main:
     short_description: SAP HA automated cluster setup requirements
+    # This is used to populate beginning of the Role Variables section in README.md
+    description: |
+      Minimum required parameters for all clusters:
+      - [sap_ha_pacemaker_cluster_hacluster_user_password](#sap_ha_pacemaker_cluster_hacluster_user_password)
+
+      Additional minimum requirements depend on the type of cluster setup and on the target platform.
     options:
 
 # Take this template and copy it to the desired place.
@@ -170,8 +176,7 @@ argument_specs:
             description:
               - Parameter `id` is required.
               - Name that will be used as the resource ID (name).
-            # TODO: Enable to remove Tech debt after name and options are removed!
-            # required: true
+            required: true
           agent:
             type: str
             description:
@@ -199,16 +204,6 @@ argument_specs:
             type: list
             description:
               - Defines meta attributes as list of name/value pairs.
-          # TODO: Tech Debt: Remove name and options in next release
-          name:
-            type: str
-            description:
-              - WARNING! This option will be removed in future release.
-          # TODO: Tech Debt: Remove name and options in next release
-          options:
-            type: dict
-            description:
-              - WARNING! This option will be removed in future release.
 
         example:
           sap_ha_pacemaker_cluster_stonith_custom:
@@ -298,11 +293,9 @@ argument_specs:
       sap_ha_pacemaker_cluster_cluster_properties:
         type: dict
         description:
-          - Standard pacemaker cluster properties are configured with recommended settings for
-            cluster node fencing.
+          - Optional configuration of cluster properties (cib-bootstrap-options).
+          - Default values are applied by Operating System and Platform, if the variable is not defined.
           - When no STONITH resource is defined, STONITH will be disabled and a warning displayed.
-          - Default values are predefined by OS and Platform if the variable is not defined.
-          - Some mandatory properties are appended, if not defined.
 
         example:
           sap_ha_pacemaker_cluster_cluster_properties:
@@ -380,9 +373,7 @@ argument_specs:
         type: list
         description:
           - Additional fence agent packages to be installed.
-          - "This is automatically combined with default packages in:"
-          - "`__sap_ha_pacemaker_cluster_fence_agent_packages_minimal`"
-          - "`__sap_ha_pacemaker_cluster_fence_agent_packages_platform`"
+          - "This is automatically combined with default OS and Platform specific packages."
 
       sap_ha_pacemaker_cluster_zypper_patterns:
         type: list

roles/sap_ha_pacemaker_cluster/meta/argument_specs.yml

@@ -70,39 +70,26 @@
 
 # __sap_ha_pacemaker_cluster_fence_agent_packages loaded from ha_cluster is not included,
 # because it would still not be used due to precedence.
-# TODO: Remove Tech debt conditionals in future for deprecated var 'sap_ha_pacemaker_cluster_fence_agent_minimal_packages'
 - name: "SAP HA Prepare Pacemaker - Combine fence agent packages lists"
   ansible.builtin.set_fact:
     __sap_ha_pacemaker_cluster_fence_agent_packages: "{{
-      (__sap_ha_pacemaker_cluster_fence_agent_packages_minimal_combined
+      (__sap_ha_pacemaker_cluster_fence_agent_packages_minimal
       + __sap_ha_pacemaker_cluster_fence_agent_packages_platform
       + sap_ha_pacemaker_cluster_fence_agent_packages)
       | unique }}"
-  vars:
-    # Tech debt for sap_ha_pacemaker_cluster_fence_agent_minimal_packages
-    __sap_ha_pacemaker_cluster_fence_agent_packages_minimal_combined:
-      "{{ __sap_ha_pacemaker_cluster_fence_agent_packages_minimal
-       + sap_ha_pacemaker_cluster_fence_agent_minimal_packages
-        if (sap_ha_pacemaker_cluster_fence_agent_minimal_packages is defined
-          and sap_ha_pacemaker_cluster_fence_agent_minimal_packages | length > 0
-          and sap_ha_pacemaker_cluster_fence_agent_minimal_packages is iterable)
-        else __sap_ha_pacemaker_cluster_fence_agent_packages_minimal }}"
-
 
 # Prepare cluster properties variable with either:
-# - User provided 'sap_ha_pacemaker_cluster_cluster_properties' if defined and not empty.
+# - User provided 'sap_ha_pacemaker_cluster_cluster_properties' if defined.
 # - Platform specific defaults, if defined.
 # - OS specific defaults.
-# If the variable 'ha_cluster_properties' is defined, it will append only missing keys.
+# Combine prioritizes platform specific over OS specific.
 - name: "SAP HA Prepare Pacemaker - Prepare cluster properties variable"
   ansible.builtin.set_fact:
     __sap_ha_pacemaker_cluster_cluster_properties:
       "{{ sap_ha_pacemaker_cluster_cluster_properties
-        if sap_ha_pacemaker_cluster_cluster_properties is defined and sap_ha_pacemaker_cluster_cluster_properties | length > 0
-        else (__sap_ha_pacemaker_cluster_cluster_properties_platform
-          if __sap_ha_pacemaker_cluster_cluster_properties_platform is defined
-          else __sap_ha_pacemaker_cluster_cluster_properties_default) }}"
-
+        if sap_ha_pacemaker_cluster_cluster_properties is defined
+        else __sap_ha_pacemaker_cluster_cluster_properties_default | d({})
+          | combine(__sap_ha_pacemaker_cluster_cluster_properties_platform | d({})) }}"
 
 # Prepare corosync totem variable with either:
 # - User provided 'sap_ha_pacemaker_cluster_corosync_totem' if present