istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

Add documentations for SkyWalking integration and task

Open kezhenxu94 opened this issue 3 years ago • 21 comments

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.

  • [ ] Configuration Infrastructure
  • [x] Docs
  • [ ] Installation
  • [ ] Networking
  • [ ] Performance and Scalability
  • [ ] Policies and Telemetry
  • [ ] Security
  • [ ] Test and Release
  • [ ] User Experience
  • [ ] Developer Infrastructure

Closes https://github.com/istio/istio.io/issues/11681 Depends on https://github.com/istio/istio/pull/40296

kezhenxu94 avatar Aug 05 '22 03:08 kezhenxu94

😊 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-policy-bot avatar Aug 05 '22 03:08 istio-policy-bot

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.

istio-testing avatar Aug 05 '22 03:08 istio-testing

My local preview

Task

task-skywalking

Integration

integration-sw

kezhenxu94 avatar Aug 05 '22 03:08 kezhenxu94

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

image

zirain avatar Aug 05 '22 06:08 zirain

/ok-to-test

zirain avatar Aug 05 '22 06:08 zirain

/test doc.test.profile_default_istio.io

zirain avatar Aug 05 '22 09:08 zirain

@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.

zirain avatar Aug 05 '22 09:08 zirain

@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

zirain avatar Aug 06 '22 03:08 zirain

@zirain looks like there is no image for the istio/istio master branch?

kezhenxu94 avatar Aug 06 '22 11:08 kezhenxu94

@zirain looks like there is no image for the istio/istio master branch?

NVM, I just update the ISTIO_IMAGE_VERSION ?= 1.16-alpha and the image can be found now

kezhenxu94 avatar Aug 07 '22 04:08 kezhenxu94

Hi @zirain , looks like the test suit by default install Istio with the default profiles, what's the best practice to apply the custom configuration yaml when installing Istio?

kezhenxu94 avatar Aug 07 '22 09:08 kezhenxu94

At this point, you can remove the go.* and Makefile changes from this PR as we are now building against the main istio branch.

ericvn avatar Sep 06 '22 14:09 ericvn

At this point, you can remove the go.* and Makefile changes from this PR as we are now building against the main istio branch.

I have reverted that part, thanks!

kezhenxu94 avatar Sep 07 '22 02:09 kezhenxu94

++access_skywalking_with_portforward(): traces_length=
++access_skywalking_with_portforward(): '[' '' -eq 0 ']'
++access_skywalking_with_portforward(): return 0
+__verify_with_retry(): out='parse error: Invalid numeric literal at line 1, column 7
main: line 94: [: : integer expression expected'

ericvn avatar Sep 12 '22 15:09 ericvn


++access_skywalking_with_portforward(): traces_length=

++access_skywalking_with_portforward(): '[' '' -eq 0 ']'

++access_skywalking_with_portforward(): return 0

+__verify_with_retry(): out='parse error: Invalid numeric literal at line 1, column 7

main: line 94: [: : integer expression expected'

Hey @ericvn thanks for pointing this out. I haven't look into the errors as I know it must fail because this depends on the https://github.com/istio/istio/pull/40329. But that PR is now marked as stale and I can't find a env maintainer to review it. I'll manage to make the CI of this PR passed if that can be merged.

kezhenxu94 avatar Sep 12 '22 16:09 kezhenxu94

/test doc.test.profile_none

zirain avatar Sep 18 '22 13:09 zirain

Hi, I can't see any chance for now that https://github.com/istio/istio/pull/40329 can get merged so I end up using the none profile with an IstioOperator CR to enable the skywalking tracer in this PR, if that PR can be merged I might simplify this doc by just using the demo profile

kezhenxu94 avatar Sep 18 '22 14:09 kezhenxu94

Not sure why after_snapshot failed

kezhenxu94 avatar Sep 19 '22 00:09 kezhenxu94

Could be a flake; just

/retest

craigbox avatar Sep 19 '22 01:09 craigbox

/test doc.test.profile_default

zirain avatar Sep 19 '22 03:09 zirain

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

kezhenxu94 avatar Sep 19 '22 04:09 kezhenxu94

kindly ping @ericvn

zirain avatar Sep 25 '22 15:09 zirain

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

kezhenxu94 avatar Oct 05 '22 02:10 kezhenxu94

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

ericvn avatar Oct 10 '22 18:10 ericvn

@ericvn thanks for reviewing, comments are addressed

kezhenxu94 avatar Nov 03 '22 10:11 kezhenxu94

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? 企业微信截图_b6945850-cf8f-4cbf-8370-456ffc72b832

houbinglei avatar Mar 01 '23 06:03 houbinglei