Skip to content

Commit e033b76

Browse files
ShaunaDiazShaunaDiaz
committed
OSDOCS-8693: add Getting Support assembly MicroShift
1 parent a3468a3 commit e033b76

9 files changed

+90
-6
lines changed

‎_attributes/attributes-microshift.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,6 @@
1919
:op-system-version: 9.2
2020
:op-system-version-major: 9
2121
:op-system-bundle: Red Hat Device Edge
22+
:rhde-version: 4
2223
:rpm-repo-version: rhocp-4.14
2324
:VirtProductName: OpenShift Virtualization

‎_topic_maps/_topic_map_ms.yml

+2
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ Topics:
7979
File: microshift-etcd
8080
- Name: The sos report tool
8181
File: microshift-sos-report
82+
- Name: Getting support
83+
File: microshift-getting-support
8284
---
8385
Name: API reference
8486
Dir: microshift_rest_api

‎microshift_support/microshift-getting-support.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="microshift-getting-support"]
3+
= Getting support
4+
include::_attributes/attributes-microshift.adoc[]
5+
:context: getting-support
6+
7+
toc::[]
8+
9+
// Getting support; note these modules are OCP
10+
11+
include::modules/support.adoc[leveloffset=+1]
12+
include::modules/microshift-provide-feedback-jira-link.adoc[leveloffset=+1]
13+
include::modules/support-knowledgebase-about.adoc[leveloffset=+1]
14+
include::modules/support-knowledgebase-search.adoc[leveloffset=+1]
15+
include::modules/microshift-submitting-a-case.adoc[leveloffset=+1]

‎modules/microshift-provide-feedback-jira-link.adoc

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// microshift_support/
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="microshift-provide-feedback-jira-link_{context}"]
7+
= Providing documentation feedback
8+
9+
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].

‎modules/microshift-submitting-a-case.adoc

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift_support/microshift-getting-support.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="microshift-support-submitting-a-case_{context}"]
7+
= Submitting a support case
8+
9+
.Prerequisites
10+
11+
* The {microshift-short} service is running.
12+
* You have installed the OpenShift CLI (`oc`).
13+
* You have a Red Hat Customer Portal account.
14+
* You have a Red Hat standard or premium Subscription.
15+
16+
.Procedure
17+
18+
. Log in to link:https://access.redhat.com/support/cases/#/case/list[the *Customer Support* page] of the Red Hat Customer Portal.
19+
20+
. Click *Get support*.
21+
22+
. On the *Cases* tab of the *Customer Support* page:
23+
24+
.. Optional: Change the pre-filled account and owner details if needed.
25+
26+
.. Select the appropriate category for your issue, such as *Bug or Defect*, and click *Continue*.
27+
28+
. Enter the following information:
29+
30+
.. In the *Summary* field, enter a concise but descriptive problem summary and further details about the symptoms being experienced, as well as your expectations.
31+
32+
.. Select *{op-system-bundle}* from the *Product* drop-down menu.
33+
34+
.. Select *{rhde-version}* from the *Version* drop-down.
35+
36+
. Review the list of suggested Red Hat Knowledgebase solutions for a potential match against the problem that is being reported. If the suggested articles do not address the issue, click *Continue*.
37+
38+
. Review the updated list of suggested Red Hat Knowledgebase solutions for a potential match against the problem that is being reported. The list is refined as you provide more information during the case creation process. If the suggested articles do not address the issue, click *Continue*.
39+
40+
. Ensure that the account information presented is as expected, and if not, amend accordingly.
41+
42+
. Complete the following questions where prompted. Include which type of install type you are using, either RPM or embedded-image. Click *Continue*:
43+
+
44+
* What are you experiencing? What are you expecting to happen?
45+
* Define the value or impact to you or the business.
46+
* Where are you experiencing this behavior? What environment?
47+
* When does this behavior occur? Frequency? Repeatedly? At certain times?
48+
49+
. Upload relevant diagnostic data files and click *Continue*. 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.
50+
51+
. Add relevant case management details and click *Continue*.
52+
53+
. Preview the case details and click *Submit*.

‎modules/support-knowledgebase-about.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
// * support/getting-support.adoc
55
// * service_mesh/v2x/ossm-troubleshooting-istio.adoc
66
// * osd_architecture/osd-support.adoc
7+
// * microshift_support/microshift-getting-support.adoc
78

89
:_mod-docs-content-type: CONCEPT
910
[id="support-knowledgebase-about_{context}"]

‎modules/support-knowledgebase-search.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
// * support/getting-support.adoc
55
// * service_mesh/v2x/ossm-troubleshooting-istio.adoc
66
// * osd_architecture/osd-support.adoc
7+
// * microshift_support/microshift-getting-support.adoc
78

89
:_mod-docs-content-type: PROCEDURE
910
[id="support-knowledgebase-search_{context}"]

‎modules/support-submitting-a-case.adoc

+3-2
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ endif::openshift-dedicated[]
3434

3535
. On the *Cases* tab of the *Customer Support* page:
3636

37-
.. Optional: Change the pre-filled account and owner, if needed.
37+
.. Optional: Change the pre-filled account and owner details if needed.
3838

39-
.. Select the appropriate category for your issue,such as *Bug or Defect*, and click *Continue*.
39+
.. Select the appropriate category for your issue, such as *Bug or Defect*, and click *Continue*.
4040

4141
. Enter the following information:
4242

@@ -55,6 +55,7 @@ endif::openshift-rosa,openshift-dedicated[]
5555
. Ensure that the account information presented is as expected, and if not, amend accordingly.
5656

5757
. Check that the autofilled {product-title} Cluster ID is correct. If it is not, manually obtain your cluster ID.
58+
5859
ifdef::openshift-dedicated[]
5960
+
6061
* To manually obtain your cluster ID using {cluster-manager-url}:

‎modules/support.adoc

+5-4
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,21 @@
1717
// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc
1818
// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc
1919
// * distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc
20+
// * microshift_support/microshift-getting-support.adoc
2021

2122
[id="support_{context}"]
2223
= Getting support
2324

2425
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:
2526

2627
* Search or browse through the Red Hat Knowledgebase of articles and solutions relating to Red Hat products.
27-
* Submit a support case to Red Hat Support.
28-
// TODO: xref
28+
* Submit a support case to Red Hat Support
2929
* Access other product documentation.
3030

31+
ifndef::microshift[]
3132
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.
3233

3334
// TODO: verify that these settings apply for Service Mesh and OpenShift virtualization, etc.
3435
If you have a suggestion for improving this documentation or have found an
35-
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
36-
provide specific details, such as the section name and {product-title} version.
36+
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.
37+
endif::microshift[]

0 commit comments

Comments
 (0)