Merge pull request #442 from sap-linuxlab/dev

collection: merge dev to main for release 1.3.1

CHANGELOG.rst

@@ -5,6 +5,21 @@ community.sap_install Release Notes
 .. contents:: Topics
 
 
+v1.3.1
+======
+
+Release Summary
+---------------
+
+| Release Date: 2023-08-14
+| sap_ha_pacemaker_cluster: Improved AWS constructs based on feedback
+| sap_ha_pacemaker_cluster: Improved no STONITH resource definition handling
+| sap_hana_install: Bug fix for arg spec on deprecated vars
+| sap_hostagent: Bug fix for media handling
+| sap_install_media_detect: Improved handling based on feedback
+| sap_storage_setup: Bug fix for existing storage devices
+| sap_swpm: Make full log output optional and replace with sapcontrol log final status
+| collection: Bug fix for sample Ansible Playbooks
 
 v1.3.0
 ======

README.md

@@ -95,25 +95,29 @@ There are various methods to execute the Ansible Collection, dependant on the us
 | ---- | ---- | ---- |
 | Ansible Playbook <br/>-> source Ansible Collection <br/>-> execute Ansible Task <br/>--> run Ansible Role <br/>---> run Ansible Module for Shell (built-in)<br/>---> ... | Complex executions with various interlinked activities;<br/> run in parallel or sequentially | Localhost or Remote |
 
-## Requirements, Dependencies and Testing
+## Testing, Requirements and Dependencies
 
-## Testing with SAP Software Provisioning Manager (SWPM)
+### Testing
 
 Various SAP Software solutions have been extensively tested:
 
 - SAP HANA
-- SAP NetWeaver AS (ABAP or JAVA)
-- SAP S/4HANA AnyPremise 1809, 1909, 2020, 2021
-  - One Host installation
-  - Dual Host installation
+  - Scale-Up
+  - Scale-Out
+  - High Availability
+- SAP NetWeaver AS (ABAP or JAVA) and additional addons (e.g. GRC, ADS)
+- SAP S/4HANA AnyPremise (1809, 1909, 2020, 2021, 2022)
+  - Sandbox (One Host) installation
+  - Standard (Dual Host) installation
   - Distributed installation
   - High Availability installation
   - System Copy (Homogeneous with SAP HANA Backup / Recovery) installation
+  - Maintenance Planner installation
   - System Rename
 - SAP BW/4HANA
+- SAP Business Suite on HANA (SoH, i.e. SAP ECC on HANA)
+- SAP Business Suite (i.e. SAP ECC with SAP AnyDB - SAP ASE, SAP MaxDB, IBM Db2, Oracle DB)
 - SAP Solution Manager 7.2
-- SAP Business Suite (i.e. ECC)
-- SAP NetWeaver applications (e.g. GRC)
 - SAP Web Dispatcher
 
 ### Target host - Operating System requirements
@@ -136,7 +140,7 @@ N.B. The Ansible Collection works with SLES from version 15 SP3 and upwards, for
 
 Execution of Ansible Playbooks using this Ansible Collection have been tested with:
 - Python 3.9.7 and above (i.e. CPython distribution)
-- Ansible Core 2.11.5 and above (included with optional installation of Ansible Community Edition 4.0 and above)
+- Ansible Core 2.11.5 and above _(included with optional installation of Ansible Community Edition 4.0 and above)_
 - OS: macOS with Homebrew, RHEL, SLES, and containers in Task Runners (e.g. Azure DevOps)
 
 ## License

galaxy.yml

@@ -10,7 +10,7 @@ namespace: community
 name: sap_install
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 1.3.0
+version: 1.3.1
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

playbooks/vars/sample-variables-sap-swpm-advanced-mode-s4hana-onehost-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP HANA and SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-advanced-templates-mode.yml

@@ -2,7 +2,7 @@
 
 # Detect SAP HANA and SAP NetWeaver software
 # Set vars: on each Ansible Task depending on chosen template
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 #sap_install_media_detect_swpm: true
 #sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-mode-bw4hana-onehost-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP HANA and SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-mode-s4hana-distributed-ascs-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-mode-s4hana-distributed-dbload-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-mode-s4hana-distributed-ers-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-mode-s4hana-distributed-pas-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-mode-s4hana-onehost-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP HANA and SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-mode-s4hana-onehost-restore.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP HANA and SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-mode-solman-hana-abap-onehost-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP HANA and SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_db: "saphana"
 sap_install_media_detect_swpm: true

playbooks/vars/sample-variables-sap-swpm-default-mode-solman-hana-java-onehost-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP HANA and SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_db: "saphana"
 sap_install_media_detect_swpm: true

playbooks/vars/sample-variables-sap-swpm-default-mode-webdisp-standalone-install.yml

@@ -1,7 +1,7 @@
 ---
 
 # Detect SAP HANA and SAP NetWeaver software
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 sap_install_media_detect_swpm: true
 sap_install_media_detect_hostagent: true

playbooks/vars/sample-variables-sap-swpm-default-templates-mode.yml

@@ -2,7 +2,7 @@
 
 # Detect SAP HANA and SAP NetWeaver software
 # Set vars: on each Ansible Task depending on chosen template
-sap_install_media_detect_directory: "/software"
+sap_install_media_detect_source_directory: "/software"
 sap_install_media_detect_source: local_dir
 #sap_install_media_detect_swpm: true
 #sap_install_media_detect_hostagent: true

roles/sap_ha_pacemaker_cluster/tasks/construct_vars_stonith.yml

@@ -2,6 +2,33 @@
 # The following variables are constructed here in order to be provided as
 # input for the included 'ha_cluster' system role.
 
+- name: "SAP HA Prepare Pacemaker - Block when no STONITH resource is defined"
+  when:
+    - sap_ha_pacemaker_cluster_stonith_default is not defined
+      or sap_ha_pacemaker_cluster_stonith_default | length == 0
+    - sap_ha_pacemaker_cluster_stonith_custom is not defined
+      or sap_ha_pacemaker_cluster_stonith_custom | length == 0
+  block:
+
+    - name: "SAP HA Prepare Pacemaker - Set STONITH to disabled when no fencing resource is defined"
+      ansible.builtin.set_fact:
+        __sap_ha_pacemaker_cluster_cluster_properties:
+          - attrs:
+              - name: stonith-enabled
+                value: false
+
+    - name: "SAP HA Prepare Pacemaker - Warn that there is no STONITH configured"
+      ansible.builtin.pause:
+        seconds: 5
+        prompt: |
+
+          WARNING: No STONITH resource is defined and STONITH is disabled!
+
+          Recommendation: Add a STONITH resource and set cluster property
+                          "stonith-enabled=true"
+                          before using this cluster for production services.
+# END of block
+
 - name: "SAP HA Prepare Pacemaker - Define cluster stonith properties"
   when:
     - sap_ha_pacemaker_cluster_cluster_properties is defined
@@ -40,7 +67,7 @@
     __sap_ha_pacemaker_cluster_stonith_resource: "{{ __sap_ha_pacemaker_cluster_stonith_resource | default([]) + [__stonith_resource_element] }}"
   vars:
     __stonith_resource_element:
-      id: "res_{{ sap_ha_pacemaker_cluster_stonith_default.id }}"
+      id: "{{ sap_ha_pacemaker_cluster_stonith_default.id }}"
       agent: "{{ sap_ha_pacemaker_cluster_stonith_default.agent }}"
       instance_attrs:
         - attrs: |-
@@ -50,7 +77,7 @@
                 'name': 'pcmk_host_map',
                 'value': __sap_ha_pacemaker_cluster_pcmk_host_map
               }]) -%}
-            {%- for agent_opt in (sap_ha_pacemaker_cluster_stonith_default.options | dict2items) -%}
+            {%- for agent_opt in (sap_ha_pacemaker_cluster_stonith_default.options | default({}) | dict2items) -%}
               {% set aopts = attrs.extend([
                 {
                   'name': agent_opt.key,
@@ -63,7 +90,7 @@
                   'name': fence_opt.key,
                   'value': fence_opt.value
                 }]) -%}
-            {%- endfor %}
+              {%- endfor %}
             {{ attrs }}
 
 - name: "SAP HA Prepare Pacemaker - Assemble the stonith resources from custom definition"

roles/sap_ha_pacemaker_cluster/tasks/main.yml

@@ -107,6 +107,19 @@
       vars:
         __sap_ha_pacemaker_cluster_platform_file: "{{ role_path }}/tasks/{{ item }}"
 
+    # Stop and disable services that conflict with cluster setups,
+    # for instance cloud-init services on cloud platforms
+    - name: "SAP HA Install Pacemaker - Stop and disable services"
+      when: sap_ha_pacemaker_cluster_disable_services is defined
+      ansible.builtin.service:
+        name: "{{ service_item }}"
+        enabled: false
+        state: stopped
+      loop: "{{ sap_ha_pacemaker_cluster_disable_services }}"
+      loop_control:
+        loop_var: service_item
+        label: "{{ service_item }}"
+
     # Before we are ready to call the ha_cluster role, we want to validate
     # that the minimum required parameters are defined and not empty.
     # TODO: make this smarter, currently all these vars are pre-defined anyway

roles/sap_ha_pacemaker_cluster/tasks/platform/include_vars_platform.yml

@@ -13,47 +13,47 @@
 # pcmk_host_map format: <hostname1>:<host1-id>;<hostname2>:<host2-id>...
 - name: "SAP HA Prepare Pacemaker - AWS EC2 VS - Assemble host mapping"
   ansible.builtin.set_fact:
-    __sap_ha_pacemaker_cluster_pcmk_host_map: >
+    __sap_ha_pacemaker_cluster_pcmk_host_map: |-
       {% for node in ansible_play_hosts_all -%}
         {{ hostvars[node].ansible_hostname }}:{{ hostvars[node].ansible_board_asset_tag }}
-      {%-  if not loop.last %};{% endif -%}
-      {%- endfor %}
+        {%- if not loop.last %};{% endif %}
+      {% endfor %}
   when: __sap_ha_pacemaker_cluster_platform == "cloud_aws_ec2_vs"
 
 
 - name: "SAP HA Prepare Pacemaker - IBM Power VS from IBM Cloud - Set variable for fencing agent"
   ansible.builtin.set_fact:
     sap_ha_pacemaker_cluster_ibmcloud_powervs_host_guid: "{{ __sap_ha_pacemaker_cluster_register_ibmcloud_powervs_host }}"
-  when: __sap_ha_pacemaker_cluster_platform == ""
+  when: __sap_ha_pacemaker_cluster_platform == "cloud_ibmcloud_powervs"
 
 # pcmk_host_map format: <hostname1>:<host1-id>;<hostname2>:<host2-id>...
 - name: "SAP HA Prepare Pacemaker - IBM Power VS from IBM Cloud - Assemble host mapping"
   ansible.builtin.set_fact:
-    __sap_ha_pacemaker_cluster_pcmk_host_map: >-
+    __sap_ha_pacemaker_cluster_pcmk_host_map: |-
       {% for node in ansible_play_hosts_all -%}
         {{ hostvars[node].ansible_hostname }}:{{ hostvars[node].sap_ha_pacemaker_cluster_ibmcloud_powervs_host_guid }}
-      {%-  if not loop.last %};{%- endif -%}
-      {%- endfor %}
+        {%- if not loop.last %};{% endif %}
+      {% endfor %}
   when: __sap_ha_pacemaker_cluster_platform == "cloud_ibmcloud_powervs"
 
 
 # pcmk_host_map format: <hostname1>:<host1-id>;<hostname2>:<host2-id>...
 - name: "SAP HA Prepare Pacemaker - IBM Cloud VS - Assemble host mapping"
   ansible.builtin.set_fact:
-    __sap_ha_pacemaker_cluster_pcmk_host_map: >-
+    __sap_ha_pacemaker_cluster_pcmk_host_map: |-
       {% for node in ansible_play_hosts_all -%}
         {{ hostvars[node].ansible_hostname }}:{{ hostvars[node].__sap_ha_pacemaker_cluster_register_ibmcloud_vs_host.stdout }}
-      {%-  if not loop.last %};{%- endif -%}
-      {%- endfor %}
+        {%- if not loop.last %};{% endif %}
+      {% endfor %}
   when: __sap_ha_pacemaker_cluster_platform == "cloud_ibmcloud_vs"
 
 
 # pcmk_host_map format: <hostname1>:<hostname1>;<hostname2>:<hostname2>...
 - name: "SAP HA Prepare Pacemaker - MS Azure VM - Assemble host mapping"
   ansible.builtin.set_fact:
-    __sap_ha_pacemaker_cluster_pcmk_host_map: >-
+    __sap_ha_pacemaker_cluster_pcmk_host_map: |-
       {% for node in ansible_play_hosts_all -%}
         {{ hostvars[node].ansible_hostname }}:{{ hostvars[node].ansible_hostname }}
-      {%-  if not loop.last %};{%- endif -%}
-      {%- endfor %}
+        {%- if not loop.last %};{% endif %}
+      {% endfor %}
   when: __sap_ha_pacemaker_cluster_platform == "cloud_msazure_vm"

roles/sap_ha_pacemaker_cluster/vars/platform_cloud_aws_ec2_vs.yml

@@ -16,13 +16,16 @@ __sap_ha_pacemaker_cluster_repos:
 # Predefine
 __sap_ha_pacemaker_cluster_aws_instances: []
 
+# When aws credentials and region are not defined it will
+# default to using the aws cli configuration.
+# aws cli is configured by default for the VIP resource.
 sap_ha_pacemaker_cluster_stonith_default:
   id: "res_fence_aws"
   agent: "stonith:fence_aws"
-  options:
-    access_key: "{{ sap_ha_pacemaker_cluster_aws_access_key_id }}"
-    secret_key: "{{ sap_ha_pacemaker_cluster_aws_secret_access_key }}"
-    region: "{{ sap_ha_pacemaker_cluster_aws_region }}"
+#  options:
+#    access_key: "{{ sap_ha_pacemaker_cluster_aws_access_key_id }}"
+#    secret_key: "{{ sap_ha_pacemaker_cluster_aws_secret_access_key }}"
+#    region: "{{ sap_ha_pacemaker_cluster_aws_region }}"
 
 # Platform specific VIP handling
 sap_ha_pacemaker_cluster_vip_method: aws_vpc_move_ip
@@ -41,3 +44,10 @@ __sap_ha_pacemaker_cluster_available_vip_agents:
   # Supported agent to manage Virtual/Overlay IPs for SAP on AWS by updating VPC Routing Table.
   aws_vpc_move_ip:
     agent: "ocf:heartbeat:aws-vpc-move-ip"
+
+# RHEL 8.6 and later:
+# Services that must be disabled and stopped for the VIP to work
+# otherwise AWS cloud-init keeps deleting the IP
+sap_ha_pacemaker_cluster_disable_services:
+  - nm-cloud-setup.timer
+  - nm-cloud-setup

roles/sap_hana_install/meta/argument_specs.yml

@@ -6,10 +6,8 @@ argument_specs:
       sap_hana_install_sid:
         description: HANA SID
         type: str # str, list, dict, bool, int, float, path, raw, jsonarg, json, bytes, bits
-        required: true
-        no_log: true
+        required: false
       sap_hana_install_number:
         description: HANA Instance Number
         type: str # str, list, dict, bool, int, float, path, raw, jsonarg, json, bytes, bits
-        required: true
-        no_log: true
+        required: false

roles/sap_hostagent/tasks/deploy_sar_remote.yml

@@ -2,8 +2,8 @@
 
 - name: Extract the SAPHOSTAGENT archive using SAPCAR
   command: >-
-    {{ sap_hostagent_sar_remote_path }}/{{ sap_hostagent_sapcar_file_name }} \
-    -xvf {{ sap_hostagent_sapcar_remote_path }}/{{ sap_hostagent_sar_file_name }} -manifest SIGNATURE.SMF
+    {{ sap_hostagent_sapcar_remote_path }}/{{ sap_hostagent_sapcar_file_name }} \
+    -xvf {{ sap_hostagent_sar_remote_path }}/{{ sap_hostagent_sar_file_name }} -manifest SIGNATURE.SMF
   register: extractagent
   args:
     chdir: "{{ sap_hostagent_agent_tmp_directory }}"
@@ -14,4 +14,4 @@
   register: installagent
   args:
     chdir: "{{ sap_hostagent_agent_tmp_directory }}"
-  changed_when: "'Install service' in installagent.stdout"
+  changed_when: "'Install service' in installagent.stdout"