Skip to content

Commit 6683d5b

Browse files
authored
Merge pull request #1504 from tkatila/doc-release-procedures
doc: add a release procedures section
2 parents f7f2c3b + 791d6c8 commit 6683d5b

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ Table of Contents
2727
* [Demos](#demos)
2828
* [Workload Authors](#workload-authors)
2929
* [Developers](#developers)
30-
* [Supported Kubernetes versions](#supported-kubernetes-versions)
30+
* [Releases](#releases)
31+
* [Supported Kubernetes versions](#supported-kubernetes-versions)
32+
* [Release procedures](#release-procedures)
3133
* [Pre-built plugin images](#pre-built-plugin-images)
3234
* [License](#license)
3335
* [Helm charts](#helm-charts)
@@ -255,7 +257,9 @@ The summary of resources available via plugins in this repository is given in th
255257
For information on how to develop a new plugin using the framework or work on development task in
256258
this repository, see the [Developers Guide](DEVEL.md).
257259

258-
## Supported Kubernetes Versions
260+
## Releases
261+
262+
### Supported Kubernetes Versions
259263

260264
Releases are made under the github [releases area](https://github.com/intel/intel-device-plugins-for-kubernetes/releases). Supported releases and
261265
matching Kubernetes versions are listed below:
@@ -276,8 +280,17 @@ matching Kubernetes versions are listed below:
276280
| release-0.15 | Kubernetes 1.15 branch v1.15.x | unsupported |
277281
| release-0.11 | Kubernetes 1.11 branch v1.11.x | unsupported |
278282

279-
[Go environment]: https://golang.org/doc/install
280-
[Kubernetes cluster]: https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/
283+
*Note:* Device plugins leverage the Kubernetes v1 API. The API itself is GA (generally available) and [does not change](https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-changes) between Kubernetes versions. One does not necessarily need to use the latest Kubernetes cluster with the latest device plugin version. Using a newer device plugins release should work without issues on an older Kubernetes cluster. One possible exception to this are the device plugins CRDs that can vary between versions.
284+
285+
[Go environment](https://golang.org/doc/install) | [Kubernetes cluster setup](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/)
286+
287+
### Release procedures
288+
289+
Project's release cadence is tied to Kubernetes release cadence. Device plugins release typically follows a couple of weeks after the Kubernetes release. There can be some delays on the releases due to required changes in the pull request pipeline. Once the content is available in the `main` branch and CI & e2e validation <span style="color:green">PASS</span>es, release branch will be created (e.g. release-0.26). The HEAD of release branch will also be tagged with the corresponding [tag](https://github.com/intel/intel-device-plugins-for-kubernetes/tags) (e.g. v0.26.0).
290+
291+
During the [release creation](https://github.com/intel/intel-device-plugins-for-kubernetes/issues/1393), the project's documentation, deployment files etc. will be [changed](https://github.com/intel/intel-device-plugins-for-kubernetes/pull/1441) to point to the newly created version.
292+
293+
Patch releases (e.g. 0.26.3) are done on a need basis if there are security issues or minor fixes requested for specific version. Fixes are always cherry-picked from the `main` branch to the release branches.
281294

282295
## Pre-built plugin images
283296

0 commit comments

Comments
 (0)