Client Version Compatibility
The kubernetes-client/python library implements a versioning scheme that aligns with Kubernetes versions. This document outlines the mapping between client and Kubernetes versions, providing clarity on compatibility and potential limitations.
Compatibility Matrix
| Client version | Kubernetes version | Notes |
|---|---|---|
| 5.0 Alpha/Beta | 1.9 | ✗ No longer maintained; please upgrade. |
| 5.0 | 1.9 | ✗ No longer maintained; please upgrade. |
| 6.0 Alpha/Beta | 1.10 | ✗ No longer maintained; please upgrade. |
| 6.0 | 1.10 | ✗ No longer maintained; please upgrade. |
| 7.0 Alpha/Beta | 1.11 | ✗ No longer maintained; please upgrade. |
| 7.0 | 1.11 | ✗ No longer maintained; please upgrade. |
| 8.0 Alpha/Beta | 1.12 | ✗ No longer maintained; please upgrade. |
| 8.0 | 1.12 | ✗ No longer maintained; please upgrade. |
| 9.0 Alpha/Beta | 1.13 | ✗ No longer maintained; please upgrade. |
| 9.0 | 1.13 | ✗ No longer maintained; please upgrade. |
| 9.y.z | 1.12 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 9.y.z | 1.13 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 9.y.z | 1.14 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 10.0 Alpha/Beta | 1.14 | ✗ No longer maintained; please upgrade. |
| 10.0 | 1.14 | ✗ No longer maintained; please upgrade. |
| 10.y.z | 1.13 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 10.y.z | 1.14 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 10.y.z | 1.14 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 11.0 Alpha/Beta | 1.15 | ✗ No longer maintained; please upgrade. |
| 11.0 | 1.15 | ✗ No longer maintained; please upgrade. |
| 11.y.z | 1.14 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 11.y.z | 1.15 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 11.y.z | 1.16 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 12.0 Alpha/Beta | 1.16 | ✗ No longer maintained; please upgrade. |
| 12.0 | 1.16 | ✗ No longer maintained; please upgrade. |
| 12.y.z | 1.15 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 12.y.z | 1.16 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 12.y.z | 1.17 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 17.0 Alpha/Beta | 1.17 | ✗ No longer maintained; please upgrade. |
| 17.0 | 1.17 | ✗ No longer maintained; please upgrade. |
| 17.y.z | 1.16 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 17.y.z | 1.17 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 17.y.z | 1.18 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 18.0 Alpha/Beta | 1.18 | ✗ No longer maintained; please upgrade. |
| 18.0 | 1.18 | ✗ No longer maintained; please upgrade. |
| 18.y.z | 1.17 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 18.y.z | 1.18 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 18.y.z | 1.19 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 19.0 Alpha/Beta | 1.19 | ✗ No longer maintained; please upgrade. |
| 19.0 | 1.19 | ✗ No longer maintained; please upgrade. |
| 19.y.z | 1.18 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 19.y.z | 1.19 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 19.y.z | 1.20 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 20.0 Alpha/Beta | 1.20 | ✗ No longer maintained; please upgrade. |
| 20.0 | 1.20 | ✗ No longer maintained; please upgrade. |
| 20.y.z | 1.19 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 20.y.z | 1.20 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 20.y.z | 1.21 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 21.0 Alpha/Beta | 1.21 | ✗ No longer maintained; please upgrade. |
| 21.0 | 1.21 | ✗ No longer maintained; please upgrade. |
| 21.y.z | 1.20 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 21.y.z | 1.21 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 21.y.z | 1.22 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 22.0 Alpha/Beta | 1.22 | ✗ No longer maintained; please upgrade. |
| 22.0 | 1.22 | ✗ No longer maintained; please upgrade. |
| 22.y.z | 1.21 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 22.y.z | 1.22 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 22.y.z | 1.23 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 23.0 Alpha/Beta | 1.23 | ✗ No longer maintained; please upgrade. |
| 23.0 | 1.23 | ✗ No longer maintained; please upgrade. |
| 23.y.z | 1.22 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 23.y.z | 1.23 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 23.y.z | 1.24 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 24.0 Alpha/Beta | 1.24 | ✗ No longer maintained; please upgrade. |
| 24.0 | 1.24 | ✗ No longer maintained; please upgrade. |
| 24.y.z | 1.23 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 24.y.z | 1.24 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 24.y.z | 1.25 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 25.0 Alpha/Beta | 1.25 | ✗ No longer maintained; please upgrade. |
| 25.0 | 1.25 | ✗ No longer maintained; please upgrade. |
| 25.y.z | 1.24 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 25.y.z | 1.25 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 25.y.z | 1.26 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 26.0 Alpha/Beta | 1.26 | ✗ No longer maintained; please upgrade. |
| 26.0 | 1.26 | ✗ No longer maintained; please upgrade. |
| 26.y.z | 1.25 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 26.y.z | 1.26 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 26.y.z | 1.27 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 27.0 Alpha/Beta | 1.27 | ✗ No longer maintained; please upgrade. |
| 27.0 | 1.27 | ✗ No longer maintained; please upgrade. |
| 27.y.z | 1.26 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 27.y.z | 1.27 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 27.y.z | 1.28 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 28.0 Alpha/Beta | 1.28 | ✗ No longer maintained; please upgrade. |
| 28.0 | 1.28 | ✗ No longer maintained; please upgrade. |
| 28.y.z | 1.27 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 28.y.z | 1.28 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 28.y.z | 1.29 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 29.0 Alpha/Beta | 1.29 | ✗ No longer maintained; please upgrade. |
| 29.0 | 1.29 | ✓ Changes in main Kubernetes repo are manually (should be automated) published to client-python when they are available. |
| 29.y.z | 1.28 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 29.y.z | 1.29 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 29.y.z | 1.30 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 30.0 Alpha/Beta | 1.30 | ✗ No longer maintained; please upgrade. |
| 30.0 | 1.30 | ✓ Changes in main Kubernetes repo are manually (should be automated) published to client-python when they are available. |
| 30.y.z | 1.29 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 30.y.z | 1.30 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 30.y.z | 1.31 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 31.0 Alpha/Beta | 1.31 | ✗ No longer maintained; please upgrade. |
| 31.0 | 1.31 | ✓ Changes in main Kubernetes repo are manually (should be automated) published to client-python when they are available. |
| 31.y.z | 1.30 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 31.y.z | 1.31 (✓) | ✓ Exactly the same features / API objects in both client-python and the Kubernetes version. |
| 31.y.z | 1.32 or above (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 32.y.z | 1.32 or below (+) | + client-python has features or API objects that may not be present in the Kubernetes cluster. |
| 32.y.z | 1.33 (✓) | ✓ Exactly the same features / API objects in both client |
Top-Level Directory Explanations
doc/ - This directory contains documentation files for the project.
doc/source/ - This directory contains the source files for the documentation.
examples/ - This directory contains example usage of the Kubernetes client library.
examples/dynamic-client/ - This directory contains examples of using the dynamic client to interact with Kubernetes.
kubernetes/ - This directory contains the main Kubernetes client library.
kubernetes/base/ - This directory contains the base Kubernetes client library.
kubernetes/base/config/ - This directory contains configuration files for the base library.
kubernetes/base/dynamic/ - This directory contains the dynamic client implementation for the base library.
kubernetes/base/stream/ - This directory contains the stream implementation for the base library.
kubernetes/client/ - This directory contains the top-level client for the Kubernetes client library.
kubernetes/client/api/ - This directory contains the API definitions for the client library.
kubernetes/client/apis/ - This directory contains the API implementations for the client library.
kubernetes/client/models/ - This directory contains the data models used by the client library.
kubernetes/e2e_test/ - This directory contains end-to-end tests for the Kubernetes client library.
kubernetes/e2e_test/test_yaml/ - This directory contains YAML files used in the end-to-end tests.
scripts/ - This directory contains scripts used in the development and build process.
scripts/util/ - This directory contains utility scripts.
