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

Documentation: Fix Envoy LB docs incorrect supported annotation values #26867

Merged
merged 1 commit into from Jul 21, 2023
Merged

Documentation: Fix Envoy LB docs incorrect supported annotation values #26867

merged 1 commit into from Jul 21, 2023

Conversation

rauanmayemir
Copy link
Contributor

There is a one-liner example that advices adding correct service.cilium.io/lb-l7=enabled annotation, but the table with supported annotations has a typo with incorrect envoy option instead of enabled.

@rauanmayemir rauanmayemir requested review from a team as code owners July 17, 2023 14:37
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jul 17, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Jul 17, 2023
@rauanmayemir rauanmayemir changed the title Fix Envoy LB docs incorrect supported annotation values Documentation: Fix Envoy LB docs incorrect supported annotation values Jul 17, 2023
zacharysarah
zacharysarah approved these changes Jul 17, 2023
View reviewed changes
Copy link
Contributor

@zacharysarah zacharysarah left a comment

Choose a reason for hiding this comment

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

LGTM for docs

meyskens
meyskens approved these changes Jul 18, 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.

Good catch! LGTM this is indeed the correct value

qmonnet
qmonnet approved these changes Jul 18, 2023
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

The mistake probably comes from the fact that the Helm value loadBalancer.l7.backend currently accepts either envoy or disabled. But the correct value for the lb-l7 annotation is indeed enabled, as can be seen here.

Thanks!

@qmonnet qmonnet added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/proxy Impacts proxy components, including DNS, Kafka, Envoy and/or XDS servers. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Jul 18, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Jul 18, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from main in 1.14.0 Jul 18, 2023
@qmonnet
Copy link
Member

qmonnet commented Jul 18, 2023

Could you please rebase on top of the current main branch? I believe the documentation builds were broken (then fixed) recently, and it would be nice to ensure the Netlify preview builds correctly before merging this PR.

@maintainer-s-little-helper
Copy link

Commit d1d7abc3fde7ec625eff90fe90733fd4a4d0637e does not contain "Signed-off-by".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin

1 similar comment
@maintainer-s-little-helper
Copy link

Commit d1d7abc3fde7ec625eff90fe90733fd4a4d0637e does not contain "Signed-off-by".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Jul 19, 2023
@rauanmayemir
Copy link
Contributor Author

I messed it up with the merge commit, that's what you get for using github UI. Will try to fix the tree.

@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Jul 19, 2023
@rauanmayemir
Copy link
Contributor Author

Nice. https://deploy-preview-26867--docs-cilium-io.netlify.app/network/servicemesh/envoy-load-balancing.html#supported-annotations

@rauanmayemir rauanmayemir force-pushed the patch-1 branch 2 times, most recently from bbce54b to fb90c4f Compare July 21, 2023 08:36
@rauanmayemir
Fix Envoy LB docs incorrect supported annotation values
f4cacd0 
Signed-off-by: Rauan Mayemir <rauan@mayemir.io>
qmonnet
qmonnet approved these changes Jul 21, 2023
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

All good, thank you!

@qmonnet qmonnet added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jul 21, 2023
@aditighag aditighag merged commit 0040720 into cilium:main Jul 21, 2023
40 checks passed
@rauanmayemir rauanmayemir deleted the patch-1 branch July 22, 2023 02:54
@nbusseneau nbusseneau mentioned this pull request Jul 24, 2023
Merged
21 tasks
@nbusseneau nbusseneau 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 Jul 24, 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.0 Jul 24, 2023
@nbusseneau nbusseneau 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 Jul 25, 2023
@aanm aanm moved this from Backport pending to v1.14 to Backport done to v1.14 in 1.14.0 Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meyskens meyskens meyskens approved these changes

@zacharysarah zacharysarah zacharysarah approved these changes

@qmonnet qmonnet qmonnet approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/proxy Impacts proxy components, including DNS, Kafka, Envoy and/or XDS servers. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. kind/community-contribution This was a contribution made by a community member. 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.
Projects
No open projects
1.14.0
Backport done to v1.14
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@rauanmayemir @qmonnet @meyskens @zacharysarah @nbusseneau @aditighag