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

Update Service Mesh docs #27231

Merged
merged 1 commit into from Aug 8, 2023
Merged

Update Service Mesh docs #27231

merged 1 commit into from Aug 8, 2023

Conversation

youngnick
Copy link
Contributor

@youngnick youngnick commented Aug 3, 2023 •
edited

Updates Service mesh docs to add some more explanation and cover some features more correctly. Each change is in a separate commit.

I was fixing #27167 when I noticed some other things that were missing, so I've hit all the ones I can find while I'm at it.

Fixes: #27167

@youngnick youngnick added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. sig/agent Cilium agent related. area/servicemesh GH issues or PRs regarding servicemesh labels Aug 3, 2023
@youngnick youngnick requested review from a team as code owners August 3, 2023 05:57
@maintainer-s-little-helper maintainer-s-little-helper bot added dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Aug 3, 2023
@youngnick youngnick added the release-note/misc This PR makes changes that have no direct user impact. label Aug 3, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Aug 3, 2023
@youngnick youngnick force-pushed the service-mesh-doc-fixes branch 2 times, most recently from ff43490 to d361770 Compare August 3, 2023 06:13
meyskens
meyskens approved these changes Aug 3, 2023
View reviewed changes
Copy link
Member

@meyskens meyskens left a comment

Choose a reason for hiding this comment

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

Small nit and a suggestion but overall an LGTM for me

learnitall
learnitall requested changes Aug 4, 2023
View reviewed changes
Copy link
Contributor

@learnitall learnitall left a comment

Choose a reason for hiding this comment

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

Well done! Really well written! I just have a couple of small nits and suggestions for you.

Documentation/internals/cilium_operator.rst Show resolved Hide resolved
Documentation/network/servicemesh/ingress.rst Outdated Show resolved Hide resolved
Documentation/network/servicemesh/l7-traffic-management.rst
create multiple CECs that modify the same parts of Envoy's config, the results
may be unpredictable.
* In addition to this minimal validation, ``CiliumEnvoyConfig`` has minimal
feedback to the user about the correctness of the configuration. So in the
Copy link
Contributor

Choose a reason for hiding this comment

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

Small grammar nit

Suggested change
feedback to the user about the correctness of the configuration. So in the
feedback to the user about the correctness of the configuration. In the

Documentation/network/servicemesh/l7-traffic-management.rst Outdated Show resolved Hide resolved
@learnitall learnitall added the needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch label Aug 4, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.14.1 Aug 4, 2023
learnitall
learnitall approved these changes Aug 7, 2023
View reviewed changes
Copy link
Contributor

@learnitall learnitall left a comment

Choose a reason for hiding this comment

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

Awesome looks good!

@learnitall
Copy link
Contributor

Hey @youngnick, two questions for you:

  • Do you mind squashing commits before merging?
  • Would you mind handling the backports for 1.13 (and 1.12 if needed)? I'm not super familiar with all of these features and their timelines, but I believe that only some of the changes in this PR need to be backported to pre-1.14, correct?

@youngnick
Copy link
Contributor Author

Yes, no problem about squashing (although I'll keep another branch with the individual commits to make those backports easier).

And yes, I can handle backporting.

@youngnick
Update Service Mesh docs to fix a number of issues
a0296c3 
Update Service Mesh landing page with extra explanation of what
Service Mesh is.

Add CiliumEnvoyConfig caveats to docs.

Update details about Ingress annotation copying.

Add Gateway API basic explanation to docs.

Add Operators role in service mesh features to docs

Signed-off-by: Nick Young <nick@isovalent.com>
This was referenced Aug 8, 2023
Merged
Closed
Merged
@youngnick
Copy link
Contributor Author

/test

@youngnick youngnick merged commit 1cb2210 into cilium:main Aug 8, 2023
55 checks passed
@youngnick youngnick deleted the service-mesh-doc-fixes branch August 8, 2023 06:03
@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Aug 8, 2023
@joamaki joamaki mentioned this pull request Aug 8, 2023
Merged
9 tasks
@joamaki joamaki added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Aug 8, 2023
@youngnick youngnick added backport/1.12 This PR represents a backport for Cilium 1.12.x of a PR that was merged to main. backport/1.13 This PR represents a backport for Cilium 1.13.x of a PR that was merged to main. labels Aug 9, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from main to Backport pending to v1.14 in 1.14.1 Aug 9, 2023
@joamaki joamaki added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Aug 9, 2023
@nebril nebril moved this from Backport pending to v1.14 to Backport done to v1.14 in 1.14.1 Aug 10, 2023
@nebril nebril mentioned this pull request Aug 10, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@squeed squeed squeed approved these changes

@meyskens meyskens meyskens approved these changes

@learnitall learnitall learnitall approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/servicemesh GH issues or PRs regarding servicemesh backport/1.12 This PR represents a backport for Cilium 1.12.x of a PR that was merged to main. backport/1.13 This PR represents a backport for Cilium 1.13.x of a PR that was merged to main. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact. sig/agent Cilium agent related.
Projects
No open projects
1.14.1
Backport done to v1.14
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document cilium-operator role in Service Mesh
5 participants
@youngnick @learnitall @squeed @meyskens @joamaki