Merge pull request #75702 from ShaunaDiaz/OSDOCS-9763-2

OSDOCS-9763-2: Debug GitOps MicroShift

Author: ShaunaDiaz

microshift_running_apps/microshift-gitops.adoc

@@ -21,9 +21,8 @@ By using the GitOps with Argo CD agent with {microshift-short}, you can utilize
 
 include::modules/microshift-gitops-adding-apps.adoc[leveloffset=+1]
 
-[id="additional-resourcess{context}"]
+[role="_additional-resources"]
 .Additional resources
-
 * xref:../microshift_install/microshift-install-rpm.adoc#microshift-installing-rpms-for-gitops_microshift-install-rpm[Installing the GitOps Argo CD manifests from an RPM package]
 
 [id="microshift-gitops-cannot-do_{context}"]
@@ -33,11 +32,21 @@ GitOps with Argo CD for {microshift-short} has the following differences from th
 * The `gitops-operator` component is not used with {microshift-short}.
 * To maintain the small resource use of {microshift-short}, the Argo CD web console is not available. You can use the Argo CD CLI or use a pull-based approach.
 * Because {microshift-short} is single-node, there is no multi-cluster support. Each instance of {microshift-short} is paired with a local GitOps agent.
-* Use sos reports for debugging because `oc adm must-gather` is not available in {microshift-short}.
+* The `oc adm must-gather` command is not available in {microshift-short}.
+
+[id="microshift-gitops-troubleshooting_{context}"]
+== Troubleshooting GitOps
+If you have problems with your GitOps controller, you can use either the {oc-first} tool or run an sos report.
+
+include::modules/microshift-gitops-debug.adoc[leveloffset=+2]
+
+include::modules/microshift-gathering-sos-report.adoc[leveloffset=+2]
 
 [id="additional-resources_microshift-gitops_{context}"]
 [role="_additional-resources"]
 == Additional resources
+* xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[Using sos reports]
+
 * link:https://access.redhat.com/documentation/en-us/red_hat_openshift_gitops/1.12[Red Hat OpenShift GitOps]
 
-* xref:../microshift_support/microshift-sos-report.adoc#microshift-sos-report[Using sos reports]
+* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/getting_the_most_from_your_support_experience/generating-an-sos-report-for-technical-support_getting-the-most-from-your-support-experience[Generating an sos report for technical support] (Red Hat Enterprise Linux)

modules/microshift-gitops-debug.adoc

@@ -0,0 +1,35 @@
+// Module included in the following assemblies:
+//
+// microshift_running_apps/microshift-gitops.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="microshift-gitops-debug_{context}"]
+= Debugging GitOps with oc adm inspect
+
+You can debug GitOps by using the {oc-first}.
+
+.Prerequisites
+
+* The `oc` command line tool is installed.
+
+.Procedure
+
+. Run the `oc adm inspect` command when in the GitOps namespace:
++
+[source,terminal]
+----
+$ oc adm inspect ns/openshift-gitops
+----
++
+.Example output
+[source,terminal]
+----
+Gathering data for ns/openshift-gitops...
+W0501 20:34:35.978508 57625 util.go:118] the server doesn't have a resource type egressfirewalls, skipping the inspection
+W0501 20:34:35.980881 57625 util.go:118] the server doesn't have a resource type egressqoses, skipping the inspection
+W0501 20:34:36.040664 57625 util.go:118] the server doesn't have a resource type servicemonitors, skipping the inspection
+Wrote inspect data to inspect.local.2673575938140296280.
+----
+
+.Next steps
+* If `oc adm inspect` did not provide the information you need, you can run an sos report.