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

[1.13] Add documentation about bpf-clock breakage #27048

Merged
merged 1 commit into from
Jul 26, 2023

Conversation

margamanterola
Copy link
Member

@margamanterola margamanterola commented Jul 25, 2023

We've disabled bpfClockProbe everywhere with #26981 and backports. Document that long lived connections will be interrupted when upgrading to and from 1.13.4, the only release to ship with this enabled.

Document that upgrades to 1.13.4 may experience interruptions of existing connections, while upgrades from 1.13.4 may encounter lingering connections.

@margamanterola margamanterola added the release-note/misc This PR makes changes that have no direct user impact. label Jul 25, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot added backport/1.13 This PR represents a backport for Cilium 1.13.x of a PR that was merged to main. kind/backports This PR provides functionality previously merged into master. labels Jul 25, 2023
@margamanterola margamanterola removed kind/backports This PR provides functionality previously merged into master. backport/1.13 This PR represents a backport for Cilium 1.13.x of a PR that was merged to main. labels Jul 25, 2023
@margamanterola margamanterola added the area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. label Jul 25, 2023
@margamanterola margamanterola marked this pull request as ready for review July 25, 2023 12:17
@margamanterola margamanterola requested a review from a team as a code owner July 25, 2023 12:17
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.

Looks good, thanks

@pchaigno pchaigno added ready-to-merge This PR has passed all tests and received consensus from code owners to merge. upgrade-impact This PR has potential upgrade or downgrade impact. labels Jul 25, 2023
Comment on lines 453 to 455
* ``bpfClockProbe`` has been set to ``false`` everywhere to avoid interrupting
existing connections. It can still be manually set to ``true`` if the
``bpf-clock-probe`` behavior is desired.
Copy link
Member

Choose a reason for hiding this comment

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

I'm confused about this. bpfClockProbe is the helm option, shouldn't it be "bpfClockProbe behavior is desired."?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it should actually be "if the BPF clock probe behavior is desired" (i.e. no code text, this is talking about the underlying behavior), what do you think?

Copy link
Member Author

Choose a reason for hiding this comment

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

Reworded as mentioned. PTAL

Documentation/operations/upgrade.rst Outdated Show resolved Hide resolved
@aanm aanm removed the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jul 25, 2023
We've disabled bpfClockProbe everywhere with cilium#26981 and backports.
Document that existing connections may be interrupted when upgrading
to 1.13.4, the only release to ship with this enabled. On the other
hand, they may linger for too long if upgrading from that release to one
where bpf-clock-probe is no longer enabled.

Signed-off-by: Margarita Manterola <marga@isovalent.com>
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

LGTM, thanks.

@aanm aanm merged commit 025242a into cilium:v1.13 Jul 26, 2023
34 checks passed
@nbusseneau nbusseneau added kind/backports This PR provides functionality previously merged into master. backport/1.13 This PR represents a backport for Cilium 1.13.x of a PR that was merged to main. labels Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport/1.13 This PR represents a backport for Cilium 1.13.x of a PR that was merged to main. kind/backports This PR provides functionality previously merged into master. release-note/misc This PR makes changes that have no direct user impact. upgrade-impact This PR has potential upgrade or downgrade impact.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants