Skip to content

Commit

Permalink
Add Dependency matrix to README
Browse files Browse the repository at this point in the history
This makes it far more explicit about all the libraries
that are used in conjunction with client-go and which
versions you require for each version of Kubernetes.
  • Loading branch information
markmandel committed Nov 29, 2017
1 parent 72e1c2a commit 1f6b441
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ will give you head and doesn't handle the dependencies well.
- [Compatibility: your code <-> client-go](#compatibility-your-code---client-go)
- [Compatibility: client-go <-> Kubernetes clusters](#compatibility-client-go---kubernetes-clusters)
- [Compatibility matrix](#compatibility-matrix)
- [Dependency matrix](#dependency-matrix)
- [Why do the 1.4 and 1.5 branch contain top-level folder named after the version?](#why-do-the-14-and-15-branch-contain-top-level-folder-named-after-the-version)
- [Kuberentes tags](#kubernetes-tags)
- [How to get it](#how-to-get-it)
Expand Down Expand Up @@ -124,6 +125,20 @@ Key:
* `=` Maintenance is manual, only severe security bugs will be patched.
* `-` Deprecated; please upgrade.

#### Dependency Matrix
Since there are multiple libraries that client-go is either required to, or can work
with, this is a list of all the libraries and versions that work with each other.

| client-go | [apimachinery](https://github.com/kubernetes/apimachinery) | [apiextensions-apiserver](https://github.com/kubernetes/apiextensions-apiserver)<sup>*</sup> | [code-generator](https://github.com/kubernetes/code-generator)<sup>+</sup> |
| ----------------------------------| -----------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|
| tag: v2.0.x / branch: release-2.0 | - | - | - |
| tag: v3.0.x / branch: release-3.0 | branch: release-1.6 | - | - |
| tag: v4.0.x / branch: release-4.0 | branch: release-1.7 | branch: release-1.7 | branch: release-1.7 |
| tag: v5.0.x / branch: release-5.0 | branch: release-1.8 | branch: release-1.8 | branch: release-1.8 |

<sup>*</sup> optional library that exposes the Extensions API, for example, for Custom Resource Definitions.
<sup>+</sup> optional library for generating Kubernetes style API types. Typically used with Custom Resource Definitions.

#### Deprecation policy

We will maintain branches for at least six months after their first stable tag
Expand Down

0 comments on commit 1f6b441

Please sign in to comment.