|
2 | 2 |
|
3 | 3 | 
|
4 | 4 |
|
5 |
| -This Ansible Collection executes various SAP Software installations and configuration tasks for running various SAP solutions and deployment scenarios on Linux operating systems (RHEL or SLES). |
| 5 | +## Description |
6 | 6 |
|
7 |
| -This includes handlers for SAP HANA database lifecycle manager (HDBLCM) and SAP Software Provisioning Manager (SWPM), and can be combined with other Ansible Collections to provide end-to-end automation _(e.g. provision, download, install, operations)_. |
| 7 | +This Ansible Collection executes various SAP Software installations and configuration tasks for various SAP solutions and deployment scenarios on supported Linux operating systems. |
8 | 8 |
|
| 9 | +Included roles cover range of tasks: |
| 10 | +- Preparation of Operating system and SAP installation media before installation |
| 11 | +- Installation of SAP Database, either SAP HANA or Oracle Database |
| 12 | +- Installation of SAP Products, like SAP S4HANA, SAP BW4HANA, SAP Netweaver, SAP Solution Manager and others. |
| 13 | +- Configuration of replication of SAP HANA and High Availability clusters for SAP HANA and SAP Netweaver |
9 | 14 |
|
10 |
| -**Examples of verified installations include:** |
11 | 15 |
|
| 16 | +## Requirements |
| 17 | + |
| 18 | +### Control Nodes |
| 19 | +Operating system: |
| 20 | +- Any operating system with required Python and Ansible versions. |
| 21 | + |
| 22 | +Python: 3.11 or higher |
| 23 | + |
| 24 | +Ansible: 9.9.x |
| 25 | + |
| 26 | +Ansible-core: 2.16.x |
| 27 | + |
| 28 | +**NOTE: Ansible 10 and ansible-core 2.17.x are not supported, because of breaking changes requiring higher Python version on managed nodes.** |
| 29 | + |
| 30 | +### Managed Nodes |
| 31 | +Operating system: |
| 32 | +- SUSE Linux Enterprise Server for SAP applications 15 SP5+ (SLE4SAP) |
| 33 | +- Red Hat Enterprise Linux for SAP Solutions 8.x 9.x (RHEL4SAP) |
| 34 | + |
| 35 | +**NOTE: Operating system needs to have access to required package repositories either directly or via subscription registration.** |
| 36 | + |
| 37 | + |
| 38 | +Python: 3.6 or higher |
| 39 | + |
| 40 | + |
| 41 | +## Installation Instructions |
| 42 | + |
| 43 | +### Installation |
| 44 | +Install this collection with Ansible Galaxy command: |
| 45 | +```console |
| 46 | +ansible-galaxy collection install community.sap_install |
| 47 | +``` |
| 48 | + |
| 49 | +Optionally you can include collection in requirements.yml file and include it together with other collections using: `ansible-galaxy collection install -r requirements.yml` |
| 50 | +Requirements file need to be maintained in following format: |
| 51 | +```yaml |
| 52 | +collections: |
| 53 | + - name: community.sap_install |
| 54 | +``` |
| 55 | +
|
| 56 | +### Upgrade |
| 57 | +Installed Ansible Collection will not be upgraded automatically when Ansible package is upgraded. |
| 58 | +
|
| 59 | +To upgrade the collection to the latest available version, run the following command: |
| 60 | +```console |
| 61 | +ansible-galaxy collection install community.sap_install --upgrade |
| 62 | +``` |
| 63 | + |
| 64 | +You can also install a specific version of the collection, when you encounter issues with latest version. Please report these issues in affected Role repository if that happens. |
| 65 | +Example of downgrading collection to version 1.4.0: |
| 66 | +``` |
| 67 | +ansible-galaxy collection install community.sap_install:==1.4.0 |
| 68 | +``` |
| 69 | + |
| 70 | +See [Installing collections](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html) for more details on installation methods. |
| 71 | + |
| 72 | + |
| 73 | +## Use Cases |
| 74 | + |
| 75 | +### Example Scenarios |
| 76 | +- Preparation of Operating system for SAP installation |
| 77 | +- Preparation of SAP installation media for SAP installation |
| 78 | +- Installation of SAP HANA (including High Availability with replication) or Oracle Database |
| 79 | +- Installation of SAP S4HANA or other SAP products |
| 80 | +- Configuration of Pacemaker cluster for SAP HANA and SAP Netweaver |
| 81 | + |
| 82 | +More deployment scenarios are available in [ansible.playbooks_for_sap](https://github.com/sap-linuxlab/ansible.playbooks_for_sap) repository. |
| 83 | + |
| 84 | +### Ansible Roles |
| 85 | +All included roles can be executed independently or as part of [ansible.playbooks_for_sap](https://github.com/sap-linuxlab/ansible.playbooks_for_sap) playbooks. |
| 86 | + |
| 87 | +| Name | Summary | |
| 88 | +| :--- | :--- | |
| 89 | +| [sap_anydb_install_oracle](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_anydb_install_oracle) | Install Oracle DB 19.x for SAP | |
| 90 | +| [sap_general_preconfigure](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_general_preconfigure) | Configure general OS settings for SAP software | |
| 91 | +| [sap_ha_install_hana_hsr](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_ha_install_hana_hsr) | Configure and enable SAP HANA System Replication | |
| 92 | +| [sap_ha_pacemaker_cluster](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_ha_pacemaker_cluster) | Configure Pacemaker cluster for SAP HANA and SAP Netweaver | |
| 93 | +| [sap_hana_install](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_hana_install) | Install SAP HANA via HDBLCM | |
| 94 | +| [sap_hana_preconfigure](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_hana_preconfigure) | Configure OS settings for SAP HANA database server | |
| 95 | +| [sap_hostagent](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_hostagent) | Install SAP Host Agent | |
| 96 | +| [sap_install_media_detect](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_install_media_detect) | Detect and extract SAP Software installation media | |
| 97 | +| [sap_maintain_etc_hosts](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_maintain_etc_hosts) | Maintain the /etc/hosts file of an SAP software host | |
| 98 | +| [sap_netweaver_preconfigure](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_netweaver_preconfigure) | Configure OS settings for SAP NetWeaver application server | |
| 99 | +| [sap_storage_setup](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_storage_setup) | Configure storage for SAP system (Folder structure, LVM, XFS, NFS) | |
| 100 | +| [sap_swpm](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_swpm) | Install SAP Software via SWPM | |
| 101 | + |
| 102 | + |
| 103 | +## Testing |
| 104 | +This Ansible Collection was tested across different Operating Systems, SAP products and scenarios. You can find examples of some of them below. |
| 105 | + |
| 106 | +Operating systems: |
| 107 | +- SUSE Linux Enterprise Server for SAP applications 15 SP5+ (SLE4SAP) |
| 108 | +- Red Hat Enterprise Linux for SAP Solutions 8.x 9.x (RHEL4SAP) |
| 109 | + |
| 110 | +Deployment scenarios: |
| 111 | +- All scenarios included in [ansible.playbooks_for_sap](https://github.com/sap-linuxlab/ansible.playbooks_for_sap) repository |
| 112 | + |
| 113 | +SAP Products: |
12 | 114 | - SAP S/4HANA AnyPremise (1809, 1909, 2020, 2021, 2022, 2023) with setup as Standard, Distributed, High Availability and optional Maintenance Planner or Restore System Copy
|
13 | 115 | - SAP Business Suite (ECC) on HANA and SAP Business Suite (ECC) with SAP AnyDB - SAP ASE, SAP MaxDB, IBM Db2, Oracle DB
|
14 | 116 | - SAP BW/4HANA (2021, 2023) with setup as Standard or Scale-Out
|
15 | 117 | - SAP HANA 2.0 (SPS04+) with setup as Scale-Up, Scale-Out, High Availability
|
16 | 118 | - Other SAP installation activities; such as System Rename, System Copy Export, SAP Solution Manager and SAP Web Dispatcher
|
17 | 119 |
|
| 120 | +**NOTE: It is not possible to test every Operating System and SAP Product combination with every release. Testing is regularly done for common scenarios: SAP HANA, SAP HANA HA, SAP S4HANA Distributed HA** |
18 | 121 |
|
19 |
| -**Please read the [full documentation](/docs#readme) for how-to guidance, requirements, and all other details. Summary documentation is below:** |
| 122 | +## Contributing |
| 123 | +You can find more information about ways you can contribute at [sap-linuxlab website](https://sap-linuxlab.github.io/initiative_contributions/). |
20 | 124 |
|
21 | 125 |
|
22 |
| -## Contents |
| 126 | +## Support |
| 127 | +You can report any issues using [Issues](https://github.com/sap-linuxlab/community.sap_install/issues) section. |
23 | 128 |
|
24 |
| -Within this Ansible Collection, there are various Ansible Roles and no custom Ansible Modules. |
25 | 129 |
|
26 |
| -### Ansible Roles |
| 130 | +## Release Notes and Roadmap |
| 131 | +You can find the release notes of this collection in [Changelog file](https://github.com/sap-linuxlab/community.sap_install/blob/main/CHANGELOG.rst) |
27 | 132 |
|
28 |
| -| Name | Summary | |
29 |
| -| :--- | :--- | |
30 |
| -| [sap_anydb_install_oracle](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_anydb_install_oracle) | install Oracle DB 19.x for SAP | |
31 |
| -| [sap_general_preconfigure](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_general_preconfigure) | configure general OS settings for SAP software | |
32 |
| -| [sap_ha_install_hana_hsr](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_ha_install_hana_hsr) | install SAP HANA System Replication | |
33 |
| -| [sap_ha_pacemaker_cluster](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_ha_pacemaker_cluster) | install and configure pacemaker and SAP resources | |
34 |
| -| [sap_hana_install](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_hana_install) | install SAP HANA via HDBLCM | |
35 |
| -| [sap_hana_preconfigure](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_hana_preconfigure) | configure settings for SAP HANA database server | |
36 |
| -| [sap_hostagent](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_hostagent) | install SAP Host Agent | |
37 |
| -| [sap_install_media_detect](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_install_media_detect) | detect and extract SAP Software installation media | |
38 |
| -| [sap_maintain_etc_hosts](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_maintain_etc_hosts) | maintain the /etc/hosts file of an SAP software host | |
39 |
| -| [sap_netweaver_preconfigure](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_netweaver_preconfigure) | configure settings for SAP NetWeaver application server | |
40 |
| -| [sap_storage_setup](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_storage_setup) | configure storage for SAP HANA, with LVM partitions and XFS filesystem | |
41 |
| -| [sap_swpm](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_swpm) | install SAP Software via SWPM | |
42 | 133 |
|
43 |
| -## License |
| 134 | +## Further Information |
44 | 135 |
|
45 |
| -- [Apache 2.0](./LICENSE) |
| 136 | +### Variable Precedence Rules |
| 137 | +Please follow [Ansible Precedence guidelines](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_variables.html#variable-precedence-where-should-i-put-a-variable) on how to pass variables when using this collection. |
46 | 138 |
|
47 |
| -## Contributors |
| 139 | +### Getting Started |
| 140 | +More information on how to execute Ansible playbooks is in [Getting started guide](https://github.com/sap-linuxlab/community.sap_install/blob/main/docs/getting_started/README.md). |
48 | 141 |
|
49 |
| -Contributors to the Ansible Roles within this Ansible Collection, are shown within [/docs/contributors](./docs/CONTRIBUTORS.md). |
| 142 | + |
| 143 | +## License |
| 144 | +[Apache 2.0](https://github.com/sap-linuxlab/community.sap_install/blob/main/LICENSE) |
0 commit comments