Skip to content

resouer/cri-tools

 
 

Repository files navigation

cri-tools

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

Build Status Go Report Card

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.

Roadmap

  • Basic sandbox/image/container lifecycle operations
  • Handle streaming APIs (exec/attach/port-forwarding)
  • Reading logs of containers.
  • Validation test suites.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

Kubernetes Incubator

This is a Kubernetes Incubator project. The incubator team for the project is:

  • Sponsor: Dawn Chen (@dchen1107)
  • Champion: Yu-Ju Hong (@yujuhong)
  • SIG: sig-node

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

Getting started

Build cri-tools

go get github.com/kubernetes-incubator/cri-tools/cmd/critest
$GOPATH/bin/critest

Flags

--runtime-service-address, -r:The default server is dockershim. If we want to test other CRI server such as frakti, we can add flag --runtime-service-address=/var/run/frakti.sock. And we can run this test against frakti.

--build-dependencies, -b:If we don't need to build dependencies, we can add this flag --build-dependencies=false or -b=false.

About

CRI tools for dev and test

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 55.8%
  • Python 29.5%
  • Shell 12.2%
  • Makefile 2.5%