Rename references from 'debug' to 'probe'

redhat-best-practices-for-k8s · Sep 4, 2024 · ac02a9a · ac02a9a
1 parent 8b23ee2
commit ac02a9a
Show file tree

Hide file tree

Showing 35 changed files with 173 additions and 173 deletions.
diff --git a/CATALOG.md b/CATALOG.md
@@ -899,7 +899,7 @@ Tags|telco,networking
 Property|Description
 ---|---
 Unique ID|networking-dual-stack-service
-Description|Checks that all services in namespaces under test are either ipv6 single stack or dual stack. This test case requires the deployment of the debug daemonset.
+Description|Checks that all services in namespaces under test are either ipv6 single stack or dual stack. This test case requires the deployment of the probe daemonset.
 Suggested Remediation|Configure every workload service with either a single stack ipv6 or dual stack (ipv4/ipv6) load balancer.
 Best Practice Reference|https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-&-ipv6
 Exception Process|No exception needed for optional/extended tests.
@@ -915,7 +915,7 @@ Tags|extended,networking
 Property|Description
 ---|---
 Unique ID|networking-icmpv4-connectivity
-Description|Checks that each workload Container is able to communicate via ICMPv4 on the Default OpenShift network. This test case requires the Deployment of the debug daemonset and at least 2 pods connected to each network under test(one source and one destination). If no network with more than 2 pods exists this test will be skipped.
+Description|Checks that each workload Container is able to communicate via ICMPv4 on the Default OpenShift network. This test case requires the Deployment of the probe daemonset and at least 2 pods connected to each network under test(one source and one destination). If no network with more than 2 pods exists this test will be skipped.
 Suggested Remediation|Ensure that the workload is able to communicate via the Default OpenShift network. In some rare cases, workloads may require routing table changes in order to communicate over the Default network. To exclude a particular pod from ICMPv4 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence.
 Best Practice Reference|https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-&-ipv6
 Exception Process|No exceptions - must be able to communicate on default network using IPv4
@@ -931,7 +931,7 @@ Tags|common,networking
 Property|Description
 ---|---
 Unique ID|networking-icmpv4-connectivity-multus
-Description|Checks that each workload Container is able to communicate via ICMPv4 on the Multus network(s). This test case requires the Deployment of the debug daemonset and at least 2 pods connected to each network under test(one source and one destination). If no network with more than 2 pods exists this test will be skipped.
+Description|Checks that each workload Container is able to communicate via ICMPv4 on the Multus network(s). This test case requires the Deployment of the probe daemonset and at least 2 pods connected to each network under test(one source and one destination). If no network with more than 2 pods exists this test will be skipped.
 Suggested Remediation|Ensure that the workload is able to communicate via the Multus network(s). In some rare cases, workloads may require routing table changes in order to communicate over the Multus network(s). To exclude a particular pod from ICMPv4 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence. Not applicable if MULTUS is not supported.
 Best Practice Reference|https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-high-level-cnf-expectations
 Exception Process|There is no documented exception process for this.
@@ -947,7 +947,7 @@ Tags|telco,networking
 Property|Description
 ---|---
 Unique ID|networking-icmpv6-connectivity
-Description|Checks that each workload Container is able to communicate via ICMPv6 on the Default OpenShift network. This test case requires the Deployment of the debug daemonset and at least 2 pods connected to each network under test(one source and one destination). If no network with more than 2 pods exists this test will be skipped.
+Description|Checks that each workload Container is able to communicate via ICMPv6 on the Default OpenShift network. This test case requires the Deployment of the probe daemonset and at least 2 pods connected to each network under test(one source and one destination). If no network with more than 2 pods exists this test will be skipped.
 Suggested Remediation|Ensure that the workload is able to communicate via the Default OpenShift network. In some rare cases, workloads may require routing table changes in order to communicate over the Default network. To exclude a particular pod from ICMPv6 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence. Not applicable if IPv6 is not supported.
 Best Practice Reference|https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-&-ipv6
 Exception Process|There is no documented exception process for this.
@@ -963,7 +963,7 @@ Tags|common,networking
 Property|Description
 ---|---
 Unique ID|networking-icmpv6-connectivity-multus
-Description|Checks that each workload Container is able to communicate via ICMPv6 on the Multus network(s). This test case requires the Deployment of the debug daemonset and at least 2 pods connected to each network under test(one source and one destination). If no network with more than 2 pods exists this test will be skipped.
+Description|Checks that each workload Container is able to communicate via ICMPv6 on the Multus network(s). This test case requires the Deployment of the probe daemonset and at least 2 pods connected to each network under test(one source and one destination). If no network with more than 2 pods exists this test will be skipped.
 Suggested Remediation|Ensure that the workload is able to communicate via the Multus network(s). In some rare cases, workloads may require routing table changes in order to communicate over the Multus network(s). To exclude a particular pod from ICMPv6 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it.The label value is trivial, only its presence. Not applicable if IPv6/MULTUS is not supported.
 Best Practice Reference|https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-high-level-cnf-expectations
 Exception Process|There is no documented exception process for this.

diff --git a/cmd/certsuite/claim/compare/testdata/claim_access_control.json b/cmd/certsuite/claim/compare/testdata/claim_access_control.json
@@ -28,7 +28,7 @@
         "checkDiscoveredContainerCertificationStatus": false,
         "collectorAppEndPoint": "http://localhost:8080",
         "collectorAppPassword": "test-password",
-        "debugDaemonSetNamespace": "custom-debugpods-ns",
+        "probeDaemonSetNamespace": "custom-probepods-ns",
         "executedBy": "default-executed-by",
         "managedDeployments": [
           {
@@ -9737,7 +9737,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-\u0026-ipv6",
-            "description": "Checks that all services in namespaces under test are either ipv6 single stack or dual stack. This test case requires the deployment of the debug daemonset.",
+            "description": "Checks that all services in namespaces under test are either ipv6 single stack or dual stack. This test case requires the deployment of the probe daemonset.",
             "exceptionProcess": "No exception needed for optional/extended tests.",
             "remediation": "Configure every CNF services with either a single stack ipv6 or dual stack (ipv4/ipv6) load balancer."
           },
@@ -9764,7 +9764,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-\u0026-ipv6",
-            "description": "Checks that each CNF Container is able to communicate via ICMPv4 on the Default OpenShift network. This test case requires the Deployment of the debug daemonset.",
+            "description": "Checks that each CNF Container is able to communicate via ICMPv4 on the Default OpenShift network. This test case requires the Deployment of the probe daemonset.",
             "exceptionProcess": "No exceptions - must be able to communicate on default network using IPv4",
             "remediation": "Ensure that the CNF is able to communicate via the Default OpenShift network. In some rare cases, CNFs may require routing table changes in order to communicate over the Default network. To exclude a particular pod from ICMPv4 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence."
           },
@@ -9791,7 +9791,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-high-level-cnf-expectations",
-            "description": "Checks that each CNF Container is able to communicate via ICMPv4 on the Multus network(s). This test case requires the Deployment of the debug daemonset.",
+            "description": "Checks that each CNF Container is able to communicate via ICMPv4 on the Multus network(s). This test case requires the Deployment of the probe daemonset.",
             "exceptionProcess": "There is no documented exception process for this.",
             "remediation": "Ensure that the CNF is able to communicate via the Multus network(s). In some rare cases, CNFs may require routing table changes in order to communicate over the Multus network(s). To exclude a particular pod from ICMPv4 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence. Not applicable if MULTUS is not supported."
           },
@@ -9818,7 +9818,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-\u0026-ipv6",
-            "description": "Checks that each CNF Container is able to communicate via ICMPv6 on the Default OpenShift network. This test case requires the Deployment of the debug daemonset.",
+            "description": "Checks that each CNF Container is able to communicate via ICMPv6 on the Default OpenShift network. This test case requires the Deployment of the probe daemonset.",
             "exceptionProcess": "There is no documented exception process for this.",
             "remediation": "Ensure that the CNF is able to communicate via the Default OpenShift network. In some rare cases, CNFs may require routing table changes in order to communicate over the Default network. To exclude a particular pod from ICMPv6 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence. Not applicable if IPv6 is not supported."
           },
@@ -9845,7 +9845,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-high-level-cnf-expectations",
-            "description": "Checks that each CNF Container is able to communicate via ICMPv6 on the Multus network(s). This test case requires the Deployment of the debug daemonset.",
+            "description": "Checks that each CNF Container is able to communicate via ICMPv6 on the Multus network(s). This test case requires the Deployment of the probe daemonset.",
             "exceptionProcess": "There is no documented exception process for this.",
             "remediation": "Ensure that the CNF is able to communicate via the Multus network(s). In some rare cases, CNFs may require routing table changes in order to communicate over the Multus network(s). To exclude a particular pod from ICMPv6 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it.The label value is trivial, only its presence. Not applicable if IPv6/MULTUS is not supported."
           },

diff --git a/cmd/certsuite/claim/compare/testdata/claim_observability.json b/cmd/certsuite/claim/compare/testdata/claim_observability.json
@@ -28,7 +28,7 @@
         "checkDiscoveredContainerCertificationStatus": false,
         "collectorAppEndPoint": "http://localhost:8080",
         "collectorAppPassword": "test-password",
-        "debugDaemonSetNamespace": "custom-debugpods-ns",
+        "probeDaemonSetNamespace": "custom-probepods-ns",
         "executedBy": "default-executed-by",
         "managedDeployments": [
           {
@@ -9737,7 +9737,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-\u0026-ipv6",
-            "description": "Checks that all services in namespaces under test are either ipv6 single stack or dual stack. This test case requires the deployment of the debug daemonset.",
+            "description": "Checks that all services in namespaces under test are either ipv6 single stack or dual stack. This test case requires the deployment of the probe daemonset.",
             "exceptionProcess": "No exception needed for optional/extended tests.",
             "remediation": "Configure every CNF services with either a single stack ipv6 or dual stack (ipv4/ipv6) load balancer."
           },
@@ -9764,7 +9764,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-\u0026-ipv6",
-            "description": "Checks that each CNF Container is able to communicate via ICMPv4 on the Default OpenShift network. This test case requires the Deployment of the debug daemonset.",
+            "description": "Checks that each CNF Container is able to communicate via ICMPv4 on the Default OpenShift network. This test case requires the Deployment of the probe daemonset.",
             "exceptionProcess": "No exceptions - must be able to communicate on default network using IPv4",
             "remediation": "Ensure that the CNF is able to communicate via the Default OpenShift network. In some rare cases, CNFs may require routing table changes in order to communicate over the Default network. To exclude a particular pod from ICMPv4 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence."
           },
@@ -9791,7 +9791,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-high-level-cnf-expectations",
-            "description": "Checks that each CNF Container is able to communicate via ICMPv4 on the Multus network(s). This test case requires the Deployment of the debug daemonset.",
+            "description": "Checks that each CNF Container is able to communicate via ICMPv4 on the Multus network(s). This test case requires the Deployment of the probe daemonset.",
             "exceptionProcess": "There is no documented exception process for this.",
             "remediation": "Ensure that the CNF is able to communicate via the Multus network(s). In some rare cases, CNFs may require routing table changes in order to communicate over the Multus network(s). To exclude a particular pod from ICMPv4 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence. Not applicable if MULTUS is not supported."
           },
@@ -9818,7 +9818,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-ipv4-\u0026-ipv6",
-            "description": "Checks that each CNF Container is able to communicate via ICMPv6 on the Default OpenShift network. This test case requires the Deployment of the debug daemonset.",
+            "description": "Checks that each CNF Container is able to communicate via ICMPv6 on the Default OpenShift network. This test case requires the Deployment of the probe daemonset.",
             "exceptionProcess": "There is no documented exception process for this.",
             "remediation": "Ensure that the CNF is able to communicate via the Default OpenShift network. In some rare cases, CNFs may require routing table changes in order to communicate over the Default network. To exclude a particular pod from ICMPv6 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it. The label value is trivial, only its presence. Not applicable if IPv6 is not supported."
           },
@@ -9845,7 +9845,7 @@
           "capturedTestOutput": "",
           "catalogInfo": {
             "bestPracticeReference": "https://redhat-best-practices-for-k8s.github.io/guide/#redhat-best-practices-for-k8s-high-level-cnf-expectations",
-            "description": "Checks that each CNF Container is able to communicate via ICMPv6 on the Multus network(s). This test case requires the Deployment of the debug daemonset.",
+            "description": "Checks that each CNF Container is able to communicate via ICMPv6 on the Multus network(s). This test case requires the Deployment of the probe daemonset.",
             "exceptionProcess": "There is no documented exception process for this.",
             "remediation": "Ensure that the CNF is able to communicate via the Multus network(s). In some rare cases, CNFs may require routing table changes in order to communicate over the Multus network(s). To exclude a particular pod from ICMPv6 connectivity tests, add the redhat-best-practices-for-k8s.com/skip_connectivity_tests label to it.The label value is trivial, only its presence. Not applicable if IPv6/MULTUS is not supported."
           },

diff --git a/cmd/certsuite/claim/compare/testdata/diff1.txt b/cmd/certsuite/claim/compare/testdata/diff1.txt
@@ -56,7 +56,7 @@ CONFIGURATIONS
 
 Cert Suite Configuration: Differences
 FIELD                        CLAIM 1                 CLAIM 2
-/debugDaemonSetNamespace     custom-debugpods-ns     cnf-suite
+/probeDaemonSetNamespace     custom-probepods-ns     cnf-suite
 
 Cert Suite Configuration: Only in CLAIM 1
 <none>

diff --git a/cmd/certsuite/claim/compare/testdata/diff1_reverse.txt b/cmd/certsuite/claim/compare/testdata/diff1_reverse.txt
@@ -56,7 +56,7 @@ CONFIGURATIONS
 
 CNF Cert Suite Configuration: Differences
 FIELD                        CLAIM 1       CLAIM 2
-/debugDaemonSetNamespace     cnf-suite     custom-debugpods-ns
+/probeDaemonSetNamespace     cnf-suite     custom-probepods-ns
 
 CNF Cert Suite Configuration: Only in CLAIM 1
 /targetNameSpaces/1=test-ns

diff --git a/cmd/certsuite/generate/config/config.go b/cmd/certsuite/generate/config/config.go
@@ -309,7 +309,7 @@ func createCollectorConfiguration() {
 
 func createSettingsConfiguration() {
 	settingsOptions := []configOption{
-		{Option: debugDaemonSet, Help: debugDaemonSetHelp},
+		{Option: probeDaemonSet, Help: probeDaemonSetHelp},
 		{Option: previousMenu, Help: backHelp},
 	}
 	settingsPrompt := promptui.Select{
@@ -327,8 +327,8 @@ func createSettingsConfiguration() {
 			return
 		}
 		switch settingsOptions[i].Option {
-		case debugDaemonSet:
-			loadDebugDaemonSetNamespace(getAnswer(debugDaemonSetPrompt, debugDaemonSetSyntax, debugDaemonSetExample))
+		case probeDaemonSet:
+			loadProbeDaemonSetNamespace(getAnswer(probeDaemonSetPrompt, probeDaemonSetSyntax, probeDaemonSetExample))
 		case previousMenu:
 			exit = true
 		}
@@ -467,6 +467,6 @@ func loadNonScalableStatefulSets(nonScalableStatefulSets []string) {
 	}
 }
 
-func loadDebugDaemonSetNamespace(namespace []string) {
-	certsuiteConfig.DebugDaemonSetNamespace = namespace[0]
+func loadProbeDaemonSetNamespace(namespace []string) {
+	certsuiteConfig.ProbeDaemonSetNamespace = namespace[0]
 }