sap_swpm: New improved and simplified version

roles/sap_swpm/README.md

@@ -63,58 +63,66 @@ This role has been tested and working for the following SAP products
 ### Input Parameters
 
 The inputs are critical for running this role
-    - Determines the installation type
-    - Incomplete parameters will result to failure
-    - Wrong parameters will result to failure
+    - Incomplete parameters will result in failure
+    - Wrong parameters will result in failure
 
 Create an input file which contains all relevant installation information.
-Sample input files are stored in the [inputs](/playbooks/vars) folder of this Ansible collection. Use the samples as guide for your desired installation
-
-### Default Parameters
+Sample input files are stored in the [inputs](/playbooks/vars) folder of this Ansible collection. Use the samples as guide for your desired installation.
 
 ### Default Parameters
 
 Please check the default parameters file for more information on other parameters that can be used as an input:
 - [**sap_swpm** default parameters](defaults/main.yml)
 
-Sample Playbooks and sample parameters are shown in the Ansible Collection `/playbooks` directory.
-
-The Ansible Collection `/playbooks` directory includes sample playbooks for using the `sap_swpm` Ansible Role in the following 'modes':
-- Default
-- Default Templates
-- Advanced
-- Advanced Templates
-- Inifile Reuse
-
-The Ansible Collection `/playbooks/vars` directory includes sample variable files for:
-- `sap_swpm` 'Default mode' to generate inifile.params of...
-  - SAP BW/4HANA OneHost
-  - SAP S/4HANA Distributed - ASCS, DBCI, ERS, PAS
-  - SAP S/4HANA OneHost
-  - SAP S/4HANA System Copy OneHost
-  - SAP Solution Manager (ABAP)
-  - SAP Solution Manager (JAVA)
-  - SAP Web Dispatcher
-  - SAP System Rename
-- `sap_swpm` 'Default Templates mode' to generate inifile.params of...
-  - SAP S/4HANA OneHost
-  - SAP S/4HANA System Copy OneHost
-  - SAP System Rename
-- `sap_swpm` 'Advanced mode' to generate inifile.params of...
-  - SAP S/4HANA OneHost
-- `sap_swpm` 'Advanced Templates mode' to generate inifile.params of...
-  - SAP BW/4HANA OneHost
-  - SAP S/4HANA Distributed - ASCS, DBCI, ERS, PAS
-  - SAP S/4HANA OneHost
-  - SAP S/4HANA System Copy OneHost
-  - SAP Solution Manager (ABAP)
-  - SAP Solution Manager (JAVA)
-  - SAP Web Dispatcher
-  - SAP System Rename
-- `sap_swpm` 'Inifile Reuse mode' inifile.params file for...
-  - SAP S/4HANA OneHost
-
-NOTE: these are only sample files, they are meant to be edited by the user before execution and do not cover all scenarios possible (the Ansible Role can execute ant SAP SWPM installation)
+### Migrating playbooks from previous versions of sap_swpm
+The following role parameter is no longer used because there are no role `modes` any more:
+#### sap_swpm_ansible_role_mode
+
+The following two role parameters have been renamed, without automatic conversion between old and new name:
+
+#### sap_swpm_inifile_list -> sap_swpm_inifile_sections_list
+Previous name: sap_swpm_inifile_list
+New name: sap_swpm_inifile_sections_list
+Reason: This variable contains sections of the sapinst input file, `inifile.params`.
+The new variable name is reflecting this purpose.
+
+#### sap_swpm_inifile_custom_values_dictionary -> sap_swpm_inifile_parameters_dict
+Previous name: sap_swpm_inifile_custom_values_dictionary
+New name: sap_swpm_inifile_parameters_dict
+Reason: This variable contains parameter names and values of the sapinst input file, `inifile.params`.
+The new variable name is reflecting this purpose.
+
+#### Migration from the `*_templates` modes of the previous version of sap_swpm
+The role `sap_swpm` does no longer use the dictionary `sap_swpm_templates_install_dictionary`.
+This dictionary was used in the previous role modes `default_templates` and `advanced_templates.
+
+Because of this, required low level members of `sap_swpm_templates_install_dictionary` have to be redefined to top level variables.
+Creating top level variables from low level members of a dict can be done:
+
+- in a separate task using ansible.builtin.set_fact before calling sap_swpm, or
+
+- in the task calling sap_swpm with a vars: section of the task calling sap_swpm.
+
+Be aware of the following limitation: You cannot define a variable in the same task in which you use this variable to access a member
+of another variable. Any variable which is used to access low level dict members has to be defined before, in a separate task.
+
+Example:
+For defining `sap_swpm_product_catalog_id` from a low level member of `sap_swpm_templates_install_dictionary`, use the following code:
+
+```
+# Step 1: Define level 2 dict member for accessing level 3 dict member in the following task
+- name: Define variable sap_swpm_templates_product_input
+  ansible.builtin.set_fact:
+    sap_swpm_templates_product_input: "{{ sap_swpm_templates_product_input_prefix }}_nwas_ascs_ha"
+
+# Step 2: Define top level variable from level 3 dict member
+- name: Define variables sap_swpm_product_catalog_id and sap_swpm_inifile_sections_list
+  ansible.builtin.set_fact:
+    sap_swpm_product_catalog_id: "{{ sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_product_catalog_id'] }}"
+    sap_swpm_inifile_sections_list: "{{ sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input][sap_swpm_inifile_sections_list] }}"
+    sap_swpm_inifile_parameters_dict: "{{ sap_swpm_templates_install_dictionary[sap_swpm_templates_product_input]['sap_swpm_inifile_parameters_dict'] }}"
+
+```
 
 ## Execution
 
@@ -133,7 +141,7 @@ Sample Ansible Playbook Execution
 - hosts: all
   become: true
   roles:
-    - { role: sap_swpm }
+    - sap_swpm
 ```
 
 ## Execution Flow
@@ -153,75 +161,52 @@ Sample Ansible Playbook Execution
 
 - Get all .SAR filenames  from `sap_swpm_software_path`
 
-- Update `/etc/hosts` (optional - yes by default)
+- Update `/etc/hosts` (optional - `false` by default)
 
-- Apply firewall rules for SAP HANA (optional - no by default)
+- Apply firewall rules for SAP HANA (optional - `false` by default)
 
-- Process SAP SWPM `inifile.params` based on inputs
+- At this stage, the role is searching for a sapinst inifile on the managed node, or it will create one:
 
-### SAP SWPM
+  - If a file `inifile.params` is located on the managed node in the directory specified in `sap_swpm_inifile_directory`,
+    the role will not create a new one but rather download this file to the control node.
 
-- Execute SWPM
+  - If such a file does *not* exist, the role will create an SAP SWPM `inifile.params` file by one of the following methods:
 
-### Post-Install
+    Method 1: Predefined sections of the file inifile_params.j2 will be used to create the file `inifile.params`.
+              The variable `sap_swpm_inifile_sections_list` contains a list of sections which will part of the file `inifile.params`.
+              All other sections will be ignored. The inifile parameters themselves will be set according to other role parameters. 
+              Example: The inifile parameter `archives.downloadBasket` will be set to the content of the role parameter
+              `sap_swpm_software_path`.
 
-- Set expiry of Unix created users to 'never'
+    Method 2: The file `inifile.params` will be configured from the content of the dictionary `sap_swpm_inifile_parameters_dict`.
+              This dictionary is defined like in the following example:
 
-- Apply firewall rules for SAP NW (optional - no by default)
+```
+sap_swpm_inifile_parameters_dict:
+  archives.downloadBasket: /software/download_basket
+  NW_getFQDN.FQDN: poc.cloud
+```
 
+   It is also possible to use method 1 for creating the inifile and then replace or set additional variables using method 2:
+   Just define both of the related parameters, `sap_swpm_inifile_sections_list` and `sap_swpm_inifile_parameters_dict`.
 
-## Execution Modes
+- The file `inifile.params` is then transferred to a temporary directory on the managed node, to be used by the sapinst process.
 
-Every SAP Software installation via SAP Software Provisioning Manager (SWPM) is possible, there are different Ansible Role execution modes available:
+### SAP SWPM
 
-- Default (`sap_swpm_templates_product_input: default`), run software install tasks using easy Ansible Variable to generate SWPM Unattended installations
-    - Default Templates (`sap_swpm_templates_product_input: default_templates`), optional use of templating definitions for repeated installations
-- Advanced (`sap_swpm_templates_product_input: advanced`), run software install tasks with Ansible Variables one-to-one matched to SWPM Unattended Inifile parameters to generate bespoke SWPM Unattended installations
-    - Advanced Templates (`sap_swpm_templates_product_input: advanced_templates`), optional use of templating definitions for repeated installations
-- Inifile Reuse (`sap_swpm_templates_product_input: inifile_reuse`), run previously-defined installations with an existing SWPM Unattended inifile.params
+- Execute SWPM. This and the remaining steps can be skipped by setting the default of the parameter `sap_swpm_run_sapinst` to `false`.
 
-### Default Templates mode variables
+### Post-Install
 
-Example using all inifile list parameters with the Default Templates mode to install SAP ECC EhP8 on IBM Db2:
+- Set expiry of Unix created users to 'never'
 
-```
-sap_swpm_ansible_role_mode: default_templates
-sap_swpm_templates_product_input: default_templates
-
-sap_swpm_templates_install_dictionary:
-
-  template_name_ecc_ehp8_ibmdb2:
-
-    sap_swpm_product_catalog_id: NW_ABAP_OneHost:BS2016.ERP608.DB6.PD
-    sap_swpm_inifile_dictionary:
-      sap_swpm_sid:
-      ...
-    sap_swpm_inifile_list:
-    - swpm_installation_media
-    - swpm_installation_media_swpm1
-    - swpm_installation_media_swpm1_exportfiles
-    - swpm_installation_media_swpm1_ibmdb2
-    - sum_config
-    - credentials
-    - credentials_anydb_ibmdb2
-    - db_config_anydb_all
-    - db_config_anydb_ibmdb2
-    - db_connection_nw_anydb_ibmdb2
-    - nw_config_anydb
-    - nw_config_other
-    - nw_config_central_services_abap
-    #  - nw_config_central_services_java
-    - nw_config_primary_application_server_instance
-    - nw_config_ports
-    - nw_config_host_agent
-    #  - nw_config_post_abap_reports
-    - sap_os_linux_user
-```
+- Apply firewall rules for SAP NW (optional - false by default)
 
 ## Tags
 
 With the following tags, the role can be called to perform certain activities only:
-- tag `sap_swpm_generate_inifile`: Only create the sapinst inifile. This can be useful for checking if the inifile is created as desired.
+- tag `sap_swpm_generate_inifile`: Only create the sapinst inifile, without running most of the preinstall steps.
+  This can be useful for checking if the inifile is created as desired.
 - tag `sap_swpm_sapinst_commandline`: Only show the sapinst command line.
 - tag `sap_swpm_pre_install`: Perform all preinstallation steps, then exit.
 - tag `sap_swpm_setup_firewall`: Only perform the firewall preinstallation settings (but only if variable `sap_swpm_setup_firewall` is set to `true`).

roles/sap_swpm/defaults/main.yml

@@ -5,7 +5,8 @@
 #   SWPM Ansible Role variables
 ########################################
 
-sap_swpm_ansible_role_mode: "default"
+# We do not use role modes any more:
+# sap_swpm_ansible_role_mode: "default"
 # default
 # default_templates
 # advanced
@@ -45,30 +46,29 @@ sap_swpm_files_non_sapcar_group: root
 
 ########################################
 #   SWPM Ansible Role variables
-#   for Inifile Reuse, Advanced, and Defaults/Advanced Templates Mode
+#   for creating the sapinst inifile
 ########################################
 
+# Have the role run the sapinst command with an existing inifile or after creating the inifile:
+sap_swpm_run_sapinst: true
+
 # Inifile Reuse Mode
 sap_swpm_inifile_reuse_source:
 sap_swpm_inifile_reuse_destination:
 
-# Advanced Mode
-#sap_swpm_inifile_custom_values_dictionary:
+#sap_swpm_inifile_parameters_dict:
 #  archives.downloadBasket: /software/download_basket
 #  NW_getFQDN.FQDN: poc.cloud
 ## add.additional.parameters: ''
 
-# Default/Advanced Templates Mode
-#sap_swpm_templates_product_input: ""
-
 
 ########################################
 #   SWPM Ansible Role variables
 #   for Default Mode
 #   - List of inifile parameters to generate
 ########################################
 
-sap_swpm_inifile_list:
+sap_swpm_inifile_sections_list:
   - swpm_installation_media
   - swpm_installation_media_swpm2_hana
 #  - swpm_installation_media_swpm1
@@ -156,7 +156,7 @@ sap_swpm_software_extract_directory: # e.g. /software/sap_swpm_extracted
 sap_swpm_software_use_media: 'false'
 
 # Main path that this role will look for .SAR files
-sap_swpm_software_path:
+#sap_swpm_software_path: /software/sapfiles
 ## This directory path should include these files:
 ##   - igs*sar
 ##   - igshelper*sar
@@ -165,6 +165,10 @@ sap_swpm_software_path:
 ##   - IMDB_CLIENT*SAR
 ##   - SAPHOSTAGENT*SAR
 
+# Directory in which a sapinst inifile which is to be used by the role can be stored:
+sap_swpm_inifile_directory: '/software/sap_swpm/inifiles'
+#sap_swpm_local_inifile_directory: '/tmp/inifiles'
+
 # SWPM1 - paths that this role will look for CD Media software
 sap_swpm_cd_export_pt1_path:
 sap_swpm_cd_export_pt2_path:

roles/sap_swpm/tasks/main.yml

@@ -9,8 +9,10 @@
 
 - name: SAP SWPM - run swpm
   ansible.builtin.import_tasks: swpm.yml
+  when: sap_swpm_run_sapinst
   tags:
     - sap_swpm_install
 
 - name: SAP SWPM - run postinstall task
   ansible.builtin.import_tasks: post_install.yml
+  when: sap_swpm_run_sapinst