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

Refresh Ztunnel docs for Istio 1.22 Ambient Beta release #14983

Closed
4 tasks
MorrisLaw opened this issue Apr 26, 2024 · 13 comments
Closed
4 tasks

Refresh Ztunnel docs for Istio 1.22 Ambient Beta release #14983

MorrisLaw opened this issue Apr 26, 2024 · 13 comments
Assignees

Comments

@MorrisLaw
Copy link
Contributor

MorrisLaw commented Apr 26, 2024

In preparation for the Ambient beta release in Istio 1.22, we'll need to ensure docs are up to date. This ticket addresses Ztunnel docs:

@bleggett
Copy link
Contributor

Would advocate that docs/ops/ambient/usage/traffic-redirection go under an architecture section, it is 100% an architectural explainer and 0% a usage guide.

@bleggett
Copy link
Contributor

bleggett commented Apr 30, 2024

Would additionally advocate that we take the HBONE section out of docs/ambient/usage/ztunnel/ and spin it out as the start of an "HBONE" doc

#13482

(I may do this unless you want/intend to)

@bleggett
Copy link
Contributor

Would additionally advocate that we take the HBONE section out of docs/ambient/usage/ztunnel/ and spin it out as the start of an "HBONE" doc

#13482

(I may do this unless you want/intend to)

#15004 all right, there.

Shouldn't impact you for this issue much, except it removes the HBONE section from the ztunnel doc.

@linsun
Copy link
Member

linsun commented Apr 30, 2024

A couple of things I'd like to see us clean up on the ztunnel page(https://preliminary.istio.io/latest/docs/ambient/usage/ztunnel/):

@MorrisLaw
Copy link
Contributor Author

we should use the new istioctl x ztunnel-config cmd instead proxy-config imho.

Good catch!! Definitely should not use proxy-config to get ztunnel info, it wouldn't work!

I'll push something up shortly to cover some of the things on that list, thank you for writing that up @linsun

@bleggett
Copy link
Contributor

bleggett commented May 2, 2024

We should probably remove this whole section https://preliminary.istio.io/latest/docs/ambient/usage/ztunnel/#data-plane-overview

from the usage guide and link to "traffic redirection" in https://preliminary.istio.io/latest/docs/ambient/architecture/

EDIT: should be largely done with #15024

@craigbox
Copy link
Contributor

craigbox commented May 5, 2024

You will want to review #15028 pretty closely, @linsun!

Regarding things that we won't support, it would be good to be clear about the difference between "we won't support this" and "it seems to Just Work", which was how the document was written to start with.

@MorrisLaw
Copy link
Contributor Author

cc/ @linsun @craigbox @bleggett

A lot has been updated and moved at this point. How are we looking on the Ztunnel front? Should we close this out as complete now or are there some things still in flight?

@craigbox
Copy link
Contributor

craigbox commented May 7, 2024

I'll move the L7 stuff around today and then I would love at least one person to read every page front to back.

@bleggett
Copy link
Contributor

bleggett commented May 7, 2024

I'll move the L7 stuff around today and then I would love at least one person to read every page front to back.

I'll commit to doing that, @ me when you need it.

@MorrisLaw
Copy link
Contributor Author

I'll move the L7 stuff around today and then I would love at least one person to read every page front to back.

I can also go through it when it's ready

@MorrisLaw
Copy link
Contributor Author

@craigbox @bleggett has review for this already happened or are we waiting to review something specifically before closing this out? FWIW, the scope of this ticket is Ztunnel stuff (so not layer 7, waypoint docs).

@bleggett
Copy link
Contributor

I believe we are good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants