From 0fe5fc80793e111c14dcc198eb5edd65ffe1595f Mon Sep 17 00:00:00 2001 From: JoeAldinger Date: Mon, 1 Jun 2026 14:51:19 -0400 Subject: [PATCH] OSDOCS-16853-2:OVN-CQA-troubleshooting --- modules/nw-ovn-kubernetes-alerts-cli.adoc | 4 +++- modules/nw-ovn-kubernetes-alerts-console.adoc | 5 ++++- .../nw-ovn-kubernetes-change-log-levels.adoc | 17 ++++++++++------- modules/nw-ovn-kubernetes-logs-cli.adoc | 3 ++- modules/nw-ovn-kubernetes-logs-console.adoc | 4 ++-- modules/nw-ovn-kubernetes-observability.adoc | 19 ++++++++----------- ...vn-kubernetes-pod-connectivity-checks.adoc | 7 +++++-- .../nw-ovn-kubernetes-readiness-probes.adoc | 3 ++- modules/observability-ovs-sampling-flags.adoc | 5 ++++- ...vn-kubernetes-troubleshooting-sources.adoc | 5 ++++- 10 files changed, 44 insertions(+), 28 deletions(-) diff --git a/modules/nw-ovn-kubernetes-alerts-cli.adoc b/modules/nw-ovn-kubernetes-alerts-cli.adoc index 399beddd34a3..e982256923ea 100644 --- a/modules/nw-ovn-kubernetes-alerts-cli.adoc +++ b/modules/nw-ovn-kubernetes-alerts-cli.adoc @@ -6,7 +6,9 @@ [id="nw-ovn-kubernetes-alerts-cli_{context}"] = Viewing OVN-Kubernetes alerts in the CLI -You can get information about alerts and their governing alerting rules and silences from the command line. +[role="_abstract"] +To view OVN-Kubernetes alerts from the command line in {product-title}, you can query the `Alertmanager` API for active alerts and related rules. + .Prerequisites diff --git a/modules/nw-ovn-kubernetes-alerts-console.adoc b/modules/nw-ovn-kubernetes-alerts-console.adoc index 2c2363e069df..e19e2fd2fd2a 100644 --- a/modules/nw-ovn-kubernetes-alerts-console.adoc +++ b/modules/nw-ovn-kubernetes-alerts-console.adoc @@ -6,13 +6,16 @@ [id="nw-ovn-kubernetes-alerts-console_{context}"] = Viewing OVN-Kubernetes alerts in the console +[role="_abstract"] +To view OVN-Kubernetes alerts in the {product-title} web console, you can open *Observe* -> *Alerting* to inspect rules, alerts, and silences. + The Alerting UI provides detailed information about alerts and their governing alerting rules and silences. .Prerequisites * You have access to the cluster as a developer or as a user with view permissions for the project that you are viewing metrics for. -.Procedure (UI) +.Procedure . In the *Administrator* perspective, select *Observe* -> *Alerting*. The three main pages in the Alerting UI in this perspective are the *Alerts*, *Silences*, and *Alerting Rules* pages. diff --git a/modules/nw-ovn-kubernetes-change-log-levels.adoc b/modules/nw-ovn-kubernetes-change-log-levels.adoc index b294140f48a3..654d4edfeccb 100644 --- a/modules/nw-ovn-kubernetes-change-log-levels.adoc +++ b/modules/nw-ovn-kubernetes-change-log-levels.adoc @@ -6,8 +6,10 @@ [id="nw-ovn-kubernetes-change-log-levels_{context}"] = Changing the OVN-Kubernetes log levels -The default log level for OVN-Kubernetes is 4. To debug OVN-Kubernetes, set the log level to 5. -Follow this procedure to increase the log level of the OVN-Kubernetes to help you debug an issue. +[role="_abstract"] +To debug OVN-Kubernetes in {product-title}, you can raise log levels by applying an `env-overrides` `ConfigMap` and restarting affected pods. + +The default log level for OVN-Kubernetes is 4. To debug OVN-Kubernetes, set the log level to 5. Follow this procedure to increase the log level of the OVN-Kubernetes to help you debug an issue. .Prerequisites @@ -48,7 +50,7 @@ metadata: name: env-overrides namespace: openshift-ovn-kubernetes data: - ci-ln-3njdr9b-72292-5nwkp-master-0: | <1> + ci-ln-3njdr9b-72292-5nwkp-master-0: | # This sets the log level for the ovn-kubernetes node process: OVN_KUBE_LOG_LEVEL=5 # You might also/instead want to enable debug logging for ovn-controller: @@ -58,14 +60,16 @@ data: OVN_KUBE_LOG_LEVEL=5 # You might also/instead want to enable debug logging for ovn-controller: OVN_LOG_LEVEL=dbg - _master: | <2> + _master: | # This sets the log level for the ovn-kubernetes master process as well as the ovn-dbchecker: OVN_KUBE_LOG_LEVEL=5 # You might also/instead want to enable debug logging for northd, nbdb and sbdb on all masters: OVN_LOG_LEVEL=dbg ---- -<1> Specify the name of the node you want to set the debug log level on. -<2> Specify `_master` to set the log levels of `ovnkube-master` components. ++ +where:: +`ci-ln-3njdr9b-72292-5nwkp-master-0:`:: Specifies the name of the node you want to set the debug log level on. +`_master:`:: Specifies `_master` to set the log levels of `ovnkube-master` components. . Apply the `ConfigMap` file by using the following command: + @@ -107,7 +111,6 @@ $ oc logs -n openshift-ovn-kubernetes --all-containers --prefix ovnkube-node-`:: Specifies the random sequence of letters for a pod from the previous step. + .Example output diff --git a/modules/nw-ovn-kubernetes-logs-cli.adoc b/modules/nw-ovn-kubernetes-logs-cli.adoc index 719ccf317601..95fa5c28de4e 100644 --- a/modules/nw-ovn-kubernetes-logs-cli.adoc +++ b/modules/nw-ovn-kubernetes-logs-cli.adoc @@ -6,7 +6,8 @@ [id="nw-ovn-kubernetes-logs-cli_{context}"] = Viewing the OVN-Kubernetes logs using the CLI -You can view the logs for each of the pods in the `ovnkube-master` and `ovnkube-node` pods using the OpenShift CLI (`oc`). +[role="_abstract"] +To view OVN-Kubernetes pod logs in {product-title}, you can use the {oc-first} to examine logs from containers in the `openshift-ovn-kubernetes` namespace. .Prerequisites diff --git a/modules/nw-ovn-kubernetes-logs-console.adoc b/modules/nw-ovn-kubernetes-logs-console.adoc index 03516acdf224..b40193260f0f 100644 --- a/modules/nw-ovn-kubernetes-logs-console.adoc +++ b/modules/nw-ovn-kubernetes-logs-console.adoc @@ -6,10 +6,10 @@ [id="nw-ovn-kubernetes-logs-console_{context}"] = Viewing the OVN-Kubernetes logs using the web console -You can view the logs for each of the pods in the `ovnkube-master` and `ovnkube-node` pods in the web console. +[role="_abstract"] +To view OVN-Kubernetes pod logs in the {product-title} web console, you can open pod logs for each container in the `openshift-ovn-kubernetes` project. .Prerequisites - * Access to the OpenShift CLI (`oc`). .Procedure diff --git a/modules/nw-ovn-kubernetes-observability.adoc b/modules/nw-ovn-kubernetes-observability.adoc index 5896231626fb..bb9861371de9 100644 --- a/modules/nw-ovn-kubernetes-observability.adoc +++ b/modules/nw-ovn-kubernetes-observability.adoc @@ -6,17 +6,20 @@ [id="nw-ovn-kubernetes-observability_{context}"] = Checking OVN-Kubernetes network traffic with OVS sampling using the CLI +[role="_abstract"] +To trace OVN-Kubernetes network traffic with OVS sampling in {product-title}, you can enable the `OVNObservability` feature gate and run `ovnkube-observ` from an `ovnkube-node` pod. + :FeatureName: Checking OVN-Kubernetes network traffic with OVS sampling include::snippets/technology-preview.adoc[] -OVN-Kubernetes network traffic can be viewed with OVS sampling via the CLI for the following network APIs: +OVN-Kubernetes network traffic can be viewed with OVS sampling via the CLI for the following network APIs: * `NetworkPolicy` * `AdminNetworkPolicy` * `BaselineNetworkPolicy` * `UserDefinedNetwork` isolation * `EgressFirewall` -* Multicast ACLs. +* Multicast ACLs. Scripts for these networking events are found in the `/usr/bin/ovnkube-observ` path of each OVN-Kubernetes node. @@ -42,7 +45,6 @@ $ oc patch --type=merge --patch '{"spec": {"featureSet": "TechPreviewNoUpgrade"} ---- + .Example output -+ [source,terminal] ---- featuregate.config.openshift.io/cluster patched @@ -56,7 +58,6 @@ $ oc get featuregate cluster -o yaml ---- + .Example output -+ [source,yaml] ---- featureGates: @@ -73,7 +74,6 @@ $ oc get pods -n -o wide ---- + .Example output -+ [source,terminal] ---- NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE READINESS GATES @@ -89,12 +89,11 @@ $ oc get pods -n openshift-ovn-kubernetes -o wide ---- + .Example output -+ [source,terminal] ---- -NAME -... READY STATUS RESTARTS AGE IP NODE NOMINATED NODE -ovnkube-node-jzn5b 8/8 Running 1 (34m ago) 37m 10.0.128.2 ci-ln-1gqp7b2-72292-bb9dv-worker-a-gtmpc +NAME +... READY STATUS RESTARTS AGE IP NODE NOMINATED NODE +ovnkube-node-jzn5b 8/8 Running 1 (34m ago) 37m 10.0.128.2 ci-ln-1gqp7b2-72292-bb9dv-worker-a-gtmpc ... ---- @@ -113,7 +112,6 @@ $ oc exec -it -n openshift-ovn-kubernetes -- bash ---- + .Example output -+ [source,terminal] ---- ... @@ -133,7 +131,6 @@ $ oc exec -it -n openshift-ovn-kubernetes -- bash ---- + .Example output -+ [source,terminal] ---- ... diff --git a/modules/nw-ovn-kubernetes-pod-connectivity-checks.adoc b/modules/nw-ovn-kubernetes-pod-connectivity-checks.adoc index 08a6af2ebca7..a561b101ac88 100644 --- a/modules/nw-ovn-kubernetes-pod-connectivity-checks.adoc +++ b/modules/nw-ovn-kubernetes-pod-connectivity-checks.adoc @@ -6,12 +6,15 @@ [id="nw-ovn-kubernetes-pod-connectivity-checks_{context}"] = Checking the OVN-Kubernetes pod network connectivity +[role="_abstract"] +To verify pod network connectivity in {product-title}, you can inspect `PodNetworkConnectivityCheck` resources in the `openshift-network-diagnostics` namespace. + The connectivity check controller, in {product-title} 4.10 and later, orchestrates connection verification checks in your cluster. These include Kubernetes API, OpenShift API and individual nodes. The results for the connection tests are stored in `PodNetworkConnectivity` objects in the `openshift-network-diagnostics` namespace. Connection tests are performed every minute in parallel. .Prerequisites -* Access to the OpenShift CLI (`oc`). -* Access to the cluster as a user with the `cluster-admin` role. +* You have access to the {oc-first}. +* You are logged in to the cluster with the `cluster-admin` role. * You have installed `jq`. .Procedure diff --git a/modules/nw-ovn-kubernetes-readiness-probes.adoc b/modules/nw-ovn-kubernetes-readiness-probes.adoc index 60410462f506..9c707f549cec 100644 --- a/modules/nw-ovn-kubernetes-readiness-probes.adoc +++ b/modules/nw-ovn-kubernetes-readiness-probes.adoc @@ -6,7 +6,8 @@ [id="nw-ovn-kubernetes-readiness-probes_{context}"] = Monitoring OVN-Kubernetes health by using readiness probes -The `ovnkube-control-plane` and `ovnkube-node` pods have containers configured with readiness probes. +[role="_abstract"] +To monitor OVN-Kubernetes component health in {product-title}, you can review readiness probe configuration and status for `ovnkube-control-plane` and `ovnkube-node` pods. .Prerequisites diff --git a/modules/observability-ovs-sampling-flags.adoc b/modules/observability-ovs-sampling-flags.adoc index 275b40d04fb6..abdd6b788957 100644 --- a/modules/observability-ovs-sampling-flags.adoc +++ b/modules/observability-ovs-sampling-flags.adoc @@ -6,7 +6,10 @@ [id="observability-ovs-sampling-flags_{context}"] = OVN-Kubernetes network traffic with OVS sampling flags -The following flags are available to view OVN-Kubernetes network traffic by using the CLI. Append these flags to the following syntax in your terminal after you have opened a bash shell inside of the `ovnkube-node` pod: +[role="_abstract"] +To filter OVN-Kubernetes traffic samples from `ovnkube-observ`, you can pass command line flags that limit output and collector options. + +After you have opened a bash shell inside of the `ovnkube-node` pod, the following flags are available and can be appended using the following syntax: .Command syntax [source,terminal] diff --git a/networking/ovn_kubernetes_network_provider/ovn-kubernetes-troubleshooting-sources.adoc b/networking/ovn_kubernetes_network_provider/ovn-kubernetes-troubleshooting-sources.adoc index 6492b4545dc6..8198bcb295e4 100644 --- a/networking/ovn_kubernetes_network_provider/ovn-kubernetes-troubleshooting-sources.adoc +++ b/networking/ovn_kubernetes_network_provider/ovn-kubernetes-troubleshooting-sources.adoc @@ -6,7 +6,10 @@ include::_attributes/common-attributes.adoc[] toc::[] -OVN-Kubernetes has many sources of built-in health checks and logs. Follow the instructions in these sections to examine your cluster. If a support case is necessary, follow the xref:../../support/gathering-cluster-data.adoc#support_gathering_data_gathering-cluster-data[support guide] to collect additional information through a `must-gather`. Only use the `-- gather_network_logs` when instructed by support. +[role="_abstract"] +To troubleshoot OVN-Kubernetes in {product-title}, you can use built-in health checks, alerting, logs, and connectivity checks. Follow these sections to examine your cluster before opening a support case. + +OVN-Kubernetes has many sources of built-in health checks and logs. Follow the instructions in these sections to examine your cluster. If a support case is necessary, collect additional information through a `must-gather` as described in the Additional resources section. Only use the `-- gather_network_logs` option when instructed by support. include::modules/nw-ovn-kubernetes-readiness-probes.adoc[leveloffset=+1]