Pre release improvements and fixes (#19)

* Improve description and abstract in some checks * Add metadata filters for ensa and filesystem type checks * Set checks that fail as wip * Remove ensa filter and add ensa1 reference
trento-project · Oct 16, 2024 · be22dd0 · be22dd0
1 parent d14f2d9
commit be22dd0
Show file tree

Hide file tree

Showing 33 changed files with 82 additions and 10 deletions.
diff --git a/checks/0D636F.yaml b/checks/0D636F.yaml
@@ -32,6 +32,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  ensa_version:
+    - ensa2
+    - mixed_versions
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/1E91FF.yaml b/checks/1E91FF.yaml
@@ -42,6 +42,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - simple_mount
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/32CFC6.yaml b/checks/32CFC6.yaml
@@ -2,10 +2,10 @@ id: "32CFC6"
 name: corosync running 2 ring configuration
 group: Corosync
 description: |
-  Corosync is running with at least 2 rings
+  Corosync is running with minimum number of recommended rings
 remediation: |
   ## Abstract
-  It is strongly recommended to add a second ring to the corosync communication.
+  The general recommendation is to add a second ring for the corosync communication but some platforms are good with only one.
 
   ## References
   Azure:

diff --git a/checks/3A59DC.yaml → checks/3A59DC.yaml.wip b/checks/3A59DC.yaml → checks/3A59DC.yaml.wip
@@ -16,7 +16,6 @@ remediation: |
   ## References
   - https://documentation.suse.com/sles-sap/15-SP5/single-html/SLES-SAP-guide/#sec-saptune-switch-solution
 
-
 metadata:
   target_type: cluster
 

diff --git a/checks/3A9890.yaml → checks/3A9890.yaml.wip b/checks/3A9890.yaml → checks/3A9890.yaml.wip
diff --git a/checks/3AA324.yaml b/checks/3AA324.yaml
@@ -1,8 +1,8 @@
 id: "3AA324"
-name: sapping/sapping enabled - simple_mount
+name: sapping/sappong enabled - simple_mount
 group: OS services
 description: |
-  The sapping/sapping systemd services are enabled on simple mount.
+  The sapping/sappong systemd services are enabled on simple mount.
 remediation: |
   ## Abstract
   sapping/sappong systemd services must be enabled on every cluster node in the simple mount setup.
@@ -20,6 +20,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - simple_mount
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/3AA381.yaml → checks/3AA381.yaml.wip b/checks/3AA381.yaml → checks/3AA381.yaml.wip
diff --git a/checks/3AD734.yaml → checks/3AD734.yaml.wip b/checks/3AD734.yaml → checks/3AD734.yaml.wip
diff --git a/checks/3EB4C0.yaml b/checks/3EB4C0.yaml
@@ -46,6 +46,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - simple_mount
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/4DD3B5.yaml b/checks/4DD3B5.yaml
@@ -39,6 +39,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  ensa_version:
+    - ensa1
+    - mixed_versions
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/61451E.yaml b/checks/61451E.yaml
@@ -9,6 +9,8 @@ remediation: |
 
   Attention: Please do not use consecutive semicolons in the **SBD_DEVICE** variable in the SBD configuration file. This can cause problems in the cluster functionality as ``sbd`` ignores consecutive semicolons, but the ``fencing agent`` does not. Therefore they should be avoided.
 
+  This check is only applicable when disk-based SBD is configured.
+
   The SBD is not used in GCP or AWS environments.
 
   ## References

diff --git a/checks/62A0E0.yaml b/checks/62A0E0.yaml
@@ -42,6 +42,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - simple_mount
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/68626E.yaml b/checks/68626E.yaml
@@ -4,11 +4,19 @@ group: SBD
 description: |
   SBD msgwait timeout value is at least two times the watchdog timeout
 remediation: |
+  ## Abstract
+  Configure SBD msgwait timeout value to be at least two times the watchdog timeout.
+
+  This check is only applicable when disk-based SBD is configured.
+
+  The SBD is not used in GCP or AWS environments.
+
   ## Remediation
   Make sure you configure your the SBD msgwait to 2 * (SBD Watchdog Timeout) as recommended on the best practices.
 
-  The SBD is not used in GCP or AWS environments.
   ## References
+  - https://www.suse.com/support/kb/doc/?id=000017952
+
   Azure:
 
     - https://learn.microsoft.com/en-us/azure/sap/workloads/high-availability-guide-suse-pacemaker#set-up-the-iscsi-target-server-sbd-device

diff --git a/checks/801E6A.yaml b/checks/801E6A.yaml
@@ -17,6 +17,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - simple_mount
+    - mixed_fs_types
 
 facts:
   - name: compare_sapstartsrv_resource_agents

diff --git a/checks/802D5D.yaml b/checks/802D5D.yaml
@@ -72,6 +72,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - resource_managed
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/805CA4.yaml b/checks/805CA4.yaml
@@ -25,6 +25,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - simple_mount
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/83952D.yaml b/checks/83952D.yaml
@@ -34,6 +34,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - simple_mount
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/8D5080.yaml b/checks/8D5080.yaml
@@ -34,6 +34,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - resource_managed
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/8E6110.yaml b/checks/8E6110.yaml
@@ -15,6 +15,7 @@ remediation: |
   ```
 
   ## Reference
+  - https://documentation.suse.com/sbp/sap-15/html/SAP-nw740-sle15-setupguide/index.html#id-disabling-systemd-services-of-the-ascs-and-the-ers-sap-instance
   - https://documentation.suse.com/sbp/sap-15/single-html/SAP-S4HA10-setupguide-simplemount-sle15/index.html#id-disabling-systemd-services-of-the-ascs-and-the-ers-sap-instance
 metadata:
   target_type: cluster

diff --git a/checks/97E22D.yaml → checks/97E22D.yaml.wip b/checks/97E22D.yaml → checks/97E22D.yaml.wip
diff --git a/checks/A1244C.yaml → checks/A1244C.yaml.wip b/checks/A1244C.yaml → checks/A1244C.yaml.wip
diff --git a/checks/AFDA1E.yaml b/checks/AFDA1E.yaml
@@ -31,6 +31,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  ensa_version:
+    - ensa2
+    - mixed_versions
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/B089BE.yaml b/checks/B089BE.yaml
@@ -4,11 +4,16 @@ group: SBD
 description: |
   SBD watchdog timeout is set to the recommended value
 remediation: |
-  ## Remediation
-  Make sure you configure your SBD Watchdog Timeout to `the recommended value` seconds as recommended on the best practices.
+  ## Abstract
+  Configure the SBD watchdog to use the recommended value.
+
+  This check is only applicable when disk-based SBD is configured.
 
   The SBD is not used in GCP or AWS environments.
 
+  ## Remediation
+  Make sure you configure your SBD Watchdog Timeout to `the recommended value` seconds as recommended on the best practices.
+
   ## References
   Azure:
 

diff --git a/checks/B3DA7E.yaml → checks/B3DA7E.yaml.wip b/checks/B3DA7E.yaml → checks/B3DA7E.yaml.wip
diff --git a/checks/BB6874.yaml → checks/BB6874.yaml.wip b/checks/BB6874.yaml → checks/BB6874.yaml.wip
diff --git a/checks/C835E0.yaml b/checks/C835E0.yaml
@@ -32,6 +32,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  ensa_version:
+    - ensa1
+    - mixed_versions
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/CCEF3B.yaml b/checks/CCEF3B.yaml
@@ -34,6 +34,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - resource_managed
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/DA114A.yaml b/checks/DA114A.yaml
@@ -2,10 +2,10 @@ id: "DA114A"
 name: Corosync rings
 group: Corosync
 description: |
-  Corosync has at least 2 rings configured
+  Corosync has the minimum number of recommended rings configured
 remediation: |
   ## Abstract
-  It is strongly recommended to add a second ring to the corosync communication.
+  The general recommendation is to add a second ring for the corosync communication but some platforms are good with only one.
 
   ## References
   Azure:

diff --git a/checks/DAD58C.yaml b/checks/DAD58C.yaml
@@ -34,6 +34,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  filesystem_type:
+    - simple_mount
+    - mixed_fs_types
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/F0337F.yaml b/checks/F0337F.yaml
@@ -32,6 +32,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  ensa_version:
+    - ensa2
+    - mixed_versions
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/F55857.yaml b/checks/F55857.yaml
@@ -32,6 +32,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  ensa_version:
+    - ensa2
+    - mixed_versions
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/F6CFDB.yaml b/checks/F6CFDB.yaml
@@ -32,6 +32,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  ensa_version:
+    - ensa1
+    - mixed_versions
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1

diff --git a/checks/F98557.yaml b/checks/F98557.yaml
@@ -38,6 +38,9 @@ remediation: |
 metadata:
   target_type: cluster
   cluster_type: ascs_ers
+  ensa_version:
+    - ensa1
+    - mixed_versions
 facts:
   - name: cluster_sids
     gatherer: ascsers_cluster@v1