Merge pull request #271 from andyxning/update_resource_group_version_compatibility

update resource group version compatibility
This commit is contained in:
Ning Xie 2017-10-11 09:22:42 -05:00 committed by GitHub
commit cc1442ba76
1 changed files with 14 additions and 7 deletions

View File

@ -21,6 +21,7 @@ the raw metrics.
- [Versioning](#versioning) - [Versioning](#versioning)
- [Kubernetes Version](#kubernetes-version) - [Kubernetes Version](#kubernetes-version)
- [Compatibility matrix](#compatibility-matrix) - [Compatibility matrix](#compatibility-matrix)
- [Resource group version compatibility](#resource-group-version-compatibility)
- [Container Image](#container-image) - [Container Image](#container-image)
- [Metrics Documentation](#metrics-documentation) - [Metrics Documentation](#metrics-documentation)
- [Resource recommendation](#resource-recommendation) - [Resource recommendation](#resource-recommendation)
@ -40,20 +41,26 @@ Kubernetes clusters. The supported Kubernetes cluster version is determined by `
The compatibility matrix for client-go and Kubernetes cluster can be found The compatibility matrix for client-go and Kubernetes cluster can be found
[here](https://github.com/kubernetes/client-go#compatibility-matrix). [here](https://github.com/kubernetes/client-go#compatibility-matrix).
All additional compatibility is only best effort, or happens to still/already be supported. All additional compatibility is only best effort, or happens to still/already be supported.
Currently, `client-go` is in version `v4.0.0-beta.0`. Currently, `client-go` is in version `release-5.0`.
#### Compatibility matrix #### Compatibility matrix
At most 5 kube-state-metrics releases will be recorded below.
| kube-state-metrics | client-go | **Kubernetes 1.4** | **Kubernetes 1.5** | **Kubernetes 1.6** | **Kubernetes 1.7** | | kube-state-metrics | client-go | **Kubernetes 1.4** | **Kubernetes 1.5** | **Kubernetes 1.6** | **Kubernetes 1.7** | **Kubernetes 1.8** |
|--------------------|-----------|---------------------|--------------------|--------------------|--------------------| |--------------------|-----------|---------------------|--------------------|--------------------|--------------------|--------------------|
| **v0.4.0** | v2.0.0-alpha.1 | ✓ | ✓ | - | - | | **v0.4.0** | v2.0.0-alpha.1 | ✓ | ✓ | - | - | - |
| **v0.5.0** | v2.0.0-alpha.1 | ✓ | ✓ | - | - | | **v0.5.0** | v2.0.0-alpha.1 | ✓ | ✓ | - | - | - |
| **v1.0.x** | 4.0.0-beta.0 | ✓ | ✓ | ✓ | ✓ | | **v1.0.x** | 4.0.0-beta.0 | ✓ | ✓ | ✓ | ✓ | - |
| **master** | 4.0.0-beta.0 | ✓ | ✓ | ✓ | ✓ | | **master** | release-5.0 | ✓ | ✓ | ✓ | ✓ | ✓ |
- `✓` Fully supported version range. - `✓` Fully supported version range.
- `-` The Kubernetes cluster has features the client-go library can't use (additional API objects, etc). - `-` The Kubernetes cluster has features the client-go library can't use (additional API objects, etc).
#### Resource group version compatibility
Resources in Kubernetes can evolve, i.e., the group version for a resource may change from alpha to beta and finally GA
in different Kubernetes versions. As for now, kube-state-metrics will only use the oldest API available in the latest
release.
#### Container Image #### Container Image
The latest container image can be found at: The latest container image can be found at: