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

Organize ambient architecture doc #15005

Closed
linsun opened this issue Apr 30, 2024 · 5 comments
Closed

Organize ambient architecture doc #15005

linsun opened this issue Apr 30, 2024 · 5 comments
Assignees

Comments

@linsun
Copy link
Member

linsun commented Apr 30, 2024

Some discussion from #14994 (comment) where we may likely need to have multiple pages under ambient architecture. Open this to capture thoughts and actions.

Architecture:

cc @craigbox @bleggett

@bleggett
Copy link
Contributor

bleggett commented May 1, 2024

#15004 does this as a matter of course.

I think we do need at least 2 subheadings based on content we already have, as @craigbox 's doc already pointed out:

  • Architecture
    • Traffic Redirection
    • HBONE

@craigbox
Copy link
Contributor

craigbox commented May 2, 2024

  • Labels: should move under a "Adding your workload to the ambient mesh" page under /docs/ambient/usage/ ?
  • Layer 7 policy attachment to waypoints: should move to an "Attaching policy to waypoints" under /docs/ambient/usage/waypoints/, but I'm confused as I would expect to attach policy to workloads, not waypoints
  • Traffic routing: make this a sub-page of architecture?

@bleggett
Copy link
Contributor

bleggett commented May 2, 2024

Labels: should move under a "Adding your workload to the ambient mesh" page under /docs/ambient/usage/ ?

Yes please.

Something like

### Labels
#### Adding Workloads To Ambient Dataplane
(talk about adding `dataplane-mode` labels)
#### Enforcing L7 Policies In Ambient
(talk about adding `use-waypoint` labels) -> link to `Layer 7 Policy Attachment` subdoc

Layer 7 policy attachment to waypoints: should move to an "Attaching policy to waypoints" under /docs/ambient/usage/waypoints/, but I'm confused as I would expect to attach policy to workloads, not waypoints

I think if we breadcrumb from "for L7 policy, add a waypoint with this label" -> "then see this doc for applying L7 policy (to that waypoint)" it will be clear.

Or we can inline L7 policy and not have a "waypoint" section at all, since nobody cares about waypoints, outside of them being sine ne qua non for L7 policy.

@linsun
Copy link
Member Author

linsun commented May 7, 2024

Maybe complete now?

@craigbox
Copy link
Contributor

https://istio.io/latest/docs/ambient/architecture/ is now only a table of contents with subpages, a good base to build from.

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

3 participants