Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kubernetes-sigs/cri-tools
CLI and validation tools for Kubelet Container Runtime Interface (CRI) .
https://github.com/kubernetes-sigs/cri-tools
containers k8s-sig-node kubelet-cri kubernetes
Last synced: 2 months ago
JSON representation
CLI and validation tools for Kubelet Container Runtime Interface (CRI) .
- Host: GitHub
- URL: https://github.com/kubernetes-sigs/cri-tools
- Owner: kubernetes-sigs
- License: apache-2.0
- Created: 2017-01-27T01:22:52.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T02:35:53.000Z (3 months ago)
- Last Synced: 2024-10-25T05:18:32.808Z (3 months ago)
- Topics: containers, k8s-sig-node, kubelet-cri, kubernetes
- Language: Go
- Homepage:
- Size: 33.4 MB
- Stars: 1,665
- Watchers: 38
- Forks: 452
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
- Security: SECURITY_CONTACTS
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
- awesome-repositories - kubernetes-sigs/cri-tools - CLI and validation tools for Kubelet Container Runtime Interface (CRI) . (Go)
README
# cri-tools
CLI and validation tools for Kubelet Container Runtime Interface (CRI) .
[](https://github.com/kubernetes-sigs/cri-tools/actions/workflows/build.yml)
[](https://github.com/kubernetes-sigs/cri-tools/actions/workflows/e2e.yml)
[](https://github.com/kubernetes-sigs/cri-tools/actions/workflows/containerd.yml)
[](https://github.com/kubernetes-sigs/cri-tools/actions/workflows/crio.yml)
[](https://goreportcard.com/report/github.com/kubernetes-sigs/cri-tools)
## What is the scope of this project?
cri-tools aims to provide a series of debugging and validation tools for Kubelet CRI, which includes:
- crictl: CLI for kubelet CRI.
- critest: validation test suites for kubelet CRI.
## What is not in scope for this project?
- Building a new kubelet container runtime based on CRI.
- 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.
## Compatibility matrix: cri-tools ⬄ Kubernetes
| Kubernetes Version | cri-tools Version | cri-tools branch |
| ------------------ | ----------------- | ---------------- |
| ≥ 1.27.x | ≥ 1.27.x | master |
| ≥ 1.16.x ≤ 1.26.x | ≥ 1.16.x ≤ 1.26.x | master |
| 1.15.X | v1.15.0 | release-1.15 |
| 1.14.X | v1.14.0 | release-1.14 |
| 1.13.X | v1.13.0 | release-1.13 |
| 1.12.X | v1.12.0 | release-1.12 |
| 1.11.X | v1.11.1 | release-1.11 |
| 1.10.X | v1.0.0-beta.2 | release-1.10 |
| 1.9.X | v1.0.0-alpha.1 | release-1.9 |
| 1.8.X | v0.2 | release-1.8 |
| 1.7.X | v0.1 | release-1.7 |
It's recommended to use the same cri-tools and Kubernetes minor version, because
new features added to the Container Runtime Interface (CRI) may not be fully
supported if they diverge.
cri-tools follows the Kubernetes release cycles with respect to its minor
versions (`1.x.y`). Patch releases (`1.x.z`) for Kubernetes are not in sync with
those from cri-tools, because they are scheduled for each month, whereas
cri-tools provides them only if necessary. If a Kubernetes release goes [End of
Life](https://kubernetes.io/releases/patch-releases/), then the corresponding
cri-tools version can be considered in the same way.
All new minor versions of cri-tools are being created from the `master` branch,
whereas corresponding `release-1.x` branches will be created if a patch release
is planned.
See the [roadmap](docs/roadmap.md) for information about current and future
milestones.
## Install
### Install crictl
```sh
VERSION="v1.31.1"
wget https://github.com/kubernetes-sigs/cri-tools/releases/download/$VERSION/crictl-$VERSION-linux-amd64.tar.gz
sudo tar zxvf crictl-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
rm -f crictl-$VERSION-linux-amd64.tar.gz
```
### Install critest
```sh
VERSION="v1.31.1"
wget https://github.com/kubernetes-sigs/cri-tools/releases/download/$VERSION/critest-$VERSION-linux-amd64.tar.gz
sudo tar zxvf critest-$VERSION-linux-amd64.tar.gz -C /usr/local/bin
rm -f critest-$VERSION-linux-amd64.tar.gz
```
### deb/rpm packages
Packages for various distributions using deb's and rpm's are available in the
[OBS repository](https://build.opensuse.org/package/show/devel:kubic:libcontainers:stable/cri-tools).
## Documentation
- **[CRI `crictl` CLI](docs/crictl.md)**
- [CRI validation test suite](docs/validation.md)
- [CRI performance benchmarking](docs/benchmark.md)
## Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
You can reach the maintainers of this project at:
- Slack: #sig-node
- Mailing List:
## Contributing
Interested in contributing? Check out the [documentation](CONTRIBUTING.md).
## Code of conduct
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).