From d03558809f1a083634141b3593a87b11fa55539e Mon Sep 17 00:00:00 2001 From: Nabarun Pal Date: Sat, 14 Nov 2020 02:44:47 +0530 Subject: [PATCH 1/4] Clarify support cycles for the releases temporarily Releases are being fast tracked until we sync with the upstream releases. The older releases will continue to be maintained for that transition period or related upstream version deprecation whichever is later. Signed-off-by: Nabarun Pal --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b27a46c944..6c2335da47 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,8 @@ Kubernetes supports [three minor releases](https://github.com/kubernetes/communi Note: There would be no maintenance for alpha/beta releases except the latest one. +**Exception to the above support rule:** Since we are running behind on releases, we will support Alpha/Beta releases for a greater number of clients until we catch up with the upstream version. + ## Community, Support, Discussion If you have any problem on using the package or any suggestions, please start with reaching the [Kubernetes clients slack channel](https://kubernetes.slack.com/messages/C76GB48RK/), or filing an [issue](https://github.com/kubernetes-client/python/issues) to let us know. You can also reach the maintainers of this project at [SIG API Machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery), where this project falls under. From cf3dc147d8d82ccaf5b30b320ce8f0d4df20636f Mon Sep 17 00:00:00 2001 From: Nabarun Pal Date: Sat, 14 Nov 2020 02:48:32 +0530 Subject: [PATCH 2/4] Refactor the format of compatibitility matrix Signed-off-by: Nabarun Pal --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6c2335da47..c8a7e1529f 100644 --- a/README.md +++ b/README.md @@ -80,14 +80,12 @@ All APIs and Models' documentation can be found at the [Generated client's READM client-python gets increased, your code will continue to work with explicitly supported versions of Kubernetes clusters. -#### Compatibility matrix - -| | Kubernetes 1.13 | Kubernetes 1.14 | Kubernetes 1.15 | -|--------------------|-----------------|-----------------|-----------------| -| client-python 9.0 |✓ |+- |+- | -| client-python 10.0 |+- |✓ |+- | -| client-python 11.0 |+- |+- |✓ | -| client-python HEAD |+- |+- |+- | +#### Compatibility matrix of supported client versions + +- [client 9.y.z](https://pypi.org/project/kubernetes/9.0.1/): Kubernetes 1.12 or below (+-), Kubernetes 1.13 (✓), Kubernetes 1.14 or above (+-) +- [client 10.y.z](https://pypi.org/project/kubernetes/10.1.0/): Kubernetes 1.13 or below (+-), Kubernetes 1.14 (✓), Kubernetes 1.14 or above (+-) +- [client 11.y.z](https://pypi.org/project/kubernetes/11.0.0/): Kubernetes 1.14 or below (+-), Kubernetes 1.15 (✓), Kubernetes 1.16 or above (+-) +- [client 12.y.z](https://pypi.org/project/kubernetes/12.0.1/): Kubernetes 1.15 or below (+-), Kubernetes 1.16 (✓), Kubernetes 1.17 or above (+-) Key: From 3890d6d7df483ae66551d8edeae2a49b55f64353 Mon Sep 17 00:00:00 2001 From: Nabarun Pal Date: Tue, 17 Nov 2020 03:18:40 +0530 Subject: [PATCH 3/4] Add v17.14.0a1 to the compatibility matrix Signed-off-by: Nabarun Pal --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index c8a7e1529f..a4fa178bb8 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,7 @@ supported versions of Kubernetes clusters. - [client 10.y.z](https://pypi.org/project/kubernetes/10.1.0/): Kubernetes 1.13 or below (+-), Kubernetes 1.14 (✓), Kubernetes 1.14 or above (+-) - [client 11.y.z](https://pypi.org/project/kubernetes/11.0.0/): Kubernetes 1.14 or below (+-), Kubernetes 1.15 (✓), Kubernetes 1.16 or above (+-) - [client 12.y.z](https://pypi.org/project/kubernetes/12.0.1/): Kubernetes 1.15 or below (+-), Kubernetes 1.16 (✓), Kubernetes 1.17 or above (+-) +- [client 17.y.z](https://pypi.org/project/kubernetes/17.14.0a1/): Kubernetes 1.16 or below (+-), Kubernetes 1.17 (✓), Kubernetes 1.18 or above (+-) Key: From f0dbe3897017ae2cb7e89dde3358816e9aa2a37b Mon Sep 17 00:00:00 2001 From: Nabarun Pal Date: Tue, 17 Nov 2020 03:28:22 +0530 Subject: [PATCH 4/4] Add a note about the change in client versioning schema Signed-off-by: Nabarun Pal --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a4fa178bb8..6b4fcfe7d3 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,8 @@ supported versions of Kubernetes clusters. - [client 12.y.z](https://pypi.org/project/kubernetes/12.0.1/): Kubernetes 1.15 or below (+-), Kubernetes 1.16 (✓), Kubernetes 1.17 or above (+-) - [client 17.y.z](https://pypi.org/project/kubernetes/17.14.0a1/): Kubernetes 1.16 or below (+-), Kubernetes 1.17 (✓), Kubernetes 1.18 or above (+-) +> See [here](#homogenizing-the-kubernetes-python-client-versions) for an explaination of why there is no v13-v16 release. + Key: * `✓` Exactly the same features / API objects in both client-python and the Kubernetes @@ -123,6 +125,8 @@ between client-python versions. | 12.0 | Kubernetes main repo, 1.16 branch | ✓ | | 17.0 Alpha/Beta | Kubernetes main repo, 1.17 branch | ✓ | +> See [here](#homogenizing-the-kubernetes-python-client-versions) for an explaination of why there is no v13-v16 release. + Key: * `✓` Changes in main Kubernetes repo are manually ([should be automated](https://github.com/kubernetes-client/python/issues/177)) published to client-python when they are available. @@ -134,6 +138,12 @@ Note: There would be no maintenance for alpha/beta releases except the latest on **Exception to the above support rule:** Since we are running behind on releases, we will support Alpha/Beta releases for a greater number of clients until we catch up with the upstream version. +## Homogenizing the Kubernetes Python Client versions + +The client releases v12 and before following a versioning schema where the major version was 4 integer positions behind the Kubernetes minor on which the client is based on. For example, v12.0.0 is based on Kubernetes v1.16, v11.0.0 is based on Kubernetes v1.15 and so on. + +This created a lot of confusion tracking two different version numbers for each client release. It was decided to homogenize the version scheme starting from the Kubernetes Python client based on Kubernetes v1.17. The versioning scheme of the client from this release would be vY.Z.P where Y and Z are the Kubernetes minor and patch release numbers from Kubernets v1.Y.Z and P is the client specific patch release numbers to accomodate changes and fixes done specifically to the client. For more details, refer [this issue](https://github.com/kubernetes-client/python/issues/1244). + ## Community, Support, Discussion If you have any problem on using the package or any suggestions, please start with reaching the [Kubernetes clients slack channel](https://kubernetes.slack.com/messages/C76GB48RK/), or filing an [issue](https://github.com/kubernetes-client/python/issues) to let us know. You can also reach the maintainers of this project at [SIG API Machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery), where this project falls under.