Skip to content

Commit b28854e

Browse files
authored
Merge pull request #3988 from saschagrunert/cri-tools-readme
Update cri-tools README.md
2 parents 53deb58 + 0aeaa41 commit b28854e

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

cmd/krel/templates/latest/cri-tools/README.md

+26-16
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
CLI and validation tools for Kubelet Container Runtime Interface (CRI) .
44

5-
[![Build Status](https://travis-ci.org/kubernetes-sigs/cri-tools.svg?branch=master)](https://travis-ci.org/kubernetes-sigs/cri-tools)
5+
[![Build Status](https://github.com/kubernetes-sigs/cri-tools/workflows/build/badge.svg)](https://github.com/kubernetes-sigs/cri-tools/actions/workflows/build.yml)
6+
[![e2e](https://github.com/kubernetes-sigs/cri-tools/workflows/cri-tools%20e2e%20test/badge.svg)](https://github.com/kubernetes-sigs/cri-tools/actions/workflows/e2e.yml)
7+
[![critest containerd](https://github.com/kubernetes-sigs/cri-tools/workflows/critest%20containerd/badge.svg)](https://github.com/kubernetes-sigs/cri-tools/actions/workflows/containerd.yml)
8+
[![critest CRI-O](https://github.com/kubernetes-sigs/cri-tools/workflows/critest%20CRI-O/badge.svg)](https://github.com/kubernetes-sigs/cri-tools/actions/workflows/crio.yml)
69
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes-sigs/cri-tools)](https://goreportcard.com/report/github.com/kubernetes-sigs/cri-tools)
710

811
## What is the scope of this project?
@@ -17,13 +20,12 @@ cri-tools aims to provide a series of debugging and validation tools for Kubelet
1720
- Building a new kubelet container runtime based on CRI.
1821
- Managing pods/containers for CRI-compatible runtimes by end-users, e.g. pods created by crictl may be removed automatically by kubelet because of non-exist on the kube-apiserver.
1922

20-
## Current Status
21-
22-
Version matrix:
23+
## Compatibility matrix: cri-tools ⬄ Kubernetes
2324

2425
| Kubernetes Version | cri-tools Version | cri-tools branch |
2526
| ------------------ | ----------------- | ---------------- |
26-
| ≥ 1.16.x | ≥ 1.16.x | master |
27+
| ≥ 1.27.x | ≥ 1.27.x | master |
28+
| ≥ 1.16.x ≤ 1.26.x | ≥ 1.16.x ≤ 1.26.x | master |
2729
| 1.15.X | v1.15.0 | release-1.15 |
2830
| 1.14.X | v1.14.0 | release-1.14 |
2931
| 1.13.X | v1.13.0 | release-1.13 |
@@ -34,14 +36,30 @@ Version matrix:
3436
| 1.8.X | v0.2 | release-1.8 |
3537
| 1.7.X | v0.1 | release-1.7 |
3638

37-
See the [roadmap](docs/roadmap.md) for information about current and future milestones.
39+
It's recommended to use the same cri-tools and Kubernetes minor version, because
40+
new features added to the Container Runtime Interface (CRI) may not be fully
41+
supported if they diverge.
42+
43+
cri-tools follows the Kubernetes release cycles with respect to its minor
44+
versions (`1.x.y`). Patch releases (`1.x.z`) for Kubernetes are not in sync with
45+
those from cri-tools, because they are scheduled for each month, whereas
46+
cri-tools provides them only if necessary. If a Kubernetes release goes [End of
47+
Life](https://kubernetes.io/releases/patch-releases/), then the corresponding
48+
cri-tools version can be considered in the same way.
49+
50+
All new minor versions of cri-tools are being created from the `master` branch,
51+
whereas corresponding `release-1.x` branches will be created if a patch release
52+
is planned.
53+
54+
See the [roadmap](docs/roadmap.md) for information about current and future
55+
milestones.
3856

3957
## Install
4058

4159
### Install crictl
4260

4361
```sh
44-
VERSION="v1.25.0"
62+
VERSION="v1.32.0"
4563
wget https://github.com/kubernetes-sigs/cri-tools/releases/download/$VERSION/crictl-$VERSION-linux-amd64.tar.gz
4664
sudo tar zxvf crictl-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
4765
rm -f crictl-$VERSION-linux-amd64.tar.gz
@@ -50,7 +68,7 @@ rm -f crictl-$VERSION-linux-amd64.tar.gz
5068
### Install critest
5169

5270
```sh
53-
VERSION="v1.25.0"
71+
VERSION="v1.32.0"
5472
wget https://github.com/kubernetes-sigs/cri-tools/releases/download/$VERSION/critest-$VERSION-linux-amd64.tar.gz
5573
sudo tar zxvf critest-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
5674
rm -f critest-$VERSION-linux-amd64.tar.gz
@@ -76,14 +94,6 @@ You can reach the maintainers of this project at:
7694
- Slack: #sig-node
7795
- Mailing List: <https://groups.google.com/forum/#!forum/kubernetes-sig-node>
7896

79-
## Kubernetes Incubator
80-
81-
This is a [Kubernetes Incubator project](https://github.com/kubernetes/community/blob/master/archive/incubator.md). The incubator team for the project is:
82-
83-
- Sponsor: Dawn Chen (@dchen1107)
84-
- Champion: Yu-Ju Hong (@yujuhong)
85-
- SIG: sig-node
86-
8797
## Contributing
8898

8999
Interested in contributing? Check out the [documentation](CONTRIBUTING.md).

0 commit comments

Comments
 (0)