Skip to content

Commit 8407235

Browse files
committed
Add compatibility section to README.md
1 parent 84bf6cc commit 8407235

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,43 @@ python -m examples.example1
7575

7676
All APIs and Models' documentation can be found at the [Generated client's README file](kubernetes/README.md)
7777

78+
## Compatibility
79+
80+
`client-python` follows [semver](http://semver.org/), so until the major version of
81+
client-python gets increased, your code will continue to work with explicitly
82+
supported versions of Kubernetes clusters.
83+
84+
#### Compatibility matrix
85+
86+
| | Kubernetes 1.3 | Kubernetes 1.4 | Kubernetes 1.5 | Kubernetes 1.6 |
87+
|-------------------------|----------------|----------------|----------------|----------------|
88+
| client-python 1.0 | + | + || - |
89+
| client-python 2.0 alpha | + | + | + ||
90+
| client-python HEAD | + | + | + | + |
91+
92+
Key:
93+
94+
* `` Exactly the same features / API objects in both client-python and the Kubernetes
95+
version.
96+
* `+` client-python has features or api objects that may not be present in the
97+
Kubernetes cluster, but everything they have in common will work.
98+
* `-` The Kubernetes cluster has features the client-python library can't use
99+
(additional API objects, etc).
100+
101+
See the [CHANGELOG](./CHANGELOG.md) for a detailed description of changes
102+
between client-python versions.
103+
104+
| Client version | Canonical source for OpenAPI spec | Maintenance status |
105+
|----------------|--------------------------------------|-------------------------------|
106+
| 1.0 Alpha/Beta | Kubernetes main repo, 1.5 branch ||
107+
| 1.0.x | Kubernetes main repo, 1.5 branch ||
108+
| 2.0 alpha | Kubernetes main repo, 1.6 branch ||
109+
110+
Key:
111+
112+
* `` Changes in main Kubernetes repo are manually ([should be automated](https://github.com/kubernetes-incubator/client-python/issues/177)) published to client-python when they are available.
113+
* `` No longer maintained; please upgrade.
114+
78115
## Community, Support, Discussion
79116

80117
You can reach the maintainers of this project at [SIG API Machinery](https://github.com/kubernetes/community/tree/master/sig-api-machinery). If you have any problem with the package or any suggestions, please file an [issue](https://github.com/kubernetes-incubator/client-python/issues).

0 commit comments

Comments
 (0)