Skip to content
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.

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

Ambient User Guide - L7 Waypoint Proxy Layer Sub Guide #13954

Open
wants to merge 24 commits into
base: master
Choose a base branch
from

Conversation

fykaa
Copy link

@fykaa fykaa commented Sep 29, 2023

This pull request addresses the issue of providing a usage guide for ambient mesh. It includes a sub-guide for the user guide on the L7 waypoint proxy. Please review and provide suggestions.

Reference:

And to help us figure out who should review this PR

  • Ambient
  • Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure

@istio-testing istio-testing added the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label Sep 29, 2023
@istio-policy-bot
Copy link

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

  • You can learn about how we write and maintain documentation, our style guidelines,
    and 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 with
    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, sanitize the Markdown, ensure all hyperlinks point to a
    valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
    lint_istio.io entry in the status section. Click on the Details link to get a list of the
    problems with your PR. Fix those problems and push an update; this will automatically re-run the
    tests. 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).
    To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
    release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@istio-testing istio-testing added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. needs-ok-to-test labels Sep 29, 2023
@istio-testing
Copy link
Contributor

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

@fykaa
Copy link
Author

fykaa commented Sep 29, 2023

Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

/ok-to-test

@istio-testing 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 Sep 30, 2023
Copy link
Contributor

@ilrudie ilrudie left a comment

Choose a reason for hiding this comment

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

Partial review with some suggestions. Over all it looks like a good start. Thanks!

content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
@fykaa fykaa marked this pull request as ready for review October 10, 2023 14:41
Copy link
Contributor

@ericvn ericvn left a comment

Choose a reason for hiding this comment

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

Sorry for so many suggestions.

content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
@dhawton
Copy link
Member

dhawton commented Dec 26, 2023

To resolve the missing link in lint, try rebasing your branch. It's a little behind master.

Choose a reason for hiding this comment

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

Where is port 5000 coming from in the diagram? Maybe we can reuse some of the diagrams in the previous Istio blogs:

content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved
content/en/docs/ops/ambient/usage/waypoint/index.md Outdated Show resolved Hide resolved

### Basic application deployment without ambient

This section is Under Construction.

Choose a reason for hiding this comment

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

This would a be a great thing to show- you can deploy the example apps, then install Istio in ambient mode without having to restart the applications. You can probably use the sleep/notsleep example apps from Lin's getting started guide: https://istio.io/latest/blog/2022/get-started-ambient/#deploy-your-applications.

If you wanted this section to show how you can have sidecars injected in an ambient-labeled namespace:

kubectl label namespace default istio.io/dataplane-mode=ambient --overwrite=true
kubectl apply -f sleep/sleep.yaml -n default

# notsleep is in sidecar mode
kubectl apply -f <(istioctl kube-inject -f sleep/notsleep.yaml) -n default

Copy link
Author

Choose a reason for hiding this comment

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

That should be great! I'll try doing it this way!
Also, I was trying to figure out a way through which a user can know if he/she has not deployed a waypoint. Are there any logs or similar things for User to look at?

@istio-policy-bot istio-policy-bot added the lifecycle/stale Indicates a PR or issue hasn't been manipulated by an Istio team member for a while label Jan 31, 2024
@linsun
Copy link
Member

linsun commented Jan 31, 2024

Hi @fykaa can you pls let us know if you are still working on this? I saw Nina proposed a few small wording changes and I've committed them. If you aren't, we are happy to pick it up.

@istio-policy-bot istio-policy-bot removed the lifecycle/stale Indicates a PR or issue hasn't been manipulated by an Istio team member for a while label Jan 31, 2024
@linsun
Copy link
Member

linsun commented Jan 31, 2024

Reviewers - may want to hold off reviews on this as @srampal and I discussed offline a while back, major rework will be required imho.

@fykaa
Copy link
Author

fykaa commented Jan 31, 2024

Hi @fykaa can you pls let us know if you are still working on this? I saw Nina proposed a few small wording changes and I've committed them. If you aren't, we are happy to pick it up.

I would love to invest time on this, might need some directions though.

@istio-testing istio-testing added the needs-rebase Indicates a PR needs to be rebased before being merged label Mar 8, 2024
@craigbox
Copy link
Contributor

Shall we get this ready to merge so we have something and we can then iterate on that?

@istio-testing istio-testing removed the needs-rebase Indicates a PR needs to be rebased before being merged label Mar 12, 2024
@craigbox
Copy link
Contributor

    ./en/docs/ops/ambient/usage/_index.md
        4 | owner: istio/wg-networking-maintainers 
        4 | owner: istio/wg-networking-maintainers 
>> 2 spelling errors found in 991 files

ummm wat

@istio-testing istio-testing added the needs-rebase Indicates a PR needs to be rebased before being merged label May 3, 2024
@istio-testing
Copy link
Contributor

PR needs rebase.

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-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-rebase Indicates a PR needs to be rebased before being merged ok-to-test Set this label allow normal testing to take place for a PR not submitted by an Istio org member. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.