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.

Sign up for GitHub

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

Jump to bottom

Refresh ambient architecture doc #14994

Merged
merged 32 commits into from May 1, 2024
Merged

Refresh ambient architecture doc #14994

merged 32 commits into from May 1, 2024

Conversation

linsun
Copy link
Member

@linsun linsun commented Apr 29, 2024

Description

adding a section for ambient APIs, and refresh rest of docs.

Reviewers

  • [ x ] Ambient
  • [ x ] Docs
  • Installation
  • Networking
  • Performance and Scalability
  • Extensions and Telemetry
  • Security
  • Test and Release
  • User Experience
  • Developer Infrastructure
  • Localization/Translation

@linsun linsun requested a review from a team as a code owner April 29, 2024 19:52
@istio-testing istio-testing added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 29, 2024
@linsun
Copy link
Member Author

linsun commented Apr 29, 2024 •
edited

Hi @louiscryan @howardjohn @ilrudie @MorrisLaw @stevenctl could you pls review and see if these update are correct? Thanks!

howardjohn
howardjohn reviewed Apr 30, 2024
View reviewed changes
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
linsun and others added 3 commits April 29, 2024 22:11
@linsun @howardjohn
Update content/en/docs/ambient/architecture/index.md
75060b4 
Co-authored-by: John Howard <john.howard@solo.io>
@linsun @howardjohn
Update content/en/docs/ambient/architecture/index.md
71aa137 
Co-authored-by: John Howard <john.howard@solo.io>
@linsun
use targetRefs
f2cd795
@craigbox
Copy link
Contributor

We need to have a "technical overview of how ambient works" page. It can be based on the blogs we've done. This page is at risk of being "things we haven't put anywhere else" - I thought the stuff about traffic routing should be on its own page. But we can add things as they come in and I can reorganise them as we build it out!

@linsun
Copy link
Member Author

linsun commented Apr 30, 2024

We need to have a "technical overview of how ambient works" page. It can be based on the blogs we've done. This page is at risk of being "things we haven't put anywhere else" - I thought the stuff about traffic routing should be on its own page. But we can add things as they come in and I can reorganise them as we build it out!

Sounds good, thank you so much for offering to organize them so we can focus on getting the contents out first. :)

@linsun
Copy link
Member Author

linsun commented Apr 30, 2024

I removed SE and WE from the supported value of use-waypoint, given we don't claim to support VM or external service, I don't feel comfortable to claim them beta.

@linsun
Copy link
Member Author

linsun commented Apr 30, 2024

I removed SE and WE from the supported value of use-waypoint, given we don't claim to support VM or external service, I don't feel comfortable to claim them beta.

tagging @craigbox and @zirain as we should document this in release notes:

ServiceEntry and WorkloadEntry for the istio.io/use-waypoint label support is under development and should land in a future release soon.

bleggett
bleggett reviewed Apr 30, 2024
View reviewed changes
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Show resolved Hide resolved
bleggett
bleggett reviewed Apr 30, 2024
View reviewed changes
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
@bleggett bleggett mentioned this pull request Apr 30, 2024
Merged
11 tasks
@linsun linsun mentioned this pull request Apr 30, 2024
Closed
@linsun
Copy link
Member Author

linsun commented Apr 30, 2024

Hi @ericvn could you take a look? All comments have addressed and @bleggett is also waiting on this for his https://github.com/istio/istio.io/pull/15004/files

@linsun
Copy link
Member Author

linsun commented Apr 30, 2024

Hi @bleggett can you take another review and approve if all good?

ericvn
ericvn reviewed May 1, 2024
View reviewed changes
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.

A few minor comments.

content/en/docs/ambient/architecture/index.md Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
content/en/docs/ambient/architecture/index.md Outdated Show resolved Hide resolved
linsun and others added 8 commits May 1, 2024 14:19
@linsun @ericvn
Update content/en/docs/ambient/architecture/index.md
7fd4f17 
Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
@linsun @ericvn
Update content/en/docs/ambient/architecture/index.md
f328b52 
Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
@linsun @ericvn
Update content/en/docs/ambient/architecture/index.md
6083fed 
Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
@linsun @ericvn
Update content/en/docs/ambient/architecture/index.md
4d73e5f 
Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
@linsun @ericvn
Update content/en/docs/ambient/architecture/index.md
12f03a3 
Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
@linsun @ericvn
Update content/en/docs/ambient/architecture/index.md
cd53d90 
Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
@linsun @ericvn
Update content/en/docs/ambient/architecture/index.md
391bf20 
Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
@linsun @ericvn
Update content/en/docs/ambient/architecture/index.md
230daf3 
Co-authored-by: Eric Van Norman <ericvn@us.ibm.com>
@istio-testing istio-testing merged commit 12d2362 into istio:master May 1, 2024
6 checks passed
@craigbox craigbox mentioned this pull request May 2, 2024
Merged
wilsonwu added a commit to wilsonwu/istio.io that referenced this pull request May 2, 2024
@wilsonwu
Sync istio#14994 refresh ambient architecture doc into Chinese
330de50
@wilsonwu wilsonwu mentioned this pull request May 2, 2024
Merged
11 tasks
istio-testing pushed a commit that referenced this pull request May 6, 2024
@wilsonwu @windsonsea
[zh] Sync #14994 refresh ambient architecture doc into Chinese (#15012)
e00e6dd 
* Sync #14994 refresh ambient architecture doc into Chinese

* Apply suggestions from code review

Co-authored-by: Michael <haifeng.yao@daocloud.io>

---------

Co-authored-by: Michael <haifeng.yao@daocloud.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@howardjohn howardjohn howardjohn left review comments

@wilsonwu wilsonwu wilsonwu left review comments

@ilrudie ilrudie ilrudie left review comments

@MorrisLaw MorrisLaw MorrisLaw left review comments

@louiscryan louiscryan louiscryan left review comments

@bleggett bleggett bleggett approved these changes

@ericvn ericvn ericvn approved these changes

Assignees
No one assigned
Labels
area/ambient kind/docs size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet