RFE-821 - Adding to the support section. by pneedle-rh · Pull Request #23316 · openshift/openshift-docs

pneedle-rh · 2020-06-26T15:05:37Z

Applies to enterprise-4.5 onward. This is the first phase of a new Troubleshooting Guide for OCP 4. Initially content is being added to the Support book.

This relates to https://issues.redhat.com/browse/RFE-821.

Previews available at:

pneedle-rh · 2020-06-26T15:06:25Z

@openshift/team-documentation for peer review please. Please can someone also add 'Peer Review Needed', 'branch/enterprise-4.5', 'labels and 'Next Release' milestone? Thanks!'. This content is for enterprise-4.5 onward.

openshift-docs-preview-bot · 2020-06-26T16:08:25Z

The preview will be available shortly at:

https://troubleshooting_guide--ocpdocs.netlify.com/

sferich888

This looks great, I have a few nits, here and there but overall this is a strong foundation for us to build on.

sferich888 · 2020-06-26T17:23:54Z

Is there a way this can automatically be generated?

@deads2k @mfojtik

@deads2k @mfojtik can you please confirm this? Thanks!

bobfuru

Hey Paul - This is an unparalleled effort and will be an enormous asset to our customers. Thanks for letting me review it.

My comments are mostly of the nitpick variety, calling out a few of our OCP and ISG style conventions, such as serial commas and using attributes like {product-title} wherever possible.

You'll also see at times where I suggested adding some more articles to the verbiage, such as "Gather the journald unit logs" rather than "Gather journald unit logs". I think this would help make it sound more human-to-human, but you may have chosen to exclude some of this language to cut down on length or to conform to troubleshooting/support norms, which would be understandable.

Let me know if you need clarification or want to discuss anything further. Great work, Paul!

bergerhoffer

A few comments from a run through of a few of the sections

bergerhoffer

Last batch of comments. Ton of great info here!

sunilcio · 2020-07-17T05:31:54Z

Reviewed section https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/verifying-node-health.html. LGTM

pneedle-rh · 2020-07-17T11:45:30Z

For this troubleshooting-operator-issues doc, Operator subscription condition types and Viewing Operator subscription status using the CLI are only for the application operators, which managed by OLM. We should explain this point, not all operators have the subsciption object.
And, tthe rest parts are for all operators, includes the CVO, the operators managed by the CVO.

@jianzhangbjz thank you for highlighting this. I have now made this clearer in the description in the assembly. I have also added a note at the base of both of those modules highlighting this point.

pneedle-rh · 2020-07-17T12:15:07Z

https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.html#showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring
bug: https://bugzilla.redhat.com/show_bug.cgi?id=1856781

Thank you @juzhao for filing the Bugzilla. I have subsequently assigned the BZ to myself and applied the requested changes through this current PR. Please review the BZ from a QE perspective. Thanks!

sunilcio · 2020-07-17T12:31:39Z

Reviewed section https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/troubleshooting-crio-issues.html, lgtm

sunilcio · 2020-07-17T12:44:43Z

Reviewed section https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/investigating-pod-issues.html, lgtm

sunilcio · 2020-07-17T13:54:13Z

Reviewed below sections, lgtm
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/gathering-cluster-data.html#support-generating-a-sosreport-archive_gathering-cluster-data
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/gathering-cluster-data.html#querying-cluster-node-journal-logs_gathering-cluster-data
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/gathering-cluster-data.html#support-providing-diagnostic-data-to-red-hat_gathering-cluster-data

juzhao · 2020-07-20T00:50:10Z

https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.html#showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring
bug: https://bugzilla.redhat.com/show_bug.cgi?id=1856781

Thank you @juzhao for filing the Bugzilla. I have subsequently assigned the BZ to myself and applied the requested changes through this current PR. Please review the BZ from a QE perspective. Thanks!

LGTM and bug is moved to VERIFIED

openshift-ci-robot · 2020-07-23T09:30:52Z

New changes are detected. LGTM label has been removed.

pneedle-rh · 2020-07-23T10:51:26Z

@xltian I believe I have now responded to each of the QE comments from the team in this document. Can you please let me know whether there are any more QE reviews to go? Can you please confirm whether the QE team are now happy for this PR to be merged? Thanks!

zhouying7780 · 2020-07-24T02:24:15Z

Look good to me for modules/specifying-oc-log-levels.adoc

jinyunma · 2020-07-24T06:16:32Z

looks good to me for "troubleshooting-installations" section

wsun1 · 2020-07-24T07:51:47Z

@pneedle-rh , most of sections look good to QE, once @gpei 's comment is resolved, QE is fine for this PR.

pneedle-rh · 2020-07-24T09:40:14Z

@pneedle-rh , most of sections look good to QE, once @gpei 's comment is resolved, QE is fine for this PR.

Thank you @wsun1, that is great. I have now resolved @gpei's comment.

@bobfuru @bergerhoffer can you please let me know if you have any further suggestions before this PR is merged? A number of changes were made following QE review. Thanks!

adellape

NICE. 😙:ok_hand:

bobfuru

Looks great! A couple of places where the formatting was off but the rest of my comments are tiny nits. Thanks for letting me review this again.

pneedle-rh · 2020-07-27T14:36:41Z

@bobfuru my understanding is that this PR has now passed through peer, SME and QE approval. If you are happy with my responses to your final review comments, can you please merge and CP for branch/enterprise-4.5 and branch/enterprise-4.6? Thanks!

bobfuru · 2020-07-27T14:52:52Z

LGTM

bobfuru · 2020-07-27T14:53:20Z

/cherrypick enterprise-4.5

openshift-cherrypick-robot · 2020-07-27T14:53:24Z

@bobfuru: #23316 failed to apply on top of branch "enterprise-4.5":

Details

In response to this:

/cherrypick enterprise-4.5

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

bobfuru · 2020-07-27T14:53:25Z

/cherrypick enterprise-4.6

openshift-cherrypick-robot · 2020-07-27T14:53:28Z

@bobfuru: #23316 failed to apply on top of branch "enterprise-4.6":

Details

In response to this:

/cherrypick enterprise-4.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

pneedle-rh force-pushed the troubleshooting_guide branch 3 times, most recently from c752422 to b339ca5 Compare June 26, 2020 16:01

pneedle-rh force-pushed the troubleshooting_guide branch from b339ca5 to 563d96e Compare June 26, 2020 16:11

bobfuru self-requested a review June 26, 2020 16:30

bobfuru added the branch/enterprise-4.5 label Jun 26, 2020

bobfuru added this to the Future Release milestone Jun 26, 2020

sferich888 approved these changes Jun 26, 2020

View reviewed changes

pneedle-rh force-pushed the troubleshooting_guide branch from 563d96e to bfd24c8 Compare June 26, 2020 17:49

bobfuru reviewed Jun 26, 2020

View reviewed changes

bobfuru added the peer-review-done Signifies that the peer review team has reviewed this PR label Jun 26, 2020

pneedle-rh force-pushed the troubleshooting_guide branch 4 times, most recently from b5902d9 to e2a8cba Compare June 29, 2020 13:04

bergerhoffer reviewed Jun 29, 2020

View reviewed changes

pneedle-rh force-pushed the troubleshooting_guide branch 11 times, most recently from ae16a11 to c4f665d Compare June 29, 2020 16:32

bergerhoffer reviewed Jun 29, 2020

View reviewed changes

jinyunma reviewed Jul 16, 2020

View reviewed changes

Comment thread modules/investigating-etcd-installation-issues.adoc Outdated

zhaozhanqi reviewed Jul 20, 2020

View reviewed changes

Comment thread modules/support-collecting-network-trace.adoc Outdated

gpei reviewed Jul 20, 2020

View reviewed changes

Comment thread modules/querying-bootstrap-node-journal-logs.adoc Outdated

Comment thread modules/querying-bootstrap-node-journal-logs.adoc Outdated

gpei reviewed Jul 24, 2020

View reviewed changes

Comment thread modules/querying-bootstrap-node-journal-logs.adoc Outdated

bobfuru reviewed Jul 24, 2020

View reviewed changes

Comment thread modules/support-submitting-a-case.adoc Outdated

bobfuru reviewed Jul 24, 2020

View reviewed changes

Comment thread modules/support-submitting-a-case.adoc Outdated

adellape reviewed Jul 24, 2020

View reviewed changes

Comment thread modules/gathering-operator-logs.adoc Outdated

Comment thread support/troubleshooting/troubleshooting-operator-issues.adoc Outdated

Comment thread support/troubleshooting/troubleshooting-operator-issues.adoc Outdated

bobfuru reviewed Jul 24, 2020

View reviewed changes

RFE-821 - Adding to the support section.

dfd9ac4

This was referenced Jul 27, 2020

RFE-821 - Adding to the support section. #24203

Merged

RFE-821 - Adding to the support section. #24204

Merged

Conversation

pneedle-rh commented Jun 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pneedle-rh commented Jun 26, 2020

Uh oh!

openshift-docs-preview-bot commented Jun 26, 2020

Uh oh!

sferich888 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sferich888 Jun 26, 2020

Choose a reason for hiding this comment

Uh oh!

pneedle-rh Jul 6, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bobfuru left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bergerhoffer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bergerhoffer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sunilcio commented Jul 17, 2020

Uh oh!

pneedle-rh commented Jul 17, 2020

Uh oh!

pneedle-rh commented Jul 17, 2020

Uh oh!

sunilcio commented Jul 17, 2020

Uh oh!

sunilcio commented Jul 17, 2020

Uh oh!

sunilcio commented Jul 17, 2020

Uh oh!

juzhao commented Jul 20, 2020

pneedle-rh commented Jun 26, 2020 •

edited

Loading

bobfuru left a comment •

edited

Loading

adellape left a comment •

edited

Loading

pneedle-rh commented Jul 27, 2020 •

edited

Loading