Skip to content

Commit 1da4d65

Browse files
committed
Add a note about the change in client versioning schema
Signed-off-by: Nabarun Pal <[email protected]>
1 parent 0a122f2 commit 1da4d65

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ supported versions of Kubernetes clusters.
8888
- [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 (+-)
8989
- [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 (+-)
9090

91+
> See [here](#homogenizing-the-kubernetes-python-client-versions) for an explaination of why there is no v13-v16 release.
92+
9193
Key:
9294

9395
* `` Exactly the same features / API objects in both client-python and the Kubernetes
@@ -123,6 +125,8 @@ between client-python versions.
123125
| 12.0 | Kubernetes main repo, 1.16 branch ||
124126
| 17.0 Alpha/Beta | Kubernetes main repo, 1.17 branch ||
125127

128+
> See [here](#homogenizing-the-kubernetes-python-client-versions) for an explaination of why there is no v13-v16 release.
129+
126130
Key:
127131

128132
* `` 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.
@@ -132,6 +136,14 @@ Kubernetes supports [three minor releases](https://github.com/kubernetes/communi
132136

133137
Note: There would be no maintenance for alpha/beta releases except the latest one.
134138

139+
**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.
140+
141+
## Homogenizing the Kubernetes Python Client versions
142+
143+
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.
144+
145+
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).
146+
135147
## Community, Support, Discussion
136148

137149
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.

0 commit comments

Comments
 (0)