Merge pull request #468 from newkitlabs/dev

Add redhat_ocp_virt platform to sap_hypervisor_node_preconfigure
sap-linuxlab · Dec 11, 2023 · 0aa151d · 0aa151d
2 parents 2ebea3e + b072cb5
commit 0aa151d
Show file tree

Hide file tree

Showing 33 changed files with 1,353 additions and 104 deletions.
diff --git a/playbooks/sample-sap-hypervisor-redhat_ocp_virt-preconfigure.yml b/playbooks/sample-sap-hypervisor-redhat_ocp_virt-preconfigure.yml
@@ -0,0 +1,11 @@
+---
+- hosts: all
+  gather_facts: true
+  serial: 1
+  vars:
+    sap_hypervisor_node_platform: redhat_ocp_virt
+
+  tasks:
+    - name: Include Role
+      ansible.builtin.include_role:
+        name: sap_hypervisor_node_preconfigure
diff --git a/playbooks/vars/sample-variables-sap-hypervisor-node-preconfigure-rh_ocp_virt.yml b/playbooks/vars/sample-variables-sap-hypervisor-node-preconfigure-rh_ocp_virt.yml
@@ -0,0 +1,92 @@
+sap_hypervisor_node_preconfigure_cluster_config:
+
+  # URL under which the OCP cluster is reachable
+  cluster_url: ocpcluster.domain.org
+
+  # namespace under which the VMs are created, note this has to be
+  # openshift-sriov-network-operator in case of using SRIOV network
+  # devices
+  vm_namespace: sap
+
+  # Optional, configuration for trident driver for Netapp NFS filer
+  trident:
+    management: management.domain.org
+    data: datalif.netapp.domain.org
+    svm: sap_svm
+    backend: nas_backend
+    aggregate: aggregate_Name
+    username: admin
+    password: xxxxx
+    storage_driver: ontap-nas
+    storage_prefix: ocpv_sap_
+
+  # CPU cores which will be reserved for kubernetes
+  worker_kubernetes_reserved_cpus: "0,1"
+
+  # Storage device used for host path provisioner as local storage.
+  worker_localstorage_device: /dev/vdb
+
+  # detailed configuration for every worker that should be configured
+  # 
+  workers:
+    - name: worker-0                   # name must match the node name
+      networks:                        # Example network config
+        - name: sapbridge              # using a bridge
+          description: SAP bridge
+          state: up
+          type: linux-bridge
+          ipv4:
+            enabled: false
+            auto-gateway: false
+            auto-dns: false
+          bridge:
+            options:
+              stp:
+                enabled: false
+            port:
+              - name: ens1f0           # network IF name
+        - name: storage                # an SRIOV device        
+          interface: ens2f0            # network IF name
+          type: sriov
+
+        - bridge:                      # another bridge
+            options:
+              stp:
+                enabled: false
+            port:
+            - name: ens2f0             # network IF name
+          description: storage
+          mtu: 9000
+          ipv4:
+            address:
+            - ip: 192.168.1.51         # IP config
+              prefix-length: 24
+            auto-dns: false
+            auto-gateway: false
+          enabled: true
+          name: storagebridge
+          state: up
+          type: linux-bridge
+        - name: multi                  # another SRIOV device
+          interface: ens2f1            # network IF name
+          type: sriov
+
+    - name: worker-1                   # second worker configuration
+      networks:                        # Example network config
+        - name: sapbridge              # using a bridge
+          description: SAP bridge
+          state: up
+          type: linux-bridge
+          ipv4:
+            enabled: false
+            auto-gateway: false
+            auto-dns: false
+          bridge:
+            options:
+              stp:
+                enabled: false
+            port:
+              - name: ens1f0           # network IF name
+        - name: storage                # an SRIOV device        
+          interface: ens2f0            # network IF name
+          type: sriov
diff --git a/roles/sap_hypervisor_node_preconfigure/README.md b/roles/sap_hypervisor_node_preconfigure/README.md
@@ -1,17 +1,177 @@
 `EXPERIMENTAL`
 
-sap_hypervisor_node_preconfigure
-=======================
+# sap_hypervisor_node_preconfigure
+
+This role will configure the following hypervisors in order to run SAP workloads:
+* Red Hat OpenShift Virtualization (OCPV)
+* Red Hat Enterprise Virtualization (RHV) 
+
+## Platform: Red Hat OpenShift Virtualization
+
+Will configure a plain vanilla OpenShift cluster so it can be used for SAP workloads. 
+
+### Requirements
+* An OpenShift cluster, best without any previous customization. 
+* The worker nodes should have > 96GB of memory. 
+* Worker nodes need to have Intel CPUs that provide TSX feature.
+* Storage is required, e.g. via NFS, OpenShift Data Foundation or local storage. This role can setup access to a Netapp Filer via Trident storage connector. 
+Local storage will be configures using host path provisioner.
+* Point the `KUBECONFIG` environment variable to your `kubeconfig`.
+* Make the role available in case you didn't install it already in an ansible roles directory, e.g.
+* Make sure to install the dependencies mentioned below are installed.
+* To ensure your local checkout it found by ansible:
+```
+mkdir -p ~/.ansible/roles/
+ln -sf ~/community.sap_install/roles/sap_hypervisor_node_preconfigure ~/.ansible/roles/
+```
+### Dependencies
 
-This role will set and check the required settings and parameters for a hypervisor running VMs for SAP HANA.
+Needs the ansible kubernetes module and the python3 kubernetes binding. On a RHEL based system the are named
+* python3-kubernetes
+* ansible-collection-kubernetes-core
 
-Requirements
-------------
-A RHV hypervisor. 
+Needs `oc` binary available in path.
 
-Role Variables
---------------
+### Role Variables
+General variables are defined in sap_hypervisor_node_preconfigure/vars/platform_defaults_redhat_ocp_virt.yml
+```
+# Install the trident NFS storage provider. If yes, expects configuration details under
+# sap_hypervisor_node_preconfigure_cluster_config.trident, see example config.
+sap_hypervisor_node_preconfigure_install_trident: True|False
+# URL of the trident installer package to use
+sap_hypervisor_node_preconfigure_install_trident_url: https://github.com/NetApp/trident/releases/download/v23.01.0/trident-installer-23.01.0.tar.gz
+
+# should SRIOV be enabled for unsupported NICs
+sap_hypervisor_node_preconfigure_sriov_enable_unsupported_nics: True|False
+
+# Amount of memory [GB] to be reserved for the hypervisor on hosts >= 512GB
+sap_hypervisor_node_preconfigure_hypervisor_reserved_ram_host_ge_512: 64 #GB
+# Amount of memory [GB] to be reserved for the hypervisor on hosts < 512GB
+sap_hypervisor_node_preconfigure_hypervisor_reserved_ram_host_lt_512: 32 #GB
+
+# Should the check for the minimal amount of memory be ignored? Minimal amount is 96 GB
+# If ignored, the amount of $hostmemory - $reserved is allocated with a lower bound of 0 in case $reserved > $hostmemory
+sap_hypervisor_node_preconfigure_ignore_minimal_memory_check: True|False
+
+# Define if the host path provisioner should be installed in order to use a local disk as storage device.
+# Uses the following variable to be set to the storage device to be used, e.g.:
+# sap_hypervisor_node_preconfigure_cluster_config.worker_localstorage_device: /dev/sdb 
+sap_hypervisor_node_preconfigure_install_hpp: True|False
+```
+The following variables are describing the nodes and networks to be used. It can make sense to have them in a seperate file, e.g. see `playbooks/vars/sample-variables-sap-hypervisor-node-preconfigure-rh_ocp_virt.yml` for an example. 
+```
+sap_hypervisor_node_preconfigure_cluster_config:
+  # URL under which the OCP cluster is reachable
+  cluster_url: ocpcluster.domain.org
+
+  # namespace under which the VMs are created, note this has to be
+  # openshift-sriov-network-operator in case of using SRIOV network
+  # devices 
+  vm_namespace: sap
+
+  # Optional, configuration for trident driver for Netapp NFS filer
+  trident:
+    management: management.domain.org
+    data: datalif.netapp.domain.org
+    svm: sap_svm
+    backend: nas_backend
+    aggregate: aggregate_Name
+    username: admin
+    password: xxxxx
+    storage_driver: ontap-nas
+    storage_prefix: ocpv_sap_
+
+  # CPU cores which will be reserved for kubernetes
+  worker_kubernetes_reserved_cpus: "0,1"
+
+  # Storage device used for host path provisioner as local storage.
+  worker_localstorage_device: /dev/vdb
+
+  # detailed configuration for every worker that should be configured
+  workers:
+      - name: worker-0                   # name must match the node name
+        networks:                        # Example network config
+          - name: sapbridge              # using a bridge
+            description: SAP bridge
+            state: up
+            type: linux-bridge
+            ipv4:
+              enabled: false
+              auto-gateway: false
+              auto-dns: false
+            bridge:
+              options:
+                stp:
+                  enabled: false
+              port:
+                - name: ens1f0           # network IF name
+          - name: storage                # an SRIOV device        
+            interface: ens2f0            # network IF name
+            type: sriov
+
+          - bridge:                      # another bridge
+              options:
+                stp:
+                  enabled: false
+              port:
+              - name: ens2f0             # network IF name
+            description: storage
+            mtu: 9000
+            ipv4:
+              address:
+              - ip: 192.168.1.51         # IP config
+                prefix-length: 24
+              auto-dns: false
+              auto-gateway: false
+            enabled: true
+            name: storagebridge
+            state: up
+            type: linux-bridge
+          - name: multi                  # another SRIOV device
+            interface: ens2f1            # network IF name
+            type: sriov
+
+      - name: worker-1                   # second worker configuration
+        networks:                        # Example network config
+          - name: sapbridge              # using a bridge
+            description: SAP bridge
+            state: up
+            type: linux-bridge
+            ipv4:
+              enabled: false
+              auto-gateway: false
+              auto-dns: false
+            bridge:
+              options:
+                stp:
+                  enabled: false
+              port:
+                - name: ens1f0           # network IF name
+          - name: storage                # an SRIOV device        
+            interface: ens2f0            # network IF name
+            type: sriov                        
+```
+### Example Playbook
+See `playbooks/sample-sap-hypervisor-redhat_ocp_virt-preconfigure.yml` for an example.
 
+### Example Usage
+Make sure to set the `KUBECONFIG` environment variable, e.g.
+```
+export KUBECONFIG=~/.kubeconfig
+```
+To invoke the example playbook with the example configuration using your localhost as ansible host use the following command line:
+```
+ansible-playbook --connection=local -i localhost,  playbooks/sample-sap-hypervisor-redhat_ocp_virt-preconfigure.yml -e @s/sample-sap-hypervisor-redhat_ocp_virt-preconfigure.yml
+```
+
+## Platform: RHEL KVM
+This Ansible Role allows preconfigure of Red Hat Virtualization (RHV), formerly called Red Hat Enterprise Virtualization (RHEV) prior to version 4.4 release. Red Hat Virtualization (RHV) consists of 'Red Hat Virtualization Manager (RHV-M)' and the 'Red Hat Virtualization Host (RHV-H)' hypervisor nodes that this Ansible Role preconfigures. Please note, Red Hat Virtualization is discontinued and maintenance support will end mid-2024. Extended life support for RHV ends mid-2026.
+This Ansible Role does not preconfigure RHEL KVM (RHEL-KVM) hypervisor nodes. Please note that RHEL KVM is standalone, and does not have Management tooling (previously provided by RHV-M).
+
+### Requirements
+* A RHV hypervisor. 
+
+### Role Variables
 `sap_hypervisor_node_preconfigure_reserved_ram (default: 100)` Reserve memory [GB] for hypervisor host. Depending in the use case should be at least 50-100GB. 
 
 `sap_hypervisor_node_preconfigure_reserve_hugepages (default: static)` Hugepage allocation method: {static|runtime}.
@@ -43,30 +203,37 @@ runtime: done with hugeadm which is faster, but can in some cases not ensure all
 `sap_hypervisor_node_preconfigure_run_grub2_mkconfig (default: yes)` Update the grub2 config.
 
 
-Example Playbook
-----------------
-
+### Example Playbook
 Simple example that just sets the parameters.
 ```
+---
 - hosts: all
-  roles:
-    - sap_hypervisor_node_preconfigure
+  gather_facts: true
+  serial: 1
+  vars:
+    sap_hypervisor_node_platform: redhat_rhel_kvm
+  tasks:
+    - name: Include Role
+      ansible.builtin.include_role:
+        name: sap_hypervisor_node_preconfigure
 ```
 
 Run in assert mode to verify that parameters have been set.
 ```
+---
 - hosts: all
-  roles:
-    - sap_hypervisor_node_preconfigure
+  gather_facts: true
+  serial: 1
   vars:
-    - sap_hypervisor_node_preconfigure_assert: yes
+    sap_hypervisor_node_platform: redhat_rhel_kvm
+    sap_hypervisor_node_preconfigure_assert: yes
+  tasks:
+    - name: Include Role
+      ansible.builtin.include_role:
+        name: sap_hypervisor_node_preconfigure
 ```
-License
--------
-
+### License
 Apache 2.0
 
-Author Information
-------------------
-
+### Author Information
 Nils Koenig ([email protected])