Skip to content

Commit 0684c48

Browse files
author
Bernd Finger
committed
init
0 parents  commit 0684c48

File tree

123 files changed

+5185
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+5185
-0
lines changed

‎.github/workflows/ansible-lint.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Ansible Lint
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
ansible-lint:
7+
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v2
12+
13+
- name: Lint Ansible Playbook
14+
uses: ansible/ansible-lint-action@master
15+
with:
16+
targets: |
17+
./
18+
./roles
19+
override-deps: |
20+
ansible==4.8.0
21+
ansible-core==2.11.6
22+
ansible-lint==5.2.1
23+
24+
# Static: use Ansible Community Edition 4.8.0, with lowest compatible Ansible Core 2.11.6 and use Ansible-lint 5.2.1

‎.gitignore

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# .gitignore defines files to ignore and remain untracked in Git
2+
# Each line in a gitignore file specifies a pattern, eg. directory or file extension
3+
4+
# Git should not track binary artifacts such as images, libraries, executables, archive files etc.
5+
# Until the team has mature processes, a Binary Artifacts Repository Manager is not in use.
6+
7+
# Therefore some binary artifacts are tracked in this Git repository
8+
9+
10+
# Further .gitignore templates available at:
11+
# https://github.com/github/gitignore
12+
13+
14+
# macOS OS generated files
15+
.DS_Store
16+
._*
17+
.Spotlight-V100
18+
.Trashes
19+
20+
# Windows OS generated files #
21+
ehthumbs.db
22+
Thumbs.db
23+
24+
# Compressed Archives
25+
# git has built-in compression
26+
# *.7z
27+
# *.dmg
28+
# *.gz
29+
# *.iso
30+
# *.jar
31+
# *.rar
32+
# *.tar
33+
# *.zip
34+
35+
# Binaries / Compiled source
36+
# *.com
37+
# *.class
38+
# *.dll
39+
# *.exe
40+
# *.o
41+
# *.so
42+
43+
# Logs and databases
44+
# *.log
45+
# *.sqlite
46+
47+
# Byte-compiled / optimized / DLL files
48+
__pycache__/
49+
*.py[cod]
50+
*$py.class
51+
52+
# VSCode
53+
.vscode
54+

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# community.sap_operations Ansible Collection ![Ansible Lint](https://github.com/infrasap/community.sap_operations/workflows/Ansible%20Lint/badge.svg?branch=main)
2+
3+
This Ansible Collection executes various SAP Systems operational tasks, which can be used day-to-day individually or combined for more complex regular maintainance automation
4+
5+
## Functionality
6+
7+
This Ansible Collection executes various SAP Systems operational tasks, including:
8+
9+
- **OS configuration Post-install of SAP Software**
10+
- Create ansible user for managing systems
11+
- Update /etc/hosts file
12+
- Update SSH authorized known hosts file
13+
- Update fapolicy entries based on SAP System instance numbers
14+
- Update firewall port entries based on SAP System instance numbers
15+
- License registration and refresh for RHEL subscription manager
16+
- **SAP administration tasks**
17+
- Start/Stop of SAP HANA and SAP NetWeaver (in any configuration)
18+
- Update SAP profile files
19+
20+
## Contents
21+
22+
An Ansible Playbook can call either an Ansible Role, or the individual Ansible Modules:
23+
- **Ansible Roles** (runs multiple Ansible Modules)
24+
- **Ansible Modules** (and adjoining Python/Bash Functions)
25+
26+
For further information regarding the development, code structure and execution workflow please read the [Development documentation](./docs/DEVELOPMENT.md).
27+
28+
Within this Ansible Collection, there are various Ansible Roles and Ansible Modules.
29+
30+
#### Ansible Roles
31+
32+
| Name                    | Summary |
33+
| :-- | :-- |
34+
| [os_ansible_user](/roles/os_ansible_user) | creates Ansible user `ansadm` with ssh key |
35+
| [os_etchosts](/roles/os_etchosts) | updates `/etc/hosts` |
36+
| [os_knownhosts](/roles/os_knownhosts) | updates known hosts file `/.ssh/known_hosts` |
37+
| [sap_control](/roles/sap_control) | starting and stopping SAP systems |
38+
| [sap_fapolicy](/roles/sap_fapolicy) | update service `fapolicyd` for generic / sap nw / sap hana related uids |
39+
| [sap_firewall](/roles/sap_firewall) | update service `firewalld` for generic / sap nw / sap hana related ports |
40+
| [sap_profile_update](/roles/sap_profile_update) | update default and instance profiles |
41+
| [sap_rhsm](/roles/sap_rhsm) | Red Hat subscription manager registration |
42+
43+
#### Ansible Modules
44+
45+
| Name                    | Summary |
46+
| :-- | :-- |
47+
| [sap_operations.sap_facts](/docs/module_sap_facts.md) | gather SAP facts in a host (e.g. SAP System IDs and SAP System Instance Numbers of either SAP HANA database server or SAP NetWeaver application server) |
48+
| [sap_operations.sap_monitor_hana_status](/docs/module_sap_monitor.md) | check status of running SAP HANA database server |
49+
| [sap_operations.sap_monitor_nw_status](/docs/module_sap_monitor.md) | check status of running SAP NetWeaver application server |
50+
| [sap_operations.sap_monitor_nw_perf](/docs/module_sap_monitor.md) | check host performance metrics from SAP NetWeaver Primary Application Server (PAS) instance |
51+
| [sap_operations.sap_monitor_nw_response](/docs/module_sap_monitor.md) | check system response time metrics from SAP NetWeaver Primary Application Server (PAS) instance |
52+
53+
## Execution examples
54+
55+
There are various methods to execute the Ansible Collection, dependant on the use case. For more information, see [Execution examples with code samples](./docs/EXEC_EXAMPLES.md) and the summary below:
56+
57+
| Execution Scenario | Use Case | Target |
58+
| --- | --- | --- |
59+
| Ansible Playbook <br/>-> source Ansible Collection <br/>-> execute Ansible Task <br/>--> run Ansible Module <br/>---> run Python/Bash Functions | Simple executions with a few activities | Localhost or Remote |
60+
| Ansible Playbook <br/>-> source Ansible Collection <br/>-> execute Ansible Task <br/>--> run Ansible Role <br/>---> run Ansible Module <br/>----> run Python/Bash Functions <br/>--> run Ansible Role<br/>---> ... | Complex executions with various interlinked activities;<br/> run in parallel or sequentially | Localhost or Remote |
61+
| Python/Bash Functions | Simple testing or non-Ansible use cases | Localhost |
62+
63+
## Requirements, Dependencies and Testing
64+
65+
### Operating System requirements
66+
67+
Designed for Linux operating systems, e.g. RHEL and SLES.
68+
69+
This role has not been tested and amended for SAP NetWeaver Application Server instantiations on IBM AIX or Windows Server.
70+
71+
Assumptions for executing this role include:
72+
- Registered OS License and OS Package repositories are available (from the relevant content delivery network of the OS vendor)
73+
74+
### Python requirements
75+
76+
Python 3 from the execution/controller host.
77+
78+
### Testing on execution/controller host
79+
80+
**Tests with Ansible Core release versions:**
81+
- Ansible Core 2.11.5 community edition
82+
83+
**Tests with Python release versions:**
84+
- Python 3.9.7 (i.e. CPython distribution)
85+
86+
**Tests with Operating System release versions:**
87+
- RHEL 8.4
88+
- macOS 11.6 (Big Sur), with Homebrew used for Python 3.x via PyEnv
89+
90+
### Testing on target/remote host
91+
92+
**Tests with Operating System release versions:**
93+
- RHEL 8.2 for SAP
94+
95+
## License
96+
97+
- [Apache 2.0](./LICENSE)
98+
99+
## Contributors
100+
101+
Contributors to the Ansible Roles within this Ansible Collection, are shown within [/docs/contributors](./docs/CONTRIBUTORS.md).

‎docs/.gitkeep

Whitespace-only changes.

‎docs/CONTRIBUTORS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Development contributors
2+
3+
- **IBM Lab for SAP Solutions**
4+
- IBM Consulting
5+
- **Jason Masipiquena** - Developer of Ansible Collection constructs and Ansible Modules, and project owner
6+
- **Sherard Guico** - Sponsor and technical review
7+
- IBM Cloud
8+
- **Sean Freeman** - Reviewer

0 commit comments

Comments
 (0)