From 66eac058c4c85f41b6ce84e9076aff78e148ba26 Mon Sep 17 00:00:00 2001 From: Shauna Diaz Date: Tue, 29 Nov 2022 15:47:47 -0500 Subject: [PATCH] OSDOCS-4614 making corrections to Troubleshooting book --- _topic_maps/_topic_map_ms.yml | 6 ++++-- .../microshift-known-issues.adoc | 10 ++++++++++ .../microshift-troubleshooting.adoc | 15 --------------- .../microshift-version.adoc | 12 ++++++++++++ modules/microshift-ki-cni-iptables-deleted.adoc | 13 +++++++------ modules/microshift-version-api.adoc | 6 +++--- modules/microshift-version-cli.adoc | 5 +++-- 7 files changed, 39 insertions(+), 28 deletions(-) create mode 100644 microshift_troubleshooting/microshift-known-issues.adoc delete mode 100644 microshift_troubleshooting/microshift-troubleshooting.adoc create mode 100644 microshift_troubleshooting/microshift-version.adoc diff --git a/_topic_maps/_topic_map_ms.yml b/_topic_maps/_topic_map_ms.yml index 078b7a20b9..65b6085a1b 100644 --- a/_topic_maps/_topic_map_ms.yml +++ b/_topic_maps/_topic_map_ms.yml @@ -152,5 +152,7 @@ Name: Troubleshooting Dir: microshift_troubleshooting Distros: microshift Topics: -- Name: MicroShift Troubleshooting - File: microshift-troubleshooting +- Name: Checking your version + File: microshift-version +- Name: Known issues + File: microshift-known-issues diff --git a/microshift_troubleshooting/microshift-known-issues.adoc b/microshift_troubleshooting/microshift-known-issues.adoc new file mode 100644 index 0000000000..61dfff571a --- /dev/null +++ b/microshift_troubleshooting/microshift-known-issues.adoc @@ -0,0 +1,10 @@ +:_content-type: ASSEMBLY +[id="microshift-known-issues"] += Troubleshoot known issues +include::_attributes/attributes-microshift.adoc[] +:context: microshift-known-issues +toc::[] + +Read about known issues and possible solutions. + +include::modules/microshift-ki-cni-iptables-deleted.adoc[leveloffset=+1] diff --git a/microshift_troubleshooting/microshift-troubleshooting.adoc b/microshift_troubleshooting/microshift-troubleshooting.adoc deleted file mode 100644 index bc674b1ac0..0000000000 --- a/microshift_troubleshooting/microshift-troubleshooting.adoc +++ /dev/null @@ -1,15 +0,0 @@ -:_content-type: ASSEMBLY -[id="microshift-troubleshooting"] -= Check your version and known issues -include::_attributes/attributes-microshift.adoc[] -:context: microshift-troubleshooting -toc::[] - -Determine which version of {product-title} you have, find out about known issues, and troubleshoot problems. - -include::modules/microshift-version-cli.adoc[leveloffset=+1] - -include::modules/microshift-version-api.adoc[leveloffset=+1] - -include::modules/microshift-ki-cni-iptables-deleted.adoc[leveloffset=+1] - diff --git a/microshift_troubleshooting/microshift-version.adoc b/microshift_troubleshooting/microshift-version.adoc new file mode 100644 index 0000000000..fafeb134c8 --- /dev/null +++ b/microshift_troubleshooting/microshift-version.adoc @@ -0,0 +1,12 @@ +:_content-type: ASSEMBLY +[id="microshift-version"] += Checking which version you have installed +include::_attributes/attributes-microshift.adoc[] +:context: microshift-version +toc::[] + +To begin troubleshooting, determine which version of {product-title} you have installed. + +include::modules/microshift-version-cli.adoc[leveloffset=+1] + +include::modules/microshift-version-api.adoc[leveloffset=+1] diff --git a/modules/microshift-ki-cni-iptables-deleted.adoc b/modules/microshift-ki-cni-iptables-deleted.adoc index 1f06655706..8ede66d13c 100644 --- a/modules/microshift-ki-cni-iptables-deleted.adoc +++ b/modules/microshift-ki-cni-iptables-deleted.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // -// * microshift_support/microshift-version.adoc - +// * microshift_troubleshooting/microshift-known-issues.adoc +:_content-type: PROCEDURE [id="microshift-ki-cni-iptables-deleted_{context}"] = Reloading the firewall deletes iptable rules @@ -50,14 +50,15 @@ $ sudo iptables-save | grep NODEPORT -A OVN-KUBE-NODEPORT -p tcp -m addrtype --dst-type LOCAL -m tcp --dport 32122 -j DNAT --to-destination 10.43.17.173:80 ---- -You can also confirm that a new ovnkube-master pod has been started by running the following command: - +. You can also confirm that a new ovnkube-master pod has been started by running the following command: ++ [source, terminal] ---- $ oc get pods -n openshift-ovn-kubernetes ---- -The listing of the running pods shows a new ovnkube-master pod name and age. For example: - +The listing of the running pods shows a new ovnkube-master pod name and age. ++ +.Example output [cols="5",options="header"] |=== |NAME diff --git a/modules/microshift-version-api.adoc b/modules/microshift-version-api.adoc index 4d51dca57c..b2873cfd33 100644 --- a/modules/microshift-version-api.adoc +++ b/modules/microshift-version-api.adoc @@ -1,8 +1,8 @@ // Module included in the following assemblies: // -// * microshift_architecture/microshift-version-api.adoc +// * microshift_troubleshooting/microshift-version.adoc -:_content-type: CONCEPT +:_content-type: PROCEDURE [id="microshift-version-api_{context}"] = Checking the {product-title} version using the API @@ -15,7 +15,7 @@ ---- $ oc get configmap -n kube-public microshift-version -o yaml ---- - ++ .Example output [source,yaml] ---- diff --git a/modules/microshift-version-cli.adoc b/modules/microshift-version-cli.adoc index bf91bb2510..edbda3a1cb 100644 --- a/modules/microshift-version-cli.adoc +++ b/modules/microshift-version-cli.adoc @@ -1,7 +1,8 @@ // Module included in the following assemblies: // -// * microshift_support/microshift-version.adoc +// * microshift_troubleshooting/microshift-version.adoc +:_content-type: PROCEDURE [id="microshift-version-cli_{context}"] = Checking the {product-title} version using the command-line interface @@ -13,7 +14,7 @@ ---- $ microshift version ---- - ++ .Example output [source,terminal] ----