*Includes Account Bootstrap (aka. minimal landing zone)* |
- :white_check_mark: AWS EC2
- :x: GCP VM
- :white_check_mark: IBM Cloud, Intel VS
- :white_check_mark: IBM Cloud, Power VS
- :white_check_mark: Microsoft Azure
- :white_check_mark: IBM PowerVM LPAR
- :x: OVirt VM
- :x: VMware vSphere VM
- :white_check_mark: Preconfigure host for SAP HANA and SAP NetWeaver
- :white_check_mark: Install SAP HANA via HDBLCM, any combination
- :white_check_mark: Install SAP Software via SWPM, any combination (includes Templates)
- :warning: Install Linux Pacemaker and setup SAP HA/DR `[WIP]`
- :white_check_mark: Post-Install of SAP Software OS configuration
- :white_check_mark: SAP Systems Start/Stop
- :white_check_mark: SAP Profile updates
- :white_check_mark: SAP basic monitoring
- :white_check_mark: SAP HANA Backint backup scheduling and execution
- :white_check_mark: SAP RFC / BAPI / Task List runs
- :warning: SAP Kernel patching `[WIP]`
- :white_check_mark: SAP User ID SSO login
- :white_check_mark: Search and download by filename
- :white_check_mark: Maintenance Planner stack download
- :white_check_mark: Benchmark records extraction and compare in CSV
- :white_check_mark: Calculate storage requirements for SAP HANA (scale-up/scale-out) and SAP NetWeaver
Automated tasks and functionality include:
+ +
+
+
+
+-
+
- Provision SAP Virtual Machines (Day 0) to Infrastructure Platforms
+
-
+
- AWS EC2 Virtual Server instances +
- Google Cloud Compute Engine Virtual Machines +
- IBM Cloud, Intel Virtual Servers and Power Virtual Servers +
- Microsoft Azure Virtual Machines +
- IBM PowerVM Virtual Machines (LPARs) +
- OVirt (e.g. Red Hat Enterprise Linux KVM) +
- KubeVirt (e.g. Red Hat OpenShift Virtualization, SUSE Rancher with Harvester HCI) +
- VMware vSphere Virtual Machines +
+ - Download SAP Installation Media (Day 0)
+
-
+
- SAP User ID SSO login +
- Search and download by filename +
- Maintenance Planner stack download +
+ - Operating System preparation for SAP (Day 0)
+
-
+
- Preconfigure and tune Red Hat Enterprise Linux for SAP Solutions +
- Preconfigure and tune SUSE Linux Enterprise Server for SAP Applications +
- SAP Installations (Day 1)
+
-
+
- Install SAP HANA via HDBLCM, any combination +
- Install SAP Software via SWPM, any combination +
- Install SAP High Availability with Linux Pacemaker +
- Pre-completed Ansible Playbooks include:
+
-
+
- SAP HANA - Scale-Up, Scale-Up High Availability (Performance Optimized), Scale-Out +
- SAP S/4HANA Foundation +
- SAP S/4HANA - including Distributed High Availability with Maintenance Planner Stack +
- SAP BW/4HANA - including Scale-Out +
- SAP ECC - including SAP HANA, IBM Db2, Oracle DB, SAP ASE, SAP MaxDB +
- SAP ECC IDES +
- SAP NetWeaver AS (ABAP/JAVA) +
- SAP SolMan (ABAP/JAVA) +
- SAP WebDispatcher +
+
+ - SAP Operations (Day 2)
+
-
+
- Post-Install of SAP Software OS configuration +
- SAP System Copy Export / Import Restore +
- SAP Systems Start/Stop +
- SAP Profile updates +
- SAP HANA Backint backup scheduling and execution +
- SAP RFC / BAPI / Task List runs +
- SAP Kernel patching [WIP] +
- SAP SolMan Diagnostics Agent (SDA) installation +
+
+
+
Automation Projects within the SAP LinuxLab Open-Source Initiative include:
+ +| Project Repository | Project Description | +|:---|:---| +| [ansible.playbooks_for_sap](https://github.com/sap-linuxlab/ansible.playbooks_for_sap) | Top-level Pre-built Ansible Playbooks using the Ansible Collections for SAP; uses Ansible to provision, with optional Ansible > Terraform | +| [terraform.templates_for_sap](https://github.com/sap-linuxlab/terraform.templates_for_sap) | Top-level Pre-built Terraform Templates for deployment of various SAP solution scenarios, for every Cloud and Hypervisor | +| | | +| [community.sap_install](https://github.com/sap-linuxlab/community.sap_install) | Ansible Collection of Ansible Roles for various SAP software installation | +| [community.sap_operations](https://github.com/sap-linuxlab/community.sap_operations) | Ansible Collection of Ansible Roles for various operational tasks with SAP Systems | +| [community.sap_infrastructure](https://github.com/sap-linuxlab/community.sap_infrastructure) | | +| [community.sap_launchpad](https://github.com/sap-linuxlab/community.sap_launchpad) | Ansible Collection of Ansible Roles and Ansible Modules for various tasks using SAP Launchpad APIs | +| [community.sap_libs](https://github.com/sap-linuxlab/community.sap_libs) | | +| [terraform.modules_for_sap](https://github.com/sap-linuxlab/terraform.modules_for_sap) | Terraform Modules for each Cloud and Hypervisor and dynamic Ansible Playbooks for SAP installations. Subcomponent of the Terraform Templates for SAP | +| [demo.sap_install](https://github.com/sap-linuxlab/demo.sap_install) | Build-your-Own Demonstration usage of community.sap_install collection in Ansible Automation Platform or AWX | diff --git a/docs/contribute/contribute_01_guidelines.md b/docs/contribute/contribute_01_guidelines.md deleted file mode 100755 index 52387ce..0000000 --- a/docs/contribute/contribute_01_guidelines.md +++ /dev/null @@ -1,77 +0,0 @@ -# Contribution Guidelines - -Contributions from the community play an important role in the assets associated with the SAP LinuxLab GitHub repositories. - -## Contributions and Committers -All members of the Open Source Community are welcome to contribute to the SAP GitHub organization repositories. Contributions to the repositories can be achieved through a variety of methods including source code contributions, reviews and issue creation. - -Individuals who are interested in directly affecting repository content may request the privilege in becoming a maintainer in one or more repository for which they have made contributions in the past. -Committers play an important role within our community and act as an extension of the core teams to help facilitate key initiatives that benefit the entire community as a whole. These individuals may [request mainteiner status](../form_request_apply_as_maintainer.md) or be nominated by another member of the community for being maintainer. All requests will be reviewed by the board members along with the maintainers who are associated to a repository. - -If you have a complete new idea you want to have implemented, please contact the board - and ask yourself if you are willing to maintain this piece of code and if you want to apply for a seat in the board. If you are not able to code, go to the [discussion space](https://github.com/sap-linuxlab/sap-linuxlab.github.io/discussions) and leave your input there. - If you have pre-existing code you want to move to the SAP LinuxLab GitHub organization please fill out [this form](../form_request_submit_new_content.md) - -## Understanding Our Workflow -While there are multiple development styles, the SAP LinuxLab GitHUb community typically follows a [fork-based git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow) that is common in many Open Source projects. At a high level, this style consists of the following actions: - -- Fork the repository for which you want to make a contribution -- Create a separate branch for the work -- Create a pull request back to the originating repository being sure to follow any specific guidelines outlined in the repository -- Adjust the work based on comments received -- Await the merge by another committer - - - -## General Guidance - -When making a contribution to the repositories of the SAP LinuxLab organization, try to utilize the following set of guidelines outlined in this section. Committers should adhere to these practices as they attempt to address many (but not all) of the primary concerns associated with open source repositories and project management: - -Do: - -- Squash commits whenever possible -- Use `pre-commit` to avoid pushing non-standardized code -- Engage with the community and with contributors -- Write tests when applicable -- Discuss with other committers whenever you are unsure of something -- Create documentation, especially for new features and functionality -- Review existing content in order to avoid overwriting existing content -- Follow coding style guides where they exist -- Keep it simple - -Don’t: - -- Commit directly to the master(main) branch -- Merge pull requests you have authored -- Break existing functionality -- Ignore requests for assistance -- Go against established repository norms - -## The Board - -The SAP LinuxLab project is managed by a governor board that consists of at least one person of each foundation member. - -Companies that add projects (repositories) may apply for a seat in the governor board. This board decides on roadmaps, structure and other generic rules such as naming conventions etc. of this project. - -The board meets on a monthly cadence internally and with the maintainers to review progress. - -[Press here to view the current participating companies](../05_participating_companies.md) - -## Maintainer - -For each github repository in this project one or two responsible maintainers are elected. - -The maintainers take responsibility for the roadmap of the repository they maintain (i.e. ansible collection) - -On larger repositories it may be useful to delegate responsibility for certain tasks to sub-maintainers, e.g. for single roles in an ansible collection - -Each maintainer is responsible for watching, commenting and prioritizing issues, review and accepting or denying pull requests in a timely manner - -[press here to view maintainers or apply as maintainer](../01_projects_overview.md) diff --git a/docs/contribute/contribute_02_naming_conventions.md b/docs/contribute/contribute_02_naming_conventions.md deleted file mode 100755 index 5081165..0000000 --- a/docs/contribute/contribute_02_naming_conventions.md +++ /dev/null @@ -1,16 +0,0 @@ -# Project Naming Conventions - -The content in this github organization should be easy to find. that's why repositories should have meaningful names, so that it is easy to find content. - -The content repositories contain will be prefixed according the following schema, so that it is easy to understand what a repository contains - -| Category | Content type | Prefix | -|:---|:---|:---| -| Automation (Infrastructure-as-Code) | Terraform Templates (and Modules) | `terraform.`*description* | -| | Kubernetes (Source-to-Image) | `k8s.`*description* | -| Automation (Configuration-as-Code) | Ansible Collections (and Roles or Modules) | `community.`*collection_name* | -| | Salt | `salt.`*description* | -| Shell scripts | Tools and Utilities | `tool.`*description* | -| Documentation | Architectures | `architecture.`*sap_product_name* *(assumes Solution Architectures)* | -| Special Topics | High Availability | `high-availability.`*description* | -| Misc. | Demos and Examples | `demo.`*description* | diff --git a/docs/contribute/contribute_03_how_to_contribute.md b/docs/contribute/contribute_03_how_to_contribute.md deleted file mode 100755 index 1369461..0000000 --- a/docs/contribute/contribute_03_how_to_contribute.md +++ /dev/null @@ -1,33 +0,0 @@ -# How to contribute - -Each repository should have at least the following branches: - - - main: the latest stable release - - dev: the development branch used to do the integration tests of new commits - -Other branches are optional and on the behalf of the [repository maintainers](../01_projects_overview.md) - -If you want to contribute code please follow the follwing process - -- create or pick an issue in the repository you want to contribute to -- assign yourself to this issue -- [fork the repository](__create_a_fork.md) dev branch into your account -- make sure to follow the special code development guidelines if those exist -- make your changes -- create a pull request against the dev branch -- add at least one maintainer as reviewer - -Once the PR against the dev-branch is accepted integration tests will be done and if successful the the dev branch is merged into main branch. -The detailed process is on behalf of the repo maintainers - -## General recommendation - -To avoid incorrect commits (e.g. not lint-clean code) it is recommended to use tools like [pre-commit](https://pre-commit.com) -This tool has several plug-ins for checking the code compliance. See special guidelines below for details. -pre-commit is always running when running git-commit. The commit will only be accepted, if pre-commit returns without error. This is useful to reduce the number of invalid commits. -This is most useful if code has to be lint-clean. - -## Special guidelines - -- [Ansible Development guidelines](__ansible_dev_guidelines.md) -- [Installing pre-commit](__install_pre_commit.md) diff --git a/docs/04_faq.md b/docs/faq.md similarity index 100% rename from docs/04_faq.md rename to docs/faq.md diff --git a/docs/index.md b/docs/index.md index bc36a28..3f73364 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,15 +1,11 @@ # Welcome -Open-source by SAP Technology Partners, for SAP Customers and SAP Service Partners +Open Source Projects by SAP Technology Partners, for SAP Customers and SAP Service Partner
-The SAP LinuxLab open-source initiative provides easier creation and management of SAP environments, through unified and modular code/tools created by SAP Technology Partners - -All capabilities available through the SAP LinuxLab open-source initiative are available for SAP Customers and SAP Service Partners (re-use in products/offerings) - -[:material-github: View all Projects under the SAP LinuxLab initiative on GitHub.com](https://github.com/sap-linuxlab){ .md-button } +[:material-github: View all Projects under the SAP LinuxLab Open-Source Initiative on GitHub.com](https://github.com/sap-linuxlab){ .md-button }
- 
+
diff --git a/docs/initiative_about.md b/docs/initiative_about.md
new file mode 100644
index 0000000..26f9619
--- /dev/null
+++ b/docs/initiative_about.md
@@ -0,0 +1,13 @@
+# Initiative Overview
+
+The SAP LinuxLab Open-Source Initiative Projects are developed collaboratively between SAP Technology Partners, providing unified and modular code/tools for the benefit of SAP Customers and SAP Service Partners.
+
+All Projects are provided under the Apache 2.0 license, for re-use by any corporation; whether in-house, or in services / products by SAP Partners.
+
+The collaboration within the SAP LinuxLab Open-Source Initiative provides SAP-run Enterprises with greater consistency across different platforms, with vendor-neutrality across the technology layers.
+
+The projects within this initiative help SAP-run Enterprises with various tools, notably including automation of SAP Landscapes (Networking, Storage, Compute, Operating System, SAP Software), SAP tooling (e.g. sizing) and architectural guidance for SAP Landscapes.
+
+The ambition is to enable SAP-run Enterprises worldwide with similar daily problems, to overcome their challenges without following a singular and static approach from a single SAP Technology Partner. Instead these projects under the SAP LinuxLab can be extended and used for bespoke requirements, or used by SAP Service Partners to improve implementation and maintenance services for SAP-run Enterprises.
+
+Development Roadmap for each Project is available upon request, and core developer/s of each Project use `GitHub Issues` to understand Bugs and Feature Requests.
diff --git a/docs/contribute/__ansible_dev_guidelines.md b/docs/initiative_contribute/__ansible_dev_guidelines.md
similarity index 65%
rename from docs/contribute/__ansible_dev_guidelines.md
rename to docs/initiative_contribute/__ansible_dev_guidelines.md
index 50e1d91..f768c8f 100755
--- a/docs/contribute/__ansible_dev_guidelines.md
+++ b/docs/initiative_contribute/__ansible_dev_guidelines.md
@@ -13,53 +13,51 @@ All blocks and tasks must be named and must have a unique name in each role.
Role variables must be named as follows (example role name: sample_role)
- Role external variables start with the role name, as in:
-```
-sample_role_required_packages
+```yaml
+sample_role_required_packages: ''
```
- Role internal variables start with two underscores, followed by the role name, as in:
-```
-__sample_role_required_packages
+```yaml
+__sample_role_required_packages: ''
```
- Role variables which store the result of a set_fact has the string "_fact" after the role name part, as in:
-```
-__sample_role_fact_required_packages
+```yaml
+__sample_role_fact_required_packages: ''
```
- Role variables which store the result of a function other than set_fact has the string "_register" after the role name part, as in:
-```
-__sample_role_register_installed_packages
+```yaml
+__sample_role_register_installed_packages: ''
```
### Ansible-lint Cleaning
-Only ansible-lint clean collections can be imported into Ansible Galaxy. To avoid errors we recommend installing and using [pre-commit](__install_pre_commit.md).
+Only ansible-lint clean Ansible Collections can be imported into Ansible Galaxy.
Then the linting files `.ansible-lint` and `.yamllint.yml` are automatically maintained and installed by any `git clone` or `git pull` request.
The correct linting version is maintained by the `.pre-commit-config.yml` file.
If you do not want to use pre-commit follow this guideline:
-
- Always install and use the latest version of ansible-lint. You can find the latest release version [here](https://github.com/ansible-community/ansible-lint/releases/).
Install with:
-```
-# pip3 install ansible-lint --user
+```shell
+pip3 install ansible-lint --user
```
-- Put the following two files in the home directory of each role:
- - [.ansible-lint](https://raw.githubusercontent.com/berndfinger/sap-preconfigure/master/.ansible-lint)
- - [.yamllint.yml](https://raw.githubusercontent.com/berndfinger/sap-preconfigure/master/.yamllint.yml)
+- Put the following two files in the home directory of each role, such as:
+ - [.ansible-lint](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_general_preconfigure/.ansible-lint)
+ - [.yamllint.yml](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_general_preconfigure/.yamllint.yml)
The files are configured to enforce most default ansible-lint rules but skip others based on certain development requirements and experiences.
-- Put the following file into directory .github/workflow of each role:
- - [.github/workflows/ansible-lint.yml](https://raw.githubusercontent.com/berndfinger/sap-preconfigure/master/.github/workflows/ansible-lint.yml)
+- Put the following file into directory .github/workflow of each role, such as:
+ - [.github/workflows/ansible-lint.yml](https://github.com/sap-linuxlab/community.sap_install/tree/main/roles/sap_general_preconfigure/.github/workflows/)
-This will trigger an ansible-lint v. 5.3.0 run in a freshly created virtual system on GitHub after each git push or pull request.
+This will trigger an ansible-lint run in a freshly created virtual system on GitHub after each git push or pull request.
- For skipping certain ansible-lint checks for certain tasks only, follow the chapter "False Positives: Skipping Rules" in [https://ansible-lint.readthedocs.io/en/latest/rules.html](https://ansible-lint.readthedocs.io/en/latest/rules.html):
Add `# noqa` after the task name, followed by a space and the rule name from [Default Rules](https://ansible-lint.readthedocs.io/en/latest/default_rules.html), e.g. `package-latest`. Also add a line starting with `# Reason for noqa:`, followed by a space and a short explanation on why ansible-lint should not report a failure for the rule in this case.
-Example: [This line and the following one](https://github.com/berndfinger/sap-hana-preconfigure/blob/5be04d3a1b3f64b1966075896d9f7428fbf70a0b/tasks/RedHat/installation.yml#L83) in file tasks/RedHat/installation.yml of role sap-hana-preconfigure.
diff --git a/docs/contribute/__create_a_fork.md b/docs/initiative_contribute/__create_a_fork.md
similarity index 100%
rename from docs/contribute/__create_a_fork.md
rename to docs/initiative_contribute/__create_a_fork.md
diff --git a/docs/contribute/__install_pre_commit.md b/docs/initiative_contribute/__install_pre_commit.md
similarity index 100%
rename from docs/contribute/__install_pre_commit.md
rename to docs/initiative_contribute/__install_pre_commit.md
diff --git a/docs/form_request_apply_as_maintainer.md b/docs/initiative_contribute/form_request_apply_as_maintainer.md
similarity index 99%
rename from docs/form_request_apply_as_maintainer.md
rename to docs/initiative_contribute/form_request_apply_as_maintainer.md
index fef06aa..f52ba86 100755
--- a/docs/form_request_apply_as_maintainer.md
+++ b/docs/initiative_contribute/form_request_apply_as_maintainer.md
@@ -5,8 +5,6 @@ layout: default
## Request being a maintainers
Please fill the following form to become a maintainer
-
-
+