Add documentations for SkyWalking integration and task #11683

kezhenxu94 · 2022-08-05T03:39:47Z

Please provide a description for what this PR is for.

This patch adds integration guide for Apache SkyWalking and task tutorial for SkyWalking.

And to help us figure out who should review this PR, please
put an X in all the areas that this PR affects.

Closes #11681
Depends on istio/istio#40296

istio-policy-bot · 2022-08-05T03:39:50Z

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been awhile since you've been here. A few things you should know:

You can learn about how we write and maintain documentation, about our style guidelines,
and about all the available web site features by visiting Contributing to the Docs.
In the next few minutes, an automatic preview of your change will be
built as a full copy of the istio.io website. You can find this preview by clicking on
the Details link next to the deploy/netlify entry in the Status section of this
page.
We care about quality, so we've put in place a number of checks to ensure our documentation
is top notch. We do spell checking, we sanitize the markdown, we ensure all hyperlinks point
to valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
status section of the page. Click on the Details link to get a list of the problems with your PR.
Fix those problems and push an update to your PR. This will automatically rerun the tests and
hopefully this time everything will be perfect.
Once your changes are accepted and merged into the repository, they will initially show up
on https://preliminary.istio.io. The changes will be published to https://istio.io
the next time we do a major release (which typically happens every 3 months or so).

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-testing · 2022-08-05T03:40:00Z

Hi @kezhenxu94. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

kezhenxu94 · 2022-08-05T03:41:33Z

My local preview

Task

Integration

zirain · 2022-08-05T06:16:50Z

preview is here https://deploy-preview-11683--preliminary-istio.netlify.app/

zirain · 2022-08-05T06:21:15Z

/ok-to-test

content/en/docs/ops/integrations/skywalking/index.md

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md

content/en/docs/ops/integrations/skywalking/index.md

zirain · 2022-08-05T09:29:35Z

/test doc.test.profile_default_istio.io

zirain · 2022-08-05T09:35:34Z

@kezhenxu94 can you add doc test for this? like zipkin https://github.com/istio/istio.io/tree/master/content/en/docs/tasks/observability/distributed-tracing/zipkin

here is the guide doc.

content/en/docs/tasks/observability/distributed-tracing/skywalking/test.sh

zirain · 2022-08-06T03:51:26Z

@kezhenxu94: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
doc.test.profile_demo_istio.io 5686aa2 link true /test doc.test.profile_demo_istio.io

would you please temp update the go.mod with go get istio.io/istio@master, let's verify the script with CI

craigbox · 2022-09-19T01:08:08Z

Could be a flake; just

/retest

zirain · 2022-09-19T03:27:02Z

/test doc.test.profile_default

kezhenxu94 · 2022-09-19T04:24:02Z

Finally, tests passed. @zirain can you take a look?

content/en/docs/ops/integrations/skywalking/index.md

craigbox · 2022-09-19T04:45:22Z

content/en/docs/ops/integrations/skywalking/index.md

+
+Consult the [SkyWalking documentation](http://skywalking.apache.org) to get started. No special changes are needed for SkyWalking to work with Istio.
+
+Once SkyWalking is installed, remember to modify the option `--set meshConfig.extensionProviders[0].skywalking.service` to point to the oap deployment.


What's an oap?

What's an oap?

It's the collector of skywalking, I'll modify it to skywalking-oap because this is the deployment name

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md

zirain

overall, lgtm

zirain · 2022-09-25T15:45:57Z

kindly ping @ericvn

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md

linsun · 2022-10-05T01:29:04Z

content/en/docs/ops/integrations/skywalking/index.md

+[Apache SkyWalking](http://skywalking.apache.org) is an application performance monitoring (APM) system, especially designed for
+microservices, cloud native and container-based architectures.


could you quickly add a sentence why someone would consider using this over the existing observability tools Istio support?

kezhenxu94 · 2022-10-05T02:17:30Z

Thank you all @zirain @ericvn @kfaseela @linsun for your reviews, I have update the PR to address your comments. Let me know if anything else is needed to modify

content/en/docs/ops/integrations/skywalking/index.md

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md

ericvn · 2022-10-10T18:53:23Z

Remove the 1.15 cherry-pick as the samples are not in that branch.

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md

Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>

kezhenxu94 · 2022-11-03T10:01:38Z

@ericvn thanks for reviewing, comments are addressed

houbinglei · 2023-03-01T06:18:02Z

My local preview

Task
Integration

Thanks for your detail info!
i have try according on your task , but i cant see service group . how can i customize the service group?

* Add documentations for SkyWalking integration and task * Add script to undeploy skywalking * Clean up istio namespace * Update index.md * Address review comments * Apply suggestions from code review Co-authored-by: Eric Van Norman <ericvn@us.ibm.com> Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>

kezhenxu94 requested a review from a team as a code owner August 5, 2022 03:39

istio-policy-bot added the kind/docs label Aug 5, 2022

istio-testing added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test labels Aug 5, 2022

istio-testing added ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. and removed needs-ok-to-test labels Aug 5, 2022

zirain reviewed Aug 5, 2022

View reviewed changes

content/en/docs/ops/integrations/skywalking/index.md Outdated Show resolved Hide resolved

zirain reviewed Aug 5, 2022

View reviewed changes

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md Show resolved Hide resolved

zirain reviewed Aug 5, 2022

View reviewed changes

content/en/docs/ops/integrations/skywalking/index.md Outdated Show resolved Hide resolved

zirain reviewed Aug 5, 2022

View reviewed changes

content/en/docs/ops/integrations/skywalking/index.md Outdated Show resolved Hide resolved

kezhenxu94 force-pushed the doc/sw branch 4 times, most recently from a59d5a3 to fa2d92c Compare August 5, 2022 06:51

zirain reviewed Aug 5, 2022

View reviewed changes

content/en/docs/ops/integrations/skywalking/index.md Outdated Show resolved Hide resolved

kezhenxu94 force-pushed the doc/sw branch from fa2d92c to 6569a50 Compare August 5, 2022 07:03

kezhenxu94 force-pushed the doc/sw branch from 6569a50 to 45105cf Compare August 6, 2022 02:09

zirain reviewed Aug 6, 2022

View reviewed changes

content/en/docs/tasks/observability/distributed-tracing/skywalking/test.sh Outdated Show resolved Hide resolved

kezhenxu94 force-pushed the doc/sw branch from 45105cf to 075dfb1 Compare August 6, 2022 03:12

kezhenxu94 requested review from a team as code owners August 6, 2022 03:12

kezhenxu94 force-pushed the doc/sw branch from 075dfb1 to 5686aa2 Compare August 6, 2022 03:18

kezhenxu94 requested review from zirain and ericvn and removed request for zirain September 19, 2022 00:53

craigbox reviewed Sep 19, 2022

View reviewed changes

Clean up istio namespace

f1b5ae9

kezhenxu94 force-pushed the doc/sw branch from f50691d to f1b5ae9 Compare September 19, 2022 04:57

zirain reviewed Sep 19, 2022

View reviewed changes

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md Outdated Show resolved Hide resolved

zirain approved these changes Sep 19, 2022

View reviewed changes

Update index.md

7e3477b

zirain added the cherrypick/release-1.15 label Sep 22, 2022

ericvn reviewed Oct 4, 2022

View reviewed changes

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md Outdated Show resolved Hide resolved

kfaseela reviewed Oct 4, 2022

View reviewed changes

linsun reviewed Oct 5, 2022

View reviewed changes

Address review comments

81e98f6

ericvn reviewed Oct 10, 2022

View reviewed changes

ericvn removed the cherrypick/release-1.15 label Oct 10, 2022

kezhenxu94 commented Nov 3, 2022

View reviewed changes

content/en/docs/tasks/observability/distributed-tracing/skywalking/index.md Outdated Show resolved Hide resolved

Apply suggestions from code review

642e2c8

Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>

ericvn approved these changes Nov 3, 2022

View reviewed changes

istio-testing merged commit 7d43f35 into istio:master Nov 3, 2022

kezhenxu94 deleted the doc/sw branch November 3, 2022 23:59


		Consult the [SkyWalking documentation](http://skywalking.apache.org) to get started. No special changes are needed for SkyWalking to work with Istio.

		Once SkyWalking is installed, remember to modify the option `--set meshConfig.extensionProviders[0].skywalking.service` to point to the oap deployment.

		[Apache SkyWalking](http://skywalking.apache.org) is an application performance monitoring (APM) system, especially designed for
		microservices, cloud native and container-based architectures.

Add documentations for SkyWalking integration and task #11683

Add documentations for SkyWalking integration and task #11683

Uh oh!

Conversation

kezhenxu94 commented Aug 5, 2022

Uh oh!

istio-policy-bot commented Aug 5, 2022

Uh oh!

istio-testing commented Aug 5, 2022

Uh oh!

kezhenxu94 commented Aug 5, 2022

My local preview

Uh oh!

zirain commented Aug 5, 2022

Uh oh!

zirain commented Aug 5, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zirain commented Aug 5, 2022

Uh oh!

zirain commented Aug 5, 2022

Uh oh!

Uh oh!

zirain commented Aug 6, 2022

Uh oh!

craigbox commented Sep 19, 2022

Uh oh!

zirain commented Sep 19, 2022

Uh oh!

kezhenxu94 commented Sep 19, 2022

Uh oh!

Uh oh!

Uh oh!

craigbox Sep 19, 2022

Choose a reason for hiding this comment

Uh oh!

kezhenxu94 Sep 19, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

zirain left a comment

Choose a reason for hiding this comment

Uh oh!

zirain commented Sep 25, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

linsun Oct 5, 2022

Choose a reason for hiding this comment

Uh oh!

kezhenxu94 commented Oct 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ericvn commented Oct 10, 2022

Uh oh!

Uh oh!

kezhenxu94 commented Nov 3, 2022

Uh oh!

houbinglei commented Mar 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

My local preview

Uh oh!

Uh oh!

kezhenxu94 commented Oct 5, 2022 •

edited

Loading

houbinglei commented Mar 1, 2023 •

edited

Loading