Update the sig-node/cri documentation

Its been a little bit of time since this documentation was updated, so
refresh the links and also hopefully improve clarity.
This commit is contained in:
mattjmcnaughton 2019-05-05 15:30:37 -04:00
parent 5b12936b6a
commit 62d66fc19f
No known key found for this signature in database
GPG Key ID: BC530981A9A1CC9D
1 changed files with 12 additions and 12 deletions

View File

@ -3,10 +3,12 @@
## What is CRI? ## What is CRI?
CRI (_Container Runtime Interface_) consists of a CRI (_Container Runtime Interface_) consists of a
[protobuf API](https://git.k8s.io/kubernetes/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto),
specifications/requirements (to-be-added), specifications/requirements (to-be-added),
[protobuf API](https://git.k8s.io/kubernetes/staging/src/k8s.io/cri-api/pkg/apis/runtime/v1alpha2/api.proto),
and [libraries](https://git.k8s.io/kubernetes/pkg/kubelet/server/streaming) and [libraries](https://git.k8s.io/kubernetes/pkg/kubelet/server/streaming)
for container runtimes to integrate with kubelet on a node. CRI is currently in Alpha. for container runtimes to integrate with kubelet on a node. The CRI API is
currently in Alpha, and the CRI-Docker integration is used by default as of
Kubernetes 1.7+.
In the future, we plan to add more developer tools such as the CRI validation In the future, we plan to add more developer tools such as the CRI validation
tests. tests.
@ -26,14 +28,7 @@ pluggable container runtimes and build a healthier ecosystem.
## How to use CRI? ## How to use CRI?
For Kubernetes 1.6+: See the [CRI installation documentation](https://kubernetes.io/docs/setup/cri/).
1. Start the image and runtime services on your node. You can have a single
service acting as both image and runtime services.
2. Set the kubelet flags
- Pass the unix socket(s) to which your services listen to kubelet:
`--container-runtime-endpoint` and `--image-service-endpoint`.
- Use the "remote" runtime by `--container-runtime=remote`.
CRI is still young and we are actively incorporating feedback from developers CRI is still young and we are actively incorporating feedback from developers
to improve the API. Although we strive to maintain backward compatibility, to improve the API. Although we strive to maintain backward compatibility,
@ -54,7 +49,6 @@ The old, pre-CRI Docker integration was removed in 1.7.
The Kubernetes 1.5 [blog post on CRI](https://kubernetes.io/blog/2016/12/container-runtime-interface-cri-in-kubernetes/) The Kubernetes 1.5 [blog post on CRI](https://kubernetes.io/blog/2016/12/container-runtime-interface-cri-in-kubernetes/)
serves as a general introduction. serves as a general introduction.
Below is a mixed list of CRI specifications/requirements, design docs and Below is a mixed list of CRI specifications/requirements, design docs and
proposals. We are working on adding more documentation for the API. proposals. We are working on adding more documentation for the API.
@ -74,7 +68,7 @@ proposals. We are working on adding more documentation for the API.
## [Status update](#status-update) ## [Status update](#status-update)
### Kubernetes v1.7 release (Docker-CRI integration GA, container metrics API) ### Kubernetes v1.7 release (Docker-CRI integration GA, container metrics API)
- The Docker CRI integration has been promoted to GA. - The Docker CRI integration has been promoted to GA.
- The legacy, non-CRI Docker integration has been completely removed from - The legacy, non-CRI Docker integration has been completely removed from
Kubelet. The deprecated `--enable-cri` flag has been removed. Kubelet. The deprecated `--enable-cri` flag has been removed.
- CRI has been extended to support collecting container metrics from the - CRI has been extended to support collecting container metrics from the
@ -104,6 +98,9 @@ default in Kubelet**.
#### [CRI known issues](#cri-1.5-known-issues): #### [CRI known issues](#cri-1.5-known-issues):
Note, these are known issues as of the 1.5 release. They may or may not have
been fixed since.
- [#27097](https://github.com/kubernetes/kubernetes/issues/27097): Container - [#27097](https://github.com/kubernetes/kubernetes/issues/27097): Container
metrics are not yet defined in CRI. metrics are not yet defined in CRI.
- [#36401](https://github.com/kubernetes/kubernetes/issues/36401): The new - [#36401](https://github.com/kubernetes/kubernetes/issues/36401): The new
@ -118,6 +115,9 @@ default in Kubelet**.
#### [Docker CRI integration known issues](#docker-cri-1.5-known-issues) #### [Docker CRI integration known issues](#docker-cri-1.5-known-issues)
Note, these are known issues as of the 1.5 release. They may or may not have
been fixed since.
- Docker compatibility: Support only Docker v1.11 and v1.12. - Docker compatibility: Support only Docker v1.11 and v1.12.
- Network: - Network:
- [#35457](https://github.com/kubernetes/kubernetes/issues/35457): Does - [#35457](https://github.com/kubernetes/kubernetes/issues/35457): Does