X Tutup
Skip to content

Commit ca292da

Browse files
jsjjsj
committed
Requested Changes
* Consolidating and improving language Signed-off-by: James Jackson <james.sorley.jackson@gmail.com>
1 parent 09241fd commit ca292da

File tree

1 file changed

+24
-37
lines changed

1 file changed

+24
-37
lines changed

‎README.md‎

Lines changed: 24 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -251,50 +251,37 @@ $ source ./contrib/autocomplete/ctr
251251

252252
### CRI
253253

254-
`cri` is a [containerd](https://containerd.io/) plugin implementation of Kubernetes [container runtime interface (CRI)](https://github.com/kubernetes/cri-api/blob/master/pkg/apis/runtime/v1alpha2/api.proto).
254+
`cri` is a [containerd](https://containerd.io/) plugin implementation of the Kubernetes [container runtime interface (CRI)](https://github.com/kubernetes/cri-api/blob/master/pkg/apis/runtime/v1alpha2/api.proto). With it, you are able to use containerd as the container runtime for a Kubernetes cluster.
255255

256-
With it, you could run Kubernetes using containerd as the container runtime.
257256
![cri](./docs/cri.png)
258257

259-
#### Current Status
258+
#### CRI Status
260259

261-
`cri` is a native plugin of containerd 1.1 and above. It is built into containerd and enabled by default.
260+
`cri` is a native plugin of containerd. Since containerd 1.1, the cri plugin is built into the release binaries and enabled by default.
262261

263-
> **Note:** `cri` as of containerd 1.5, the cri plugin is merged into the containerd/containerd repo. For example, the source code previously stored under [`containerd/cri/pkg`](https://github.com/containerd/cri/tree/release/1.4/pkg)
262+
> **Note:** As of containerd 1.5, the `cri` plugin is merged into the containerd/containerd repo. For example, the source code previously stored under [`containerd/cri/pkg`](https://github.com/containerd/cri/tree/release/1.4/pkg)
264263
was moved to [`containerd/containerd/pkg/cri` package](https://github.com/containerd/containerd/tree/master/pkg/cri).
265264

266-
`cri` is in GA:
267-
* It is feature complete.
268-
* It (the GA version) works with Kubernetes 1.10 and above.
269-
* It has passed all [CRI validation tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md).
270-
* It has passed all [node e2e tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/e2e-node-tests.md).
271-
* It has passed all [e2e tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-testing/e2e-tests.md).
272-
273-
See [test dashboard](https://k8s-testgrid.appspot.com/sig-node-containerd)
274-
275-
#### Production Quality Cluster on GCE
276-
For a production quality cluster on GCE brought up with `kube-up.sh` refer [here](docs/cri/kube-up.md).
277-
#### Installing with Ansible and Kubeadm
278-
For a multi node cluster installer and bring up steps using ansible and kubeadm refer [here](contrib/ansible/README.md).
279-
#### Custom Installation
280-
For non ansible users, you can download the `cri-containerd` release tarball and deploy
281-
kubernetes cluster using kubeadm as described [here](docs/installation.md).
282-
283-
#### Validate Your `cri` Setup
284-
A Kubernetes incubator project called [cri-tools](https://github.com/kubernetes-sigs/cri-tools)
285-
includes programs for exercising CRI implementations such as the `cri` plugin.
286-
More importantly, cri-tools includes the program `critest` which is used for running
287-
[CRI Validation Testing](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md).
288-
289-
#### CRI Plugin Testing Guide
290-
See [here](./docs/cri/testing.md) for information about CRI plugin testing.
291-
#### Using crictl
292-
See [here](./docs/cri/crictl.md) for information about using `crictl` to debug
293-
pods, containers, and images.
294-
#### Configurations
295-
See [here](./docs/cri/config.md) for information about how to configure cri plugins
296-
and [here](https://github.com/containerd/containerd/blob/master/docs/man/containerd-config.8.md)
297-
for information about how to configure containerd
265+
The `cri` plugin has reached GA status, representing that it is:
266+
* Feature complete
267+
* Works with Kubernetes 1.10 and above
268+
* Passes all [CRI validation tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md).
269+
* Passes all [node e2e tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/e2e-node-tests.md).
270+
* Passes all [e2e tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-testing/e2e-tests.md).
271+
272+
See results on the containerd k8s [test dashboard](https://k8s-testgrid.appspot.com/sig-node-containerd)
273+
274+
#### Validating Your `cri` Setup
275+
A Kubernetes incubator project, [cri-tools](https://github.com/kubernetes-sigs/cri-tools), includes programs for exercising CRI implementations. More importantly, cri-tools includes the program `critest` which is used for running [CRI Validation Testing](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-node/cri-validation.md).
276+
277+
#### CRI Guides
278+
* [Bringing up a Production Quality Cluster on GCE](docs/cri/kube-up.md)
279+
* [Installing with Ansible and Kubeadm](contrib/ansible/README.md)
280+
* [For Non-Ansible Users, Preforming a Custom Installation Using the Release Tarball and Kubeadm](docs/installation.md)
281+
* [CRI Plugin Testing Guide](./docs/cri/testing.md)
282+
* [Debugging Pods, Containers, and Images with `crictl`](./docs/cri/crictl.md)
283+
* [Configuring `cri` Plugins](./docs/cri/config.md)
284+
* [Configuring containerd](https://github.com/containerd/containerd/blob/master/docs/man/containerd-config.8.md)
298285

299286
#### Distribution of `ctr` autocomplete for bash and zsh
300287

0 commit comments

Comments
 (0)
X Tutup