README: add new versioning and compatibility policy (#72)

We introduce a new versioning schema that is aligned with the versioning of Kubernetes releases and we add declare a compatibility policy and matrix. The compatibility matrix will need to be updated with every release. --------- Co-authored-by: Philipp Sauter <[email protected]>
exoscale · Jan 8, 2024 · 45faa3a · 45faa3a
1 parent 4f0b614
commit 45faa3a
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## UNRELEASED
+
+### Improvements
+
+* README: add new versioning and compatibility policy (#72)
+
 ## 0.14.1
 
 ### Bug Fixes

diff --git a/README.md b/README.md
@@ -23,6 +23,19 @@ The Exoscale CCM implements the following [controllers][k8s-ccm-controllers]:
 To get started with the Exoscale Cloud Controller Manager, please read the
 [following guide](docs/getting-started.md).
 
+## Versioning and compatibility policy
+
+The exoscale CCM adheres to [Semantic Versioning](https://semver.org/).
+
+New minor versions *after* `0.14` are aligned with the minor version number of the latest Kubernetes release.
+The aligned version `0.y` is compatible with Kubernetes version `1.y` and unless specified otherwise in the compatibility matrix below, CCM `0.y` is also compatible with the two most recent Kubernetes minor versions before `1.y`. Versions that are even older may work but without guarantee.
+For example, CCM `0.99` would be compatible with Kubernetes versions `1.99`, `1.98` and `1.97`.
+
+### Compatibility Matrix
+
+| CCM version | supported Kubernetes versions |
+|-------------|-------------------------------|
+| 0.14        | 1.28, 1.27, 1.26              | 
 
 ## Contributing