You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Antonio Murdaca 54e76afc03
Merge pull request #1281 from wking/gofmt-show-diff
5 years ago
.github *: add .github 5 years ago
.tool lint: Exit and give instructions when linter missing 5 years ago
client client: Add crio client package 5 years ago
cmd/crio fix log 5 years ago
conmon Improve error messages on missing runtime 5 years ago
contrib contrib: test: add node-e2e job 5 years ago
docs docs: Remove the unused play.png 5 years ago
hack Makefile: Use 'git diff' to show gofmt changes 5 years ago
lib Allow additional arguments to be passed into hooks 5 years ago
logo Adding cri-o logo artwork 6 years ago
oci lib,oci: drop stateLock when possible 5 years ago
pause Makefile: output binaries under bin/ 5 years ago
pkg Handle truncated IDs in imageService.ResolveNames() 5 years ago
server Merge pull request #1255 from runcom/panics-grpc-getters 5 years ago
test test/namespaces: Factor out pid_namespace_test helper 5 years ago
types Return image references from the storage package 5 years ago
utils utils: Fix close conn after starting scope 5 years ago
vendor Allow additional arguments to be passed into hooks 5 years ago
version version: bump v1.9.0-dev 5 years ago
.gitignore Add tests for server/config.go 5 years ago
.mailmap .mailmap: Add entries for inconsistent users 5 years ago
.travis.yml drop crioctl source code 5 years ago Copy from skopeo 5 years ago
Dockerfile Add bsdmainutils tool to Dockerfile to enable integration test on arm64 5 years ago
LICENSE Initial commit 6 years ago
Makefile Makefile: Use 'git diff' to show gofmt changes 5 years ago
OWNERS Rename OWNERS assignees: to approvers: 5 years ago Add 1.9 release to compatibility table 5 years ago Update 5 years ago
crictl.yaml drop crioctl source code 5 years ago
crio-umount.conf Tell oci-umount where to remove mountpoints inside container 5 years ago Allow additional arguments to be passed into hooks 5 years ago kubernetes: Simplify and freshen the required-files table 5 years ago
seccomp.json Update to latest seccomp filters in moby 5 years ago drop crioctl source code 5 years ago Update to fix a few minor errors 5 years ago
vendor.conf Allow additional arguments to be passed into hooks 5 years ago

CRI-O logo

CRI-O - OCI-based implementation of Kubernetes Container Runtime Interface

Build Status Go Report Card

Status: Stable

Compatibility matrix: CRI-O <-> Kubernetes clusters

Version - Branch Kubernetes branch/version Maintenance status
CRI-O 1.0.x - release-1.0 Kubernetes 1.7 branch, v1.7.x =
CRI-O 1.8.x - release-1.8 Kubernetes 1.8 branch, v1.8.x =
CRI-O 1.9.x - release-1.9 Kubernetes 1.9 branch, v1.9.x =
CRI-O HEAD - master Kubernetes master branch


  • Changes in main Kubernetes repo about CRI are actively implemented in CRI-O
  • = Maintenance is manual, only bugs will be patched.

What is the scope of this project?

CRI-O is meant to provide an integration path between OCI conformant runtimes and the kubelet. Specifically, it implements the Kubelet Container Runtime Interface (CRI) using OCI conformant runtimes. The scope of CRI-O is tied to the scope of the CRI.

At a high level, we expect the scope of CRI-O to be restricted to the following functionalities:

  • Support multiple image formats including the existing Docker image format
  • Support for multiple means to download images including trust & image verification
  • Container image management (managing image layers, overlay filesystems, etc)
  • Container process lifecycle management
  • Monitoring and logging required to satisfy the CRI
  • Resource isolation as required by the CRI

What is not in scope for this project?

  • Building, signing and pushing images to various image storages
  • A CLI utility for interacting with CRI-O. Any CLIs built as part of this project are only meant for testing this project and there will be no guarantees on the backward compatibility with it.

This is an implementation of the Kubernetes Container Runtime Interface (CRI) that will allow Kubernetes to directly launch and manage Open Container Initiative (OCI) containers.

The plan is to use OCI projects and best of breed libraries for different aspects:

It is currently in active development in the Kubernetes community through the design proposal. Questions and issues should be raised in the Kubernetes sig-node Slack channel.


Command Description Demo
crio(8) OCI Kubernetes Container Runtime daemon

Note that kpod and its container management and debugging commands have moved to a separate repository, located here.


File Description
crio.conf(5) CRI-O Configuation file

OCI Hooks Support

CRI-O configures OCI Hooks to run when launching a container

CRI-O Usage Transfer

Useful information for ops and dev transfer as it relates to infrastructure that utilizes CRI-O


For async communication and long running discussions please use issues and pull requests on the github repo. This will be the best place to discuss design and implementation.

For sync communication we have an IRC channel #CRI-O, on, that everyone is welcome to join and chat about development.

Getting started

Runtime dependencies

  • runc, Clear Containers runtime, or any other OCI compatible runtime
  • socat
  • iproute
  • iptables

Latest version of runc is expected to be installed on the system. It is picked up as the default runtime by CRI-O.

Build and Run Dependencies


Fedora, CentOS, RHEL, and related distributions:

yum install -y \
  btrfs-progs-devel \
  device-mapper-devel \
  git \
  glib2-devel \
  glibc-devel \
  glibc-static \
  go \
  golang-github-cpuguy83-go-md2man \
  gpgme-devel \
  libassuan-devel \
  libgpg-error-devel \
  libseccomp-devel \
  libselinux-devel \
  ostree-devel \
  pkgconfig \
  runc \

Debian, Ubuntu, and related distributions:

apt-get install -y \
  btrfs-tools \
  git \
  golang-go \
  libassuan-dev \
  libdevmapper-dev \
  libglib2.0-dev \
  libc6-dev \
  libgpgme11-dev \
  libgpg-error-dev \
  libseccomp-dev \
  libselinux1-dev \
  pkg-config \
  go-md2man \
  runc \

Debian, Ubuntu, and related distributions will also need a copy of the development libraries for ostree, either in the form of the libostree-dev package from the flatpak PPA, or built from source (more on that here).

If using an older release or a long-term support release, be careful to double-check that the version of runc is new enough (running runc --version should produce spec: 1.0.0), or else build your own.


Be careful to double-check that the version of golang is new enough, version 1.8.x or higher is required. If needed, golang kits are avaliable at


Fedora, CentOS, RHEL, and related distributions:

(no optional packages)

Debian, Ubuntu, and related distributions:

apt-get install -y \

Get Source Code

As with other Go projects, CRI-O must be cloned into a directory structure like:

└── src
        └── kubernetes-incubator
            └── cri-o

First, configure a GOPATH (if you are using go1.8 or later, this defaults to ~/go).

export GOPATH=~/go
mkdir -p $GOPATH

Next, clone the source code using:

mkdir -p $GOPATH/src/
cd $_ # or cd $GOPATH/src/
git clone # or your fork
cd cri-o


sudo make install

Otherwise, if you do not want to build CRI-O with seccomp support you can add BUILDTAGS="" when running make.

sudo make install

Build Tags

CRI-O supports optional build tags for compiling support of various features. To add build tags to the make option the BUILDTAGS variable must be set.

make BUILDTAGS='seccomp apparmor'
Build Tag Feature Dependency
seccomp syscall filtering libseccomp
selinux selinux process and mount labeling libselinux
apparmor apparmor profile support libapparmor

Running pods and containers

Follow this tutorial to get started with CRI-O.

Setup CNI networking

A proper description of setting up CNI networking is given in the contrib/cni README. But the gist is that you need to have some basic network configurations enabled and CNI plugins installed on your system.

Running with kubernetes

You can run a local version of kubernetes with CRI-O using

  1. Clone the kubernetes repository
  2. Start the CRI-O daemon (crio)
  3. From the kubernetes project directory, run:
CONTAINER_RUNTIME_ENDPOINT='/var/run/crio/crio.sock  --runtime-request-timeout=15m' \

To run a full cluster, see the instructions.

Current Roadmap

  1. Basic pod/container lifecycle, basic image pull (done)
  2. Support for tty handling and state management (done)
  3. Basic integration with kubelet once client side changes are ready (done)
  4. Support for log management, networking integration using CNI, pluggable image/storage management (done)
  5. Support for exec/attach (done)
  6. Target fully automated kubernetes testing without failures e2e status
  7. Track upstream k8s releases