Skip to content

Clarify the upgrade notes for v1.19#43913

Merged
qmonnet merged 8 commits intomainfrom
pr/joe/upgrade-notes
Jan 23, 2026
Merged

Clarify the upgrade notes for v1.19#43913
qmonnet merged 8 commits intomainfrom
pr/joe/upgrade-notes

Conversation

@joestringer
Copy link
Copy Markdown
Member

@joestringer joestringer commented Jan 21, 2026

Review commit by commit.

This PR creates some stronger structure around the upgrade notes in
the hopes of more clearly communicating to users what is changing and
when they may need to take action. The high level categories are:

  • Action Required
  • Informational Notes
  • Changes to Features
  • Changes to Metrics

Furthermore, for feature flags and metrics they are now sorted in the
following order: new, changed, deprecated, removed.

Clarify general wording in the upgrade notes and rearrange some of the
items for new features into the relevant docs section. In particular,
simplify some of the language to avoid third party reference to the
reader and instead directly inform them what they need to do.

Preview 2026-01-22: https://deploy-preview-43913--docs-cilium-io.netlify.app/operations/upgrade

@joestringer joestringer requested a review from a team as a code owner January 21, 2026 20:51
@joestringer joestringer added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. sig/policy Impacts whether traffic is allowed or denied based on user-defined policies. area/clustermesh Relates to multi-cluster routing functionality in Cilium. needs-backport/1.19 This PR / issue needs backporting to the v1.19 branch labels Jan 21, 2026
@joestringer joestringer requested a review from qmonnet January 21, 2026 20:51
@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 Jan 21, 2026
@joestringer joestringer requested review from a team, MrFreezeex and squeed January 21, 2026 20:52
@joestringer
Copy link
Copy Markdown
Member Author

@squeed this is related to the discussion you raised on Slack. We also discussed this topic during the weekly community meeting today. Please take a look, in particular at the commit focused on policy.

@MrFreezeex I made a few minor changes to the way that the Cluster Mesh upgrade notes were written, and I believe you had commented on this topic during the community meeting so I've requested your review here too in case you were interested.

@joestringer joestringer added the release-blocker/1.19 This issue will prevent the release of the next version of Cilium. label Jan 21, 2026
@joestringer joestringer moved this from Proposed to Active in Release blockers Jan 21, 2026
@joestringer joestringer added the release-note/misc This PR makes changes that have no direct user impact. label Jan 21, 2026
@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 Jan 21, 2026
@joestringer
Copy link
Copy Markdown
Member Author

@rgo3 FYI I added the last commit on here to address the encryption strict mode discussion we had on Slack.

@joestringer
Copy link
Copy Markdown
Member Author

/test

Copy link
Copy Markdown
Member

@MrFreezeex MrFreezeex left a comment

Choose a reason for hiding this comment

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

Thanks! I reviewed mostly from a Cluster Mesh perspective and looks great overall 🙏. I left one comment inline about one of the Cluster Mesh item but apart from that lgtm!

Commit 882a2e9 ("cilium: Introduce datapath-mode "auto"") added
this upgrade note to the v1.19 upgrade guide which breaks the docs
updates going on right now for actual v1.19, plus that feature won't
land until v1.20. Temporarily remove the release note to simplify the
upcoming rework of the upgrade notes. Another commit soon after will
reintroduce this in a new v1.20 upgrade guide section.

Signed-off-by: Joe Stringer <joe@cilium.io>
The FromRequires / ToRequires fields were not removed, but instead the
length of these fields was restricted to length 0. This allows us to
avoid making a breaking change to the format of the resource while still
enforcing that users do not use this unsupported field. Fix the upgrade
note to conform with this behavior.

Fixes: 4fbbc8b ("policy: Reintroduce From/ToRequires but mark them as deprecated")

Signed-off-by: Joe Stringer <joe@cilium.io>
This commit creates some stronger structure around the upgrade notes in
the hopes of more clearly communicating to users what is changing and
when they may need to take action. The high level categories are:

* Action Required
* Informational Notes
* Changes to Features
* Changes to Metrics

Furthermore, for feature flags and metrics they are now sorted in the
following order: new, changed, deprecated, removed.

This commit doesn't modify the text of the release notes, only
rearranges the ordering.

Signed-off-by: Joe Stringer <joe@cilium.io>
@joestringer
Copy link
Copy Markdown
Member Author

I applied the above feedback, rebased against main, and introduced a couple of extra commits here for v1.20 upgrade notes (since we're already starting to add those and we need to avoid the backport for those).

@joestringer joestringer added the backport/author The backport will be carried out by the author of the PR. label Jan 22, 2026
This commit clarifies the action required from users when interacting
with network policies during the v1.18 -> v1.19 upgrade.

Signed-off-by: Joe Stringer <joe@cilium.io>
Clarify general wording in the upgrade notes and rearrange some of the
items for new features into the relevant docs section.

Signed-off-by: Joe Stringer <joe@cilium.io>
Per out-of-band discussion with Robin, update this release note to
clarify when there might be packet loss related to the new encryption
strict mode feature.

Three changes here:
- Drops could happen any time the feature is turned on or off
- The disruption is only known to occur during the upgrade period
- We can simplify the language to address the reader more directly.

Signed-off-by: Joe Stringer <joe@cilium.io>
Add a new section for v1.20 release notes to live. This commit doesn't
remove v1.19 for now until we've released the final version, in case we
want to make some change on "main" and backport also to v1.19. We can
clean up that section soon after the release.

Signed-off-by: Joe Stringer <joe@cilium.io>
This commit reintroduces the datapath-mode=auto upgrade guide docs
from commit 882a2e9 ("cilium: Introduce datapath-mode "auto"").
This time it's the v1.20 upgrade notes section.

Signed-off-by: Joe Stringer <joe@cilium.io>
@joestringer
Copy link
Copy Markdown
Member Author

/test

Copy link
Copy Markdown
Member

@MrFreezeex MrFreezeex left a comment

Choose a reason for hiding this comment

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

Thanks! Looks great to me ClusterMesh wise :D

Copy link
Copy Markdown
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, nice work!

@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 Jan 23, 2026
@qmonnet qmonnet added this pull request to the merge queue Jan 23, 2026
Merged via the queue into main with commit 646a2ad Jan 23, 2026
73 checks passed
@qmonnet qmonnet deleted the pr/joe/upgrade-notes branch January 23, 2026 09:52
@github-project-automation github-project-automation bot moved this from Active to Done in Release blockers Jan 23, 2026
@joestringer joestringer added backport-pending/1.19 The backport for Cilium 1.19.x for this PR is in progress. and removed needs-backport/1.19 This PR / issue needs backporting to the v1.19 branch labels Jan 23, 2026
@github-actions github-actions bot added backport-done/1.19 The backport for Cilium 1.19.x for this PR is done. and removed backport-pending/1.19 The backport for Cilium 1.19.x for this PR is in progress. labels Jan 23, 2026
@cilium-release-bot cilium-release-bot bot moved this to Released in cilium v1.19.0 Feb 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/clustermesh Relates to multi-cluster routing functionality in Cilium. area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport/author The backport will be carried out by the author of the PR. backport-done/1.19 The backport for Cilium 1.19.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-blocker/1.19 This issue will prevent the release of the next version of Cilium. release-note/misc This PR makes changes that have no direct user impact. sig/policy Impacts whether traffic is allowed or denied based on user-defined policies.

Projects

Archived in project
Status: Released

Development

Successfully merging this pull request may close these issues.

5 participants