You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Notice: This collection is looking for new maintainers!
2
+
> We are actively seeking contributors to help maintain and improve the `community.sap_libs` Ansible Collection.
3
+
> If you are interested in getting involved, please read our [contribution guidelines](https://github.com/sap-linuxlab/community.sap_libs/blob/main/README.md#contributing) to get started.
This repository contains the community.sap_libs Ansible Collection. The collection includes modules and plugins supported by the Ansible SAP community to help SAP landscape management.
4
-
5
-
**This collection is migrated from ansbile-collections/community.sap to sap-linuxlab/community.sap_libs.**
6
-
7
-
# SAP Module Collection for Ansible
8
-
<!-- Add CI and code coverage badges here. Samples included below. -->
<!-- Describe the collection and why a user would want to use it. What does the collection do? -->
12
-
13
-
## Code of Conduct
14
-
15
-
We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.
16
-
17
-
If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.
18
-
19
-
## Communication
20
-
21
-
<!--List available communication channels. In addition to channels specific to your collection, we also recommend to use the following ones.-->
22
-
23
-
We announce releases and important changes through Ansible's [The Bullhorn newsletter](https://github.com/ansible/community/wiki/News#the-bullhorn). Be sure you are [subscribed](https://eepurl.com/gZmiEP).
24
-
25
-
Join us in the `#ansible` (general use questions and support), `#ansible-community` (community and collection development questions), and other [Matrix/LiberaChat IRC channels](https://docs.ansible.com/ansible/devel/community/communication.html#real-time-chat).
26
-
27
-
We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.
28
-
29
-
For more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
30
-
31
-
## Contributing to this collection
5
+
## Description
6
+
This Ansible Collection provides a set of Ansible Modules designed to automate various operations on SAP systems.
32
7
33
-
<!--Describe how the community can contribute to your collection. At a minimum, fill up and include the CONTRIBUTING.md file containing how and where users can create issues to report problems or request features for this collection. List contribution requirements, including preferred workflows and necessary testing, so you can benefit from community PRs. If you are following general Ansible contributor guidelines, you can link to - [Ansible Community Guide](https://docs.ansible.com/ansible/devel/community/index.html). List the current maintainers (contributors with write or higher access to the repository). The following can be included:-->
8
+
It was migrated from repository `ansible-collections/community.sap`.
34
9
35
-
The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.
10
+
## Requirements
11
+
Some modules have external dependencies.
12
+
-`SAPCAR` binaries are required for:
13
+
-`sapcar_extract`
36
14
37
-
We are actively accepting new contributors.
15
+
- Python Library `pyrfc >= 2.4.0` is required for:
16
+
-`sap_company`
17
+
-`sap_snote`
18
+
-`sap_task_list_execute`
19
+
-`sap_user`
20
+
-`sap_pyrfc`
38
21
39
-
Any kind of contribution is very welcome.
22
+
### Important: PyRFC dependency is deprecated
23
+
**SAP has discontinued development on `PyRFC` in 2024.**
24
+
You can find more details in the [announcement](https://github.com/SAP-archive/PyRFC/issues/372) or in [deprecation notice](https://github.com/SAP-archive/PyRFC?tab=readme-ov-file#deprecation-notice).
40
25
41
-
You don't know how to start? Refer to our [contribution guide](CONTRIBUTING.md)!
26
+
The `PyRFC` library is a critical dependency for several modules in this collection, as it is a Python wrapper for the `SAP NW RFC SDK` libraries. While both `PyRFC` and the `SAP NW RFC SDK` are still available for installation and download at this time, their deprecation means they could be removed without notice.
42
27
43
-
We use the following guidelines:
28
+
We will continue to support the modules that depend on `PyRFC` for as long as both the `PyRFC` library and the `SAP NW RFC SDK` remain available. However, the moment either of them becomes unavailable, we will be forced to cease support for these modules, as they will no longer be functional.
44
29
45
-
*[CONTRIBUTING.md](CONTRIBUTING.md)
46
-
*[REVIEW_CHECKLIST.md](REVIEW_CHECKLIST.md)
47
-
*[Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html)
48
-
*[Ansible Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)
49
-
*[Ansible Collection Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections)
30
+
We are investigating potential alternatives, but there is no clear path forward at this time. Users should be aware of this risk when using the affected modules.
50
31
51
-
## Collection maintenance
32
+
## Installation Instructions
52
33
53
-
The current maintainers are listed in the [MAINTAINERS](MAINTAINERS) file. If you have questions or need help, feel free to mention them in the proposals.
34
+
### Installation
35
+
Install this collection with Ansible Galaxy command:
<!--Describe how the collection is governed. Here can be the following text:-->
48
+
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.
49
+
Example of downgrading collection to version 1.4.0:
The process of decision making in this collection is based on discussing and finding consensus among participants.
54
+
See [Installing collections](https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html) for more details on installation methods.
62
55
63
-
Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!
56
+
## Ansible Modules
57
+
The following Ansible Modules are included in this collection.
## Tested with the following Ansible and Python version combinations
68
+
## Testing
69
+
This Ansible Collection was tested across different versions of Ansible and Python.
70
+
The automated [CI](https://github.com/sap-linuxlab/community.sap_libs/blob/main/.github/workflows/ansible-test.yml) workflow is executing Sanity and Unit tests on following versions.
66
71
67
72
Supported ansible-core versions:
68
73
-`2.18` with Python `3.11 - 3.13`
@@ -83,95 +88,27 @@ modules where we are able to execute integration test we decided to disable thes
83
88
84
89
**NOTE:** All tests combinations were configured following official [ansible-core-support-matrix](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix).
85
90
86
-
## External requirements
87
-
88
-
For some modules the below requirements are needed on the host that executes a module.
89
-
90
-
- pyrfc >= 2.4.0
91
-
- SAPCAR
92
-
- SAPCONTROL
93
-
94
-
### Supported connections
95
-
<!-- Optional. If your collection supports only specific connection types (such as HTTPAPI, netconf, or others), list them here. -->
You can find more information about maintainers of this Ansible Collection at [MAINTAINERS.md](https://github.com/sap-linuxlab/community.sap_libs/blob/main/MAINTAINERS.md).
110
93
111
-
<!--Include some quick examples that cover the most common use cases for your collection content. It can include the following examples of installation and upgrade (change NAMESPACE.COLLECTION_NAME correspondingly):-->
94
+
## Contributing
95
+
You can find more information about ways you can contribute at [sap-linuxlab website](https://sap-linuxlab.github.io/initiative_contributions/).
112
96
113
-
### Installing the Collection from Ansible Galaxy
97
+
## Support
98
+
You can report any issues using [Issues](https://github.com/sap-linuxlab/community.sap_libs/issues) section.
114
99
115
-
Before using this collection, you need to install it with the Ansible Galaxy command-line tool:
You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format:
121
-
```yaml
122
-
---
123
-
collections:
124
-
- name: community.sap_libs
125
-
```
126
-
127
-
Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the `ansible` package. To upgrade the collection to the latest available version, run the following command:
You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version `1.0.0`:
See [Ansible Using collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.
139
-
140
-
## Release notes
100
+
## Release Notes and Roadmap
101
+
The release notes for this collection can be found in the [CHANGELOG file](https://github.com/sap-linuxlab/community.sap_libs/blob/main/CHANGELOG.rst).
141
102
142
-
See the [changelog](https://github.com/sap-linuxlab/community.sap_libs/tree/main/CHANGELOG.rst).
143
103
144
-
## Releasing, Versioning and Deprecation
145
-
This collection follows Semantic Versioning. More details on versioning can be found in the Ansible docs.
104
+
## Further Information
146
105
147
-
We plan to regularly release new minor or bugfix versions once new features or bugfixes have been implemented.
148
-
149
-
Releasing the current major version happens from the main branch. We will create a stable-1 branch for 1.x.y versions once we start working on a 2.0.0 release, to allow backporting bugfixes and features from the 2.0.0 branch (main) to stable-1.
150
-
151
-
For reference have a look at the issue [Releasing, Versioning and Deprecation](https://github.com/sap-linuxlab/community.sap_libs/issues/1).
152
-
153
-
154
-
155
-
## Roadmap
156
-
157
-
Please have a look at the project board.
158
-
159
-
## More information
160
-
161
-
<!-- List out where the user can find additional information, such as working group meeting times, slack/IRC channels, or documentation for the product this collection automates. At a minimum, link to: -->
-[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html)
168
-
- [The Bullhorn (the Ansible Contributor newsletter)](https://us19.campaign-archive.com/home/?u=56d874e027110e35dea0e03c1&id=d6635f5420)
169
111
-[News for Maintainers](https://github.com/ansible-collections/news-for-maintainers)
170
112
171
-
## Licensing
172
-
173
-
<!-- Include the appropriate license information here and a pointer to the full licensing details. If the collection contains modules migrated from the ansible/ansible repo, you must use the same license that existed in the ansible/ansible repo. See the GNU license example below. -->
174
-
175
-
Apache License, Version 2.0
176
-
177
-
See [LICENSE](http://www.apache.org/licenses/LICENSE-2.0) to see the full text.
0 commit comments