istio.io
istio.io copied to clipboard
Add documentations for SkyWalking integration and task
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
😊 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/netlifyentry 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.
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.
My local preview
Task

Integration

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

/ok-to-test
/test doc.test.profile_default_istio.io
@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.
@kezhenxu94: The following test failed, say
/retestto rerun all failed tests or/retest-requiredto 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 looks like there is no image for the istio/istio master branch?
@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
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?
At this point, you can remove the go.* and Makefile changes from this PR as we are now building against the main istio branch.
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!
++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'
++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.
/test doc.test.profile_none
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
Not sure why after_snapshot failed
Could be a flake; just
/retest
/test doc.test.profile_default
Finally, tests passed. @zirain can you take a look?
kindly ping @ericvn
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
Remove the 1.15 cherry-pick as the samples are not in that branch.
@ericvn thanks for reviewing, comments are addressed
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?
