Release Documentation¶
Overview¶
Each new release of OVN-Kubernetes is defined with a "version" that represents the Git tag of a release, such as v1.0.0. This contains the following:
- Source Code
- Binaries
ovnkube: which is our main single all-in-one binary executable used to launch the ovnkube control plane and data plane pods in a kubernetes deploymentovn-k8s-cni-overlay: is the cni executable to be placed in /opt/cni/bin (or another directory in which kubernetes will look for the plugin) so that it can be invoked for each pod event by kuberneteshybrid-overlay-nodeovn-kube-util: contains the Utils for ovn-kubernetesovnkube-trace: is the binary that contains ovnkube-trace which is an abstraction used to invoke OVN/OVS packet tracing utilsovnkube-identity: is the executable that is invoked to run ovn-kubernetes identity manager, which includes the admission webhook and the CertificateSigningRequest approver
ovnkubeAPI configuration- scripts used to deploy OVN-Kubernetes including helm charts
- Images for fedora and ubuntu
Release Planning¶
- OVN-Kubernetes uses milestones to track release planning
- All feature PRs and OKEPs must be tagged with the milestone corresponding to their target release before merging, so that they are included in release planning and release notes generation
- Bug fix PRs should also be tagged with the milestone of the release they target
- If you are unsure which release a feature or fix will land in, tag it under the Unplanned Backlog milestone — a maintainer will triage and assign it to the correct release
- Please check our roadmap for more details on our release tracking process
Release Cadence¶
- We will do three major releases each year. Ex: 1.x.0 in April 2026 and 1.y.0 in August 2026 and 1.z.0 in December 2026
- The release timings have been fixed roughly to be 3 or so months after a major Kubernetes release (allowing time for that to stabilize and for us to consume that kube release before we cut our own release)
- At a given time we will maintain only two active major releases (So when 1.2.0 is released we will stop maintaining and backporting fixes into 1.0.0)
- For a supported major release we will continue to do backports for backfixes and offer support. A minor patch release will be done at a cadence of 4 weeks for every major release. Ex. Once 1.0.0 is released, we will do 1.0.1, 1.0.2, 1.0.3 etc. This also depends on a case-by-case basis based on demands from end-users and backport statuses.
Release Process¶
- You can find our current releases here.
- Every major release cut will be preceded by an alpha prerelease and beta prerelease.
- See sample release PR which will become the head commit for a given release.
- Branch will be cut on the day of release once the release PR merges.
- Create the
backport:release-X.Ylabel for the new branch, and delete the label of the release that goes out of support. - Mark the release that goes out of support as not maintained anymore in Information on Past Releases.
Release Notes¶
- Every PR must include a
release-notefenced code block in its description (enforced by CodeRabbit). These notes are collected during release cuts to highlight user-facing changes in the changelog. The block must contain either a short user-facing description of the change or the single wordNONE.or for non-user-facing changes:```release-note Added support for X feature in Y component. ``````release-note NONE ``` - Write a release note when the PR does any of the following:
- Adds a new user-facing feature or capability
- Introduces or changes a CLI flag, config knob, or Helm value that operators set
- Adds, changes, or removes a CRD, API field, or user-facing annotation contract
- Changes Helm chart templates, default values, or upgrade behavior that affects rendered output
- Deprecates or removes existing functionality
- Introduces a breaking change or migration step that affects operators or end users
- Changes default behavior users or operators rely on
- Fixes a bug whose resolution changes user-visible behavior or compatibility (exception: if the bug was never reported by users and the fix lands before any release ships with the broken behavior,
NONEis acceptable) - Use
NONEfor everything else: routine bug fixes, refactors, test changes, CI improvements, docs, internal-only changes, performance/scale work, and internal architecture migrations. - Release notes are generated from the
release-noteblocks of all PRs merged into a release. Any PR with a meaningful (non-NONE)release-noteblock will be included in the release notes.
Backport Request¶
- If a PR needs to be backported to an older release, request it by adding a
backport:release-X.Ylabel to the PR for each target release. Only maintained releases have a label. - If you cannot add labels, ask in a PR comment, on slack or at the community meeting and someone with triage or write access will add them.
Automated backport¶
The backport GitHub workflow acts on the backport:release-X.Y labels. They can be added before or after the merge. Once the PR is merged, the workflow cherry-picks its commits onto each labeled release branch and opens a PR titled [release-X.Y] <original title> that links to the original PR and copies its description and assignees.
If a cherry-pick does not apply cleanly, or the PR branch contains merge commits, no PR is opened for that release and the workflow posts a comment on the original PR with the commands to cherry-pick locally. Follow the manual steps below in that case.
Preparing a backport manually¶
- Create a branch from the target
release-X.Ybranch. - Cherry-pick the original commits with
git cherry-pick -x <commit>so each backport commit records its source. -
Resolve any conflicts, keeping the fix appropriate for the release branch. When conflicts occur, we recommend keeping a
Conflicts:section in the final commit message. List the affected files and briefly explain why each conflict occurred and how it was resolved. For example:Conflicts: go-controller/pkg/ovn/example.go The release branch lacks the helper introduced by a later refactor. Applied the fix to the existing inline logic. -
Run the relevant tests on the release branch, including coverage of any conflict resolutions.
- Open a PR targeting
release-X.Y, link the original PR, and describe any adaptations and the testing performed. Prepare a separate PR for each target release.
Information on Past Releases¶
- v1.0.0 - release-notes - not maintained anymore.
- v1.1.0 - release-notes - not maintained anymore.
- v1.2.0 - release-notes - not maintained anymore.
- v1.3.0 - release-notes - actively maintained
- v1.4.0 - release-notes - actively maintained