Skip to content

OSSMDOC-147: Add troubleshooting page. #29410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 17, 2021
Merged

OSSMDOC-147: Add troubleshooting page. #29410

merged 1 commit into from
Sep 17, 2021

Conversation

JStickler
Copy link
Contributor

@JStickler JStickler commented Feb 10, 2021 •
edited
Loading

First draft for a Service Mesh troubleshooting page.
This is not intended to be exhaustive, but rather to start the page with a couple of basic scenarios that we can then add to over time.
Also moves the Support and Must Gather topics out of the Release Notes.

REVISION
Added topic about Service Mesh versioning (OSSMDOC-176 and OSSMDOC-201)
Added additional context around expected behavior (Validation topics).

Preview is here -> https://deploy-preview-29410--osdocs.netlify.app/openshift-enterprise/latest/service_mesh/v2x/ossm-troubleshooting-istio.html

@openshift-ci-robot openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 10, 2021
@netlify
Copy link

netlify bot commented Feb 10, 2021 •
edited
Loading

✔️ Deploy Preview for osdocs ready!

🔨 Explore the source changes: ff44190

🔍 Inspect the deploy log: https://app.netlify.com/sites/osdocs/deploys/6143f28c362d5700071c8c2e

😎 Browse the preview: https://deploy-preview-29410--osdocs.netlify.app

@JStickler JStickler changed the title [WIP] OSSMDOC-147 Add troubleshooting page. OSSMDOC-147 Add troubleshooting page. Mar 15, 2021
@openshift-ci-robot openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 15, 2021
rcernich
rcernich reviewed Mar 15, 2021
View reviewed changes
@JStickler JStickler force-pushed the OSSMDOC-147 branch 2 times, most recently from e86cff1 to cd52a1f Compare March 23, 2021 13:58
tvieira
tvieira reviewed Mar 23, 2021
View reviewed changes
brian-avery
brian-avery reviewed Mar 29, 2021
View reviewed changes
@JStickler JStickler requested a review from neal-timpe March 30, 2021 19:31
tvieira
tvieira reviewed Apr 1, 2021
View reviewed changes
brian-avery
brian-avery reviewed Apr 1, 2021
View reviewed changes
brian-avery
brian-avery reviewed Apr 1, 2021
View reviewed changes
neal-timpe
neal-timpe suggested changes Apr 5, 2021
View reviewed changes
neal-timpe
neal-timpe reviewed Apr 5, 2021
View reviewed changes
modules/ossm-troubleshooting-injection.adoc Outdated
Copy link
Contributor

@neal-timpe neal-timpe Apr 5, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This says OSSM is unlike the upstream, but the first heading mentions Istio, which might be confusing. I also notice that the paragraphs underneath both the istio and jaeger sidecar injection are broadly similar. Is it possible to just combine those into one paragraph. So instead of Troubleshooting sidecar injection with two subheads,

= Troubleshooting sidecar injection

Unlike how the upstream Istio community configures proxy sidecars using namespace labels, {ProductName} does not automatically inject proxy sidecars to pods. You must opt in to sidecar injection.

Check to see if automatic injection is enabled in the Deployment for your application. If automatic injection for the Envoy proxy is enabled, there should be a sidecar.istio.io/inject:"true" and sidecar.jaegertracing.io/inject:"true" annotation in the Deployment resource under spec.template.metadata.annotations.

I had one more thought here. This module has an explanation for what a sidecar injection is and how to fix it, but it doesn't mention the symptom. Many troubleshooting topics start with the symptom and then reveal the cure. What is the symptom? How do I know I have a sidecar injection problem?

pnagesha
pnagesha suggested changes Sep 10, 2021
View reviewed changes
abrennan89
abrennan89 reviewed Sep 13, 2021
View reviewed changes
modules/ossm-observability-access.adoc Outdated
Comment on lines +15 to +21
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like some of these were accepted here but marked resolved without incorporating in the above topic; probably best to keep them consistent?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no idea what this comment means. I've made these changes, are they not showing up for you? Maybe a caching issue?

abrennan89
abrennan89 reviewed Sep 13, 2021
View reviewed changes
abrennan89
abrennan89 reviewed Sep 13, 2021
View reviewed changes
abrennan89
abrennan89 reviewed Sep 13, 2021
View reviewed changes
abrennan89
abrennan89 requested changes Sep 13, 2021
View reviewed changes
Copy link
Contributor

@abrennan89 abrennan89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some additional comments

longmuir
longmuir approved these changes Sep 15, 2021
View reviewed changes
Copy link

@longmuir longmuir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good as a first revision that we can build on over time.

abrennan89
abrennan89 reviewed Sep 16, 2021
View reviewed changes
Copy link
Contributor

@abrennan89 abrennan89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments, mostly minor nits and formatting things 🙂
Great job!

@JStickler JStickler removed the request for review from gbaufake September 16, 2021 19:08
@JStickler JStickler merged commit 78f7669 into openshift:main Sep 17, 2021
@JStickler
Copy link
Contributor Author

/cherry-pick enterprise-4.6

@JStickler
Copy link
Contributor Author

/cherry-pick enterprise-4.7

@JStickler
Copy link
Contributor Author

/cherry-pick enterprise-4.8

@JStickler
Copy link
Contributor Author

/cherry-pick enterprise-4.9

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Sep 17, 2021
Merged
@openshift-cherrypick-robot
Copy link

@JStickler: new pull request created: #36471

In response to this:

/cherry-pick 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.

@openshift-cherrypick-robot
Copy link

@JStickler: new pull request created: #36472

In response to this:

/cherry-pick enterprise-4.7

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.

This was referenced Sep 17, 2021
Merged
Merged
@openshift-cherrypick-robot
Copy link

@JStickler: new pull request created: #36473

In response to this:

/cherry-pick enterprise-4.8

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.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Sep 17, 2021
Merged
@openshift-cherrypick-robot
Copy link

@JStickler: new pull request created: #36474

In response to this:

/cherry-pick enterprise-4.9

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.

@JStickler JStickler deleted the OSSMDOC-147 branch December 2, 2021 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@abrennan89 abrennan89 abrennan89 approved these changes

+6 more reviewers

@tvieira tvieira tvieira left review comments

@brian-avery brian-avery brian-avery approved these changes

@neal-timpe neal-timpe neal-timpe requested changes

@pnagesha pnagesha pnagesha requested changes

@rcernich rcernich rcernich approved these changes

@longmuir longmuir longmuir approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

branch/enterprise-4.6 branch/enterprise-4.7 branch/enterprise-4.8 branch/enterprise-4.9 peer-review-done Signifies that the peer review team has reviewed this PR service-mesh Label for all Service Mesh PRs size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

Next Release

Development

Successfully merging this pull request may close these issues.

10 participants

@JStickler @openshift-cherrypick-robot @tvieira @rcernich @longmuir @brian-avery @neal-timpe @abrennan89 @pnagesha @openshift-ci-robot