Version 1.1.0

Version 1.1.0 includes the following enhancements:

- Improved variable and task naming for readable messages
- Additional options for the roles start_sap and stop_sap
- New roles start_db and stop_db to start and stop a Db2 database
- New role sap_opsyscheck for basic operating system checks
- Restructured and improved documentation.

Co-Authored-By: gerold1234 <[email protected]>
Co-Authored-By: Markus Mueller <[email protected]>
Co-Authored-By: HEISSLER <[email protected]>

MIGRATION-V1.1.0.md

@@ -0,0 +1,64 @@
+# Upgrading to Ansible Content for IBM Power Systems - AIX with SAP Software Version 1.1.0
+
+# Breaking changes
+
+With version 1.1.0, new conventions for variable names were introduced to increase clarity about their usage. These are the guidelines:
+
+- Each variable name has a prefix that indicates the role for which it is used, such as insshagnt_ for the role install_saphostagent.
+- The second component of a variable name indicates whether the variable contains user input, a directory name, a file name or a boolean (true/false) value.
+- If the variable name is referring to a directory, the suffix in the variable name indicates whether the directory is located on the Ansible controlling node or managed node.
+
+## Role install_saphostagent
+
+The following variables have been renamed:
+
+| **Old name**                        | **New name**                                |
+|:------------------------------------|:--------------------------------------------|
+| `sap_hostagent_download_local_path` | `insshagnt_dir_download_controlnode`        |
+| `sap_hostagent_sar_file_name`       | `insshagnt_input_file_saphostagent_sar`     |
+| `sap_sapcar_download_local_path`    | `insshagnt_dir_download_sapcar_controlnode` |
+| `sap_sapcar_local_path_default`     | `insshagnt_dir_sapcar_default_managednode`  |
+| `sap_sapcar_local_path`             | `insshagnt_dir_sapcar_managednode`          |
+| `sap_hostagent_sapcar_file_name`    | `insshagnt_file_sapcar`                     |
+| `sap_hostagent_agent_tmp_directory` | `insshagnt_dir_temp_managednode`            |
+| `sap_hostagent_clean_tmp_directory` | `insshagnt_bool_clean_dir_temp_managednode` |
+
+## Role start_sap
+
+The following variables have been renamed:
+
+| **Old name**     | **New name**                       |
+|:-----------------|:-----------------------------------|
+| `sap_sid`        | `startsap_input_sap_sid`           |
+| `sap_nr`         | `startsap_input_sap_instance_nr`   |
+| `sapctr_exe_dir` | `startsap_dir_sapctrl_managednode` |
+
+## Role stop_sap
+
+The following variables have been renamed:
+
+| **Old name**      | **New name**                      |
+|:------------------|:----------------------------------|
+| `sap_sid`         | `stopsap_input_sap_sid`           |
+| `sap_nr`          | `stopsap_input_sap_instance_nr`   |
+| `sapctr_exe_dir`  | `stopsap_dir_sapctrl_managednode` |
+| `sap_softtimeout` | `stopsap_softtimeout`             |
+
+## Role upgrade_sap_kernel
+
+The following variables have been renamed:
+
+| **Old name**                             | **New name**                                      |
+|:-----------------------------------------|:--------------------------------------------------|
+| `sap_sid`                                | `upgsapkrn_input_sap_sid`                         |
+| `sap_adm`                                | `upgsapkrn_input_sap_adm`                         |
+| `sap_sys`                                | `upgsapkrn_input_sap_sys`                         |
+| `sap_kernel_upgrade_download_local_path` | `upgsapkrn_dir_download_sar_controlnode`          |
+| `sap_sapcar_download_local_path`         | `upgsapkrn_dir_download_sapcar_controlnode`       |
+| `sap_sapcar_local_path_default`          | `upgsapkrn_dir_sapcar_default_managednode`        |
+| `sap_kernel_upgrade_dest_dir`            | `upgsapkrn_dir_upload_managednode`                |
+| `sap_sapcar_file_name`                   | `upgsapkrn_file_sapcar`                           |
+| (new)                                    | `upgsapkrn_dir_extracted_sar_managednode`         |
+| (new)                                    | `upgsapkrn_dir_kernel_backup_managednode`         |
+| `sap_kernel_upgrade_tmp_dir`             | (obsolete)                                        |
+| `sap_kernel_upgrade_dir`                 | `upgsapkrn_dir_upgrade_kernel`                    |

README.md

@@ -6,90 +6,40 @@ IBM Power Systems is a family of enterprise servers that helps transform your or
 
 Ansible Content for IBM Power Systems - AIX with SAP Software, as part of the broader offering of <b>Ansible Content for IBM Power Systems</b>, is available from Ansible Galaxy and has community support.
 
+For detail guides and reference, please visit the <a href="https://ibm.github.io/ansible-power-aix-sap/">Documentation</a> site.
 
 ## Prerequisites
 
 To execute Ansible playbooks for SAP on IBM AIX, the following is required:
 
-Control node (if on AIX)
+Control node (if on AIX):
 
     OS: AIX 7.1 TL5 or AIX 7.2 TL4 and higher
     Ansible version: 2.9 or later
     Python: 3.7 or later
     AIX OpenSSH
 
-Managed node
+Managed node:
 
     OS: AIX 7.1 TL5 or AIX 7.2 TL4 and higher
     Python on AIX: 2.7 or later
     AIX OpenSSH
+    sudo 1.9.5 (or higher)
 
 Remark: All the packages can be downloaded from:
         AIX Toolbox for Linux Applications (https://www.ibm.com/support/pages/aix-toolbox-linux-applications-downloads-alpha)
 
-
-## Installation
-
-
-
-1. Install Ansible:
-   ```bash
-   yum install ansible
-   ```
-2.
- ```bash
-   add /opt/freeware/bin to your environment (PATH variable)
-   ```
-
-3. Install the Ansible roles that you want to use:
-   ```bash
-   ansible-galaxy install <path to ansible role>
-   ```
-
-## Configuration
-
-1. On the controlling node create an Ansible configuration file:
-
-   ```bash
-   cat ~/.ansible.cfg
-
-   #remote_tmp     = ~/.ansible/tmp
-   #local_tmp      = ~/.ansible/tmp
-   inventory       = ~/.ansible/hosts
-   library         = ~/.ansible/modules
-   roles_path      = ~/.ansible/roles
-   ssh_args        = -i /home/johndoe/ssh/id_rsa
-   transfer_method = scp
-   ```
-
-2. On the controlling node create an inventory file:
-   ```bash
-   cat ~/.ansible/hosts
-
-   [ibmaix_servers]
-   ibmaixserver01.mycorp.com
-   ibmaixserver02.mycorp.com
-   ibmaixserver03.mycorp.com
-
-   [ibmaix_servers:vars]
-   ansible_python_interpreter=/opt/freeware/bin/python
-   ```
-## Security:
-If you plan to use AIX security concept RBAC (Role Bases Access Control) with Ansible, see:
-[Using RBAC with Ansible](README_AIX-RBAC_FOR_ANSIBLE.MD)
 ## Usage
 
-The following roles for administrator tasks with SAP on IBM aix are provided:
-
-### [Installing or upgrading the SAP Host Agent](roles/install_saphostagent)
-
-### [Start SAP instances](roles/start_sap)
-
-### [Stop SAP instances](roles/stop_sap)
-
-### [Upgrade the kernel of an already existing SAP system](roles/upgrade_sap_kernel)
+The following roles for administrator tasks with SAP on IBM AIX are provided:
 
-Follow the links for a detailed description of the roles.
+- Installing or upgrading the SAP Host Agent
+- Check basic operating system settings
+- Start Db2 database instances
+- Start SAP instances
+- Stop Db2 database instances
+- Stop SAP instances
+- Upgrade the SAP kernel
 
 # License
 
@@ -101,4 +51,4 @@ SAP on IBM Power Development Team
 
 # Copyright
 
-© Copyright IBM Corporation 2021
+Copyright IBM Corporation 2021,2022

docs/Makefile

@@ -0,0 +1,20 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+all:
+ sphinx-build -b html docsite/rst build
+ touch build/.nojekyll
+
+clean:
+ rm -rf build
+
+
+
+
+
+
+
+
+
+

docs/build/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: cca1104d9eeb318c3fa9b3f55d9fdb1b
+tags: 645f666f9bcd5a90fca523b33c5a78b7