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

docs: remove annotations-based l7 visibility #28449

Merged
merged 1 commit into from
Oct 31, 2023

Conversation

networkop
Copy link
Contributor

L7-based annotations have had little adoption and are causing a lot of bugs. This change is to move them to the background in the docs and bring forward the more standard way of enabling L7 visibility (CNP)

@networkop networkop requested review from a team as code owners October 6, 2023 14:26
@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 Oct 6, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Oct 6, 2023
Copy link
Member

@sayboras sayboras left a comment

Choose a reason for hiding this comment

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

Thanks ✅

@sayboras sayboras added area/proxy Impacts proxy components, including DNS, Kafka, Envoy and/or XDS servers. release-note/minor This PR changes functionality that users may find relevant to operating Cilium. labels Oct 6, 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 Oct 6, 2023
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.

Looks great! I just have a couple of suggestions. Also, can you add a note about this in the upgrade guide: https://github.com/cilium/cilium/blob/main/Documentation/operations/upgrade.rst#115-upgrade-notes?

Documentation/observability/visibility.rst Show resolved Hide resolved
Documentation/observability/visibility.rst Show resolved Hide resolved
Documentation/observability/visibility.rst Outdated Show resolved Hide resolved
Documentation/observability/visibility.rst Outdated Show resolved Hide resolved
Documentation/security/policy/language.rst Outdated Show resolved Hide resolved
Documentation/observability/visibility.rst Outdated Show resolved Hide resolved
@networkop networkop force-pushed the pr/networkop/docs-update-l7visibility branch from 4a71ef0 to 2184b06 Compare October 10, 2023 15:18
@networkop networkop requested a review from a team as a code owner October 10, 2023 15:18
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.

Changes look great, thanks! I have a couple of suggestions for you, and then we'll be good to go.

Documentation/observability/visibility.rst Outdated Show resolved Hide resolved
Documentation/observability/visibility.rst Outdated Show resolved Hide resolved
Documentation/observability/visibility.rst Show resolved Hide resolved
Documentation/observability/visibility.rst Outdated Show resolved Hide resolved
Documentation/observability/visibility.rst Show resolved Hide resolved
@networkop networkop force-pushed the pr/networkop/docs-update-l7visibility branch 2 times, most recently from 64dc78b to 76616db Compare October 12, 2023 13:19
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.

LGTM! Thank you!

@joestringer joestringer added the dont-merge/needs-rebase This PR needs to be rebased because it has merge conflicts. label Oct 20, 2023
@joestringer
Copy link
Member

@networkop this fell out of date, please rebase. @cilium/proxy please review

@sayboras
Copy link
Member

cilium/proxy please review

👍, my review can be counted from proxy team. I had a chat with Michael offline before as well.

@networkop networkop force-pushed the pr/networkop/docs-update-l7visibility branch 2 times, most recently from 44940bc to fa01074 Compare October 25, 2023 18:07
Signed-off-by: Michael Kashin <michael.kashin@isovalent.com>
@networkop networkop force-pushed the pr/networkop/docs-update-l7visibility branch from fa01074 to 0405731 Compare October 26, 2023 07:16
@networkop networkop force-pushed the pr/networkop/docs-update-l7visibility branch 5 times, most recently from 01fcacc to dee23ee Compare October 26, 2023 08:18
@dylandreimerink dylandreimerink removed the dont-merge/needs-rebase This PR needs to be rebased because it has merge conflicts. label Oct 30, 2023
@dylandreimerink
Copy link
Member

@networkop Given its docs we don't need to run the whole test suite, is this "ready-to-merge"?

@networkop
Copy link
Contributor Author

@dylandreimerink yes, it's ready to merge from my pov.

@joestringer
Copy link
Member

@dylandreimerink CI should detect that it's only docs and skip the other tests. This way we can just run CI on every PR, and not debate about ready-to-merge from CI perspective. If this is triggering full CI then we can iterate on the detection, I would consider that a CI bug. I'm trying to get us to a point where we don't try to make judgement calls about whether to skip CI or not, because that often becomes a point of failure in the process where we let buggy logic into the tree.

@joestringer
Copy link
Member

/test

@aanm aanm merged commit 9100d67 into cilium:main Oct 31, 2023
59 checks passed
@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 Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/proxy Impacts proxy components, including DNS, Kafka, Envoy and/or XDS servers. 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/minor This PR changes functionality that users may find relevant to operating Cilium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants