github/client-go
1
0
Fork 0
mirror of https://github.com/kubernetes/client-go.git synced 2025-06-25 14:41:53 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #721 from nikhita/readme-release-17-update

Browse Source 
Update README for release 1.17
This commit is contained in:
Kubernetes Prow Robot 2019-12-11 06:56:06 -08:00 committed by GitHub
commit ba02bb8cc0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
README.md
View File

@ -2,7 +2,8 @@
Go clients for talking to a [kubernetes](http://kubernetes.io/) cluster. Go clients for talking to a [kubernetes](http://kubernetes.io/) cluster.
We recommend using the `kubernetes-1.x.y` tag matching the current Kubernetes release (`kubernetes-1.15.3` at the time this was written). We recommend using the `v0.x.y` tags for Kubernetes releases >= `v1.17.0` and
`kubernetes-1.x.y` tags for Kubernetes releases < `v1.17.0`.
See [INSTALL.md](/INSTALL.md) for detailed installation instructions. See [INSTALL.md](/INSTALL.md) for detailed installation instructions.
`go get k8s.io/client-go@master` works, but will fetch `master`, which may be less stable than a tagged release. `go get k8s.io/client-go@master` works, but will fetch `master`, which may be less stable than a tagged release.
@ -44,42 +45,31 @@ See [INSTALL.md](/INSTALL.md) for detailed installation instructions.
### Versioning ### Versioning
`client-go` follows [semver](http://semver.org/). We will not make - For each `v1.x.y` Kubernetes release, the major version (first digit)
backwards-incompatible changes without incrementing the major version number. A would remain `0`.
change is backwards-incompatible either if it *i)* changes the public interfaces
of `client-go`, or *ii)* makes `client-go` incompatible with otherwise supported
versions of Kubernetes clusters.
Changes that add features in a backwards-compatible way will result in bumping - Bugfixes will result in the patch version (third digit) changing. PRs that are
the minor version (second digit) number.
Bugfixes will result in the patch version (third digit) changing. PRs that are
cherry-picked into an older Kubernetes release branch will result in an update cherry-picked into an older Kubernetes release branch will result in an update
to the corresponding branch in `client-go`, with a corresponding new tag to the corresponding branch in `client-go`, with a corresponding new tag
changing the patch version. changing the patch version.
A consequence of this is that `client-go` version numbers will be unrelated to
Kubernetes version numbers.
#### Branches and tags. #### Branches and tags.
We will create a new branch and tag for each increment in the major version number or We will create a new branch and tag for each increment in the minor version
minor version number. We will create only a new tag for each increment in the patch number. We will create only a new tag for each increment in the patch
version number. See [semver](http://semver.org/) for definitions of major, version number. See [semver](http://semver.org/) for definitions of major,
minor, and patch. minor, and patch.
The master branch will track HEAD in the main Kubernetes repo and The HEAD of the master branch in client-go will track the HEAD of the master
accumulate changes. Consider HEAD to have the version `x.(y+1).0-alpha` or branch in the main Kubernetes repo.
`(x+1).0.0-alpha` (depending on whether it has accumulated a breaking change or
not), where `x` and `y` are the current major and minor versions.
#### Compatibility: your code <-> client-go #### Compatibility: your code <-> client-go
`client-go` follows [semver](http://semver.org/), so until the major version of The `v0.x.y` tags indicate that go APIs may change in incompatible ways in
client-go gets increased, your code will compile and will continue to work with different versions.
explicitly supported versions of Kubernetes clusters. You must use a dependency
management system and pin a specific major version of `client-go` to get this See [INSTALL.md](INSTALL.md) for guidelines on requiring a specific
benefit, as HEAD follows the upstream Kubernetes repo. version of client-go.
#### Compatibility: client-go <-> Kubernetes clusters #### Compatibility: client-go <-> Kubernetes clusters
@ -92,16 +82,12 @@ We will backport bugfixes--but not new features--into older versions of
#### Compatibility matrix #### Compatibility matrix
| | Kubernetes 1.9 | Kubernetes 1.10 | Kubernetes 1.11 | Kubernetes 1.12 | Kubernetes 1.13 | Kubernetes 1.14 | Kubernetes 1.15 | | | Kubernetes 1.15 | Kubernetes 1.16 | Kubernetes 1.17 |
|---------------------|----------------|-----------------|-----------------|-----------------|-----------------|-----------------|-----------------| |-------------------------------|-----------------|-----------------|-----------------|
| client-go 6.0 | ✓ | +- | +- | +- | +- | +- | +- | | `kubernetes-1.15.0` | ✓ | +- | +- |
| client-go 7.0 | +- | ✓ | +- | +- | +- | +- | +- | | `kubernetes-1.16.0` | +- | ✓ | +- |
| client-go 8.0 | +- | +- | ✓ | +- | +- | +- | +- | | `kubernetes-1.17.0`/`v0.17.0` | +- | +- | ✓ |
| client-go 9.0 | +- | +- | +- | ✓ | +- | +- | +- | | `HEAD` | +- | +- | +- |
| client-go 10.0 | +- | +- | +- | +- | ✓ | +- | +- |
| client-go 11.0 | +- | +- | +- | +- | +- | ✓ | +- |
| client-go 12.0 | +- | +- | +- | +- | +- | +- | ✓ |
| client-go HEAD | +- | +- | +- | +- | +- | +- | +- |
Key: Key:
@ -122,19 +108,21 @@ between client-go versions.
| Branch | Canonical source code location | Maintenance status | | Branch | Canonical source code location | Maintenance status |
|----------------|--------------------------------------|-------------------------------| |----------------|--------------------------------------|-------------------------------|
| client-go 1.4 | Kubernetes main repo, 1.4 branch | = - | | `release-1.4` | Kubernetes main repo, 1.4 branch | = - |
| client-go 1.5 | Kubernetes main repo, 1.5 branch | = - | | `release-1.5` | Kubernetes main repo, 1.5 branch | = - |
| client-go 2.0 | Kubernetes main repo, 1.5 branch | = - | | `release-2.0` | Kubernetes main repo, 1.5 branch | = - |
| client-go 3.0 | Kubernetes main repo, 1.6 branch | = - | | `release-3.0` | Kubernetes main repo, 1.6 branch | = - |
| client-go 4.0 | Kubernetes main repo, 1.7 branch | = - | | `release-4.0` | Kubernetes main repo, 1.7 branch | = - |
| client-go 5.0 | Kubernetes main repo, 1.8 branch | = - | | `release-5.0` | Kubernetes main repo, 1.8 branch | = - |
| client-go 6.0 | Kubernetes main repo, 1.9 branch | = - | | `release-6.0` | Kubernetes main repo, 1.9 branch | = - |
| client-go 7.0 | Kubernetes main repo, 1.10 branch | = - | | `release-7.0` | Kubernetes main repo, 1.10 branch | = - |
| client-go 8.0 | Kubernetes main repo, 1.11 branch | =- | | `release-8.0` | Kubernetes main repo, 1.11 branch | =- |
| client-go 9.0 | Kubernetes main repo, 1.12 branch | =- | | `release-9.0` | Kubernetes main repo, 1.12 branch | =- |
| client-go 10.0 | Kubernetes main repo, 1.13 branch | ✓ | | `release-10.0` | Kubernetes main repo, 1.13 branch | =- |
| client-go 11.0 | Kubernetes main repo, 1.14 branch | ✓ | | `release-11.0` | Kubernetes main repo, 1.14 branch | ✓ |
| client-go 12.0 | Kubernetes main repo, 1.15 branch | ✓ | | `release-12.0` | Kubernetes main repo, 1.15 branch | ✓ |
| `release-13.0` | Kubernetes main repo, 1.16 branch | ✓ |
| `release-14.0` | Kubernetes main repo, 1.17 branch | ✓ |
| client-go HEAD | Kubernetes main repo, master branch | ✓ | | client-go HEAD | Kubernetes main repo, master branch | ✓ |
Key: Key:
@ -161,14 +149,19 @@ existing users won't be broken.
This repository is still a mirror of This repository is still a mirror of
[k8s.io/kubernetes/staging/src/client-go](https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/client-go), [k8s.io/kubernetes/staging/src/client-go](https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/client-go),
the code development is still done in the staging area. Since Kubernetes 1.8 the code development is still done in the staging area.
release, when syncing the code from the staging area, we also sync the Kubernetes
version tags to client-go, prefixed with "kubernetes-". For example, if you check Since Kubernetes `v1.8.0`, when syncing the code from the staging area,
out the `kubernetes-1.15.3` tag in client-go, the code you get is exactly the we also sync the Kubernetes version tags to client-go, prefixed with
same as if you check out the `v1.15.3` tag in Kubernetes, and change directory to `kubernetes-`. From Kubernetes `v1.17.0`, we also create matching semver
`staging/src/k8s.io/client-go`. The purpose is to let users quickly find matching `v0.x.y` tags for each `v1.x.y` Kubernetes release.
commits among published repos, like
[sample-apiserver](https://github.com/kubernetes/sample-apiserver), For example, if you check out the `kubernetes-1.17.0` or the `v0.17.0` tag in
client-go, the code you get is exactly the same as if you check out the `v1.17.0`
tag in Kubernetes, and change directory to `staging/src/k8s.io/client-go`.
The purpose is to let users quickly find matching commits among published repos,
like [sample-apiserver](https://github.com/kubernetes/sample-apiserver),
[apiextension-apiserver](https://github.com/kubernetes/apiextensions-apiserver), [apiextension-apiserver](https://github.com/kubernetes/apiextensions-apiserver),
etc. The Kubernetes version tag does NOT claim any backwards compatibility etc. The Kubernetes version tag does NOT claim any backwards compatibility
guarantees for client-go. Please check the [semantic versions](#versioning) if guarantees for client-go. Please check the [semantic versions](#versioning) if
@ -179,7 +172,7 @@ you care about backwards compatibility.
Use go1.11+ and fetch the desired version using the `go get` command. For example: Use go1.11+ and fetch the desired version using the `go get` command. For example:
``` ```
go get k8s.io/client-go@kubernetes-1.15.3 go get k8s.io/client-go@v0.17.0
``` ```
See [INSTALL.md](/INSTALL.md) for detailed instructions. See [INSTALL.md](/INSTALL.md) for detailed instructions.