mirror of
https://github.com/k3s-io/k3s.git
synced 2024-06-07 19:41:36 +00:00
86 lines
3.0 KiB
Markdown
86 lines
3.0 KiB
Markdown
|
# cri-tools
|
||
|
|
|
||
|
|
CLI and validation tools for Kubelet Container Runtime Interface (CRI) .
|
||
|
|
|
||
|
|
[](https://travis-ci.org/kubernetes-sigs/cri-tools)
|
||
|
|
[](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.
|
||
|
|
|
||
|
|
## Current Status
|
||
|
|
|
||
|
|
Version matrix:
|
||
|
|
|
||
|
|
| Kubernetes Version | cri-tools Version | cri-tools branch |
|
||
|
|
|--------------------|-------------------|------------------|
|
||
|
|
| 1.13.X | v1.13.0 | master |
|
||
|
|
| 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 |
|
||
|
|
|
||
|
|
See the [roadmap](docs/roadmap.md) for information about current and future milestones.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
### Install crictl
|
||
|
|
|
||
|
|
```sh
|
||
|
|
VERSION="v1.13.0"
|
||
|
|
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.13.0"
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
- [CRI validation test suite](docs/validation.md)
|
||
|
|
- [CRI performance benchmarking](docs/benchmark.md)
|
||
|
|
- [CRI CLI](docs/crictl.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: <https://groups.google.com/forum/#!forum/kubernetes-sig-node>
|
||
|
|
|
||
|
|
## Kubernetes Incubator
|
||
|
|
|
||
|
|
This is a [Kubernetes Incubator project](https://github.com/kubernetes/community/blob/master/incubator.md). The incubator team for the project is:
|
||
|
|
|
||
|
|
- Sponsor: Dawn Chen (@dchen1107)
|
||
|
|
- Champion: Yu-Ju Hong (@yujuhong)
|
||
|
|
- SIG: sig-node
|
||
|
|
|
||
|
|
## 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).
|