OSDOCS-8693: add Getting Support assembly MicroShift

ShaunaDiaz · ShaunaDiaz · commit fb953edbf9b0 · 2023-11-28T11:51:48.000-05:00
diff --git a/_topic_maps/_topic_map_ms.yml b/_topic_maps/_topic_map_ms.yml
@@ -79,6 +79,8 @@ Topics:
   File: microshift-etcd
 - Name: The sos report tool
   File: microshift-sos-report
+- Name: Getting support
+  File: microshift-getting-support
 ---
 Name: API reference
 Dir: microshift_rest_api
diff --git a/microshift_support/microshift-getting-support.adoc b/microshift_support/microshift-getting-support.adoc
@@ -0,0 +1,15 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="microshift-getting-support"]
+= Getting support
+include::_attributes/attributes-microshift.adoc[]
+:context: getting-support
+
+toc::[]
+
+// Getting support; note these modules are OCP
+
+include::modules/support.adoc[leveloffset=+1]
+include::modules/microshift-provide-feedback-jira-link.adoc[leveloffset=+1]
+include::modules/support-knowledgebase-about.adoc[leveloffset=+1]
+include::modules/support-knowledgebase-search.adoc[leveloffset=+1]
+include::modules/support-submitting-a-case.adoc[leveloffset=+1]
diff --git a/modules/microshift-provide-feedback-jira-link.adoc b/modules/microshift-provide-feedback-jira-link.adoc
@@ -0,0 +1,9 @@
+// Module included in the following assemblies:
+//
+// microshift_support/
+
+:_mod-docs-content-type: CONCEPT
+[id="microshift-provide-feedback-jira-link_{context}"]
+= Providing documentation feedback
+
+To report an error or to improve our documentation, log in to your link:https://issues.redhat.com[Red Hat Jira account] and submit a link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&issuetype=1&components=12370455&priority=10200&summary=[Jira issue].
diff --git a/modules/support-knowledgebase-about.adoc b/modules/support-knowledgebase-about.adoc
@@ -4,6 +4,7 @@
 // * support/getting-support.adoc
 // * service_mesh/v2x/ossm-troubleshooting-istio.adoc
 // * osd_architecture/osd-support.adoc
+// * microshift_support/microshift-getting-support.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="support-knowledgebase-about_{context}"]
diff --git a/modules/support-knowledgebase-search.adoc b/modules/support-knowledgebase-search.adoc
@@ -4,6 +4,7 @@
 // * support/getting-support.adoc
 // * service_mesh/v2x/ossm-troubleshooting-istio.adoc
 // * osd_architecture/osd-support.adoc
+// * microshift_support/microshift-getting-support.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="support-knowledgebase-search_{context}"]
diff --git a/modules/support-submitting-a-case.adoc b/modules/support-submitting-a-case.adoc
@@ -4,19 +4,23 @@
 // * support/getting-support.adoc
 // * service_mesh/v2x/ossm-troubleshooting-istio.adoc
 // * osd_architecture/osd-support.adoc
+// * microshift_support/microshift-getting-support.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="support-submitting-a-case_{context}"]
 = Submitting a support case
 
 .Prerequisites
 
-ifndef::openshift-dedicated[]
+ifndef::openshift-dedicated,microshift[]
 * You have access to the cluster as a user with the `cluster-admin` role.
-endif::openshift-dedicated[]
+endif::openshift-dedicated,microshift[]
 ifdef::openshift-rosa,openshift-dedicated[]
 * You have access to the cluster as a user with the `dedicated-admin` role.
 endif::openshift-rosa,openshift-dedicated[]
+ifdef::microshift[]
+* The {microshift-short} service is running.
+endif::microshift[]
 * You have installed the OpenShift CLI (`oc`).
 ifdef::openshift-dedicated[]
 * You have access to the {cluster-manager-first}.
@@ -62,7 +66,7 @@ ifdef::openshift-dedicated[]
 .. Click on the name of the cluster you need to open a support case for.
 .. Find the value in the *Cluster ID* field of the *Details* section of the *Overview* tab.
 endif::openshift-dedicated[]
-ifndef::openshift-dedicated[]
+ifndef::openshift-dedicated,microshift[]
 +
 * To manually obtain your cluster ID using the {product-title} web console:
 .. Navigate to *Home* -> *Overview*.
@@ -78,7 +82,7 @@ ifndef::openshift-dedicated[]
 ----
 $ oc get clusterversion -o jsonpath='{.items[].spec.clusterID}{"\n"}'
 ----
-endif::openshift-dedicated[]
+endif::openshift-dedicated,microshift[]
 
 . Complete the following questions where prompted and then click *Continue*:
 +
@@ -87,9 +91,12 @@ endif::openshift-dedicated[]
 * What information can you provide around time-frames and the business impact?
 
 . Upload relevant diagnostic data files and click *Continue*.
-ifndef::openshift-dedicated[]
+ifndef::openshift-dedicated,microshift[]
 It is recommended to include data gathered using the `oc adm must-gather` command as a starting point, plus any issue specific data that is not collected by that command.
-endif::openshift-dedicated[]
+endif::openshift-dedicated,microshift[]
+ifdef::microshift[]
+It is recommended to include data gathered using the `sos` tool or etcd as a starting point, plus any issue-specific data that is not collected in those logs.
+endif::microshift[]
 
 . Input relevant case management details and click *Continue*.
 
diff --git a/modules/support.adoc b/modules/support.adoc
@@ -17,20 +17,21 @@
 // * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc
 // * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc
 // * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc
+// * microshift_support/microshift-getting-support.adoc
 
 [id="support_{context}"]
 = Getting support
 
 If you experience difficulty with a procedure described in this documentation, or with {product-title} in general, visit the link:http://access.redhat.com[Red Hat Customer Portal]. From the Customer Portal, you can:
 
 * Search or browse through the Red Hat Knowledgebase of articles and solutions relating to Red Hat products.
-* Submit a support case to Red Hat Support.
-// TODO: xref
+* Submit a support case to Red Hat Support
 * Access other product documentation.
 
+ifndef::microshift[]
 To identify issues with your cluster, you can use Insights in {cluster-manager-url}. Insights provides details about issues and, if available, information on how to solve a problem.
 
 // TODO: verify that these settings apply for Service Mesh and OpenShift virtualization, etc.
 If you have a suggestion for improving this documentation or have found an
-error, submit a link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Documentation_issue&issuetype=1&components=12367614&priority=10200&versions=12385624[Jira issue] for the most relevant documentation component. Please
-provide specific details, such as the section name and {product-title} version.
+error, submit a link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Documentation_issue&issuetype=1&components=12367614&priority=10200&versions=12385624[Jira issue] for the most relevant documentation component. Please provide specific details, such as the section name and {product-title} version.
+endif::microshift[]
