No description
Find a file
Máirín Duffy 127f123734 Adding cri-o logo artwork
Note that crio-logo-source is the full Inkscape SVG source and crio-logo.svg
is an SVGO-optimized version of just the white bg version of the logo.

Issue: #370
Signed-off-by: Máirín Duffy <duffy@redhat.com>
2017-03-01 13:34:30 -05:00
.tool Build and install from GOPATH 2017-01-17 12:09:09 -08:00
cmd Deprecate --storage-option for --storage-opt 2017-02-25 09:09:50 -05:00
completions/bash Add missing man pages and bash completions for kpod 2016-12-02 10:17:58 -05:00
conmon conmon: Use conmon for exec'ing a command 2017-01-14 02:02:40 +01:00
contrib foobar 2016-10-31 15:17:23 -04:00
docs Deprecate --storage-option for --storage-opt 2017-02-25 09:09:50 -05:00
hack Merge pull request #352 from mrunalp/deps 2017-02-02 18:32:44 +01:00
logo Adding cri-o logo artwork 2017-03-01 13:34:30 -05:00
oci Switch to github.com/golang/dep for vendoring 2017-01-31 16:45:59 -08:00
pause *: add pause binary as a build target 2016-10-02 19:36:39 +11:00
pkg Don't try to parse an image ID a second time 2017-02-08 10:58:00 -05:00
server Use canonical import path for apimachinery 2017-02-22 18:32:42 -08:00
test Deprecate --storage-option for --storage-opt 2017-02-25 09:09:50 -05:00
utils Integrate containers/storage 2017-01-18 10:23:30 -05:00
vendor Merge pull request #360 from runcom/bump-runc 2017-02-07 15:06:39 -08:00
.gitignore sort .gitignore 2017-02-21 11:49:28 -08:00
.travis.yml merge branch 'pr-364' 2017-02-21 08:28:21 +11:00
code-of-conduct.md Add a code of conduct based on github.com/kubernetes/kubernetes 2016-09-09 15:26:59 -07:00
Dockerfile Dockerfile: pull test image at build time 2017-01-19 18:51:47 +01:00
kubernetes.md doc: Add instruction to run cri-o with kubernetes 2017-02-03 10:37:50 +01:00
LICENSE Initial commit 2016-09-09 12:56:31 -07:00
lock.json Merge pull request #360 from runcom/bump-runc 2017-02-07 15:06:39 -08:00
Makefile make: revert switch to 'go install' 2017-02-17 03:22:12 +11:00
manifest.json dep: Update containers/image to 1c202c5d85d2ee531acb1e91740144410066d19e 2017-02-03 11:15:09 -08:00
OWNERS Update the OWNERS file 2017-01-23 11:14:28 -08:00
README.md Correct package name for pkg-config 2017-02-27 16:03:20 +05:30
seccomp.json add seccomp support 2016-11-28 22:05:34 +01:00
tutorial.md README.md: replace examples with kelsey's tutorial 2017-01-27 08:30:18 +01:00

cri-o - OCI-based implementation of Kubernetes Container Runtime Interface

Build Status Go Report Card

Status: pre-alpha

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 backwards 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.

Getting started

Prerequisites

runc version 1.0.0.rc1 or greater is expected to be installed on the system. It is picked up as the default runtime by ocid.

Build

btrfs-progs-devel, device-mapper-devel, glib2-devel, glibc-devel, glibc-static, gpgme-devel, libassuan-devel, libgpg-error-devel, and pkgconfig packages on CentOS/Fedora or btrfs-tools, libassuan-dev, libc6-dev, libdevmapper-dev, libglib2.0-dev, libgpg-error-dev, libgpgme11-dev, and pkg-config on Ubuntu or equivalent is required. In order to enable seccomp support you will need to install development files for libseccomp on your platform.

e.g. libseccomp-devel for CentOS/Fedora, or libseccomp-dev for Ubuntu In order to enable apparmor support you will need to install development files for libapparmor on your platform. e.g. libapparmor-dev for Ubuntu

$ GOPATH=/path/to/gopath
$ mkdir $GOPATH
$ go get -d github.com/kubernetes-incubator/cri-o
$ cd $GOPATH/src/github.com/kubernetes-incubator/cri-o
$ make install.tools
$ make
$ sudo make install

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

# create a 'github.com/kubernetes-incubator' in your $GOPATH/src
cd github.com/kubernetes-incubator
git clone https://github.com/kubernetes-incubator/cri-o
cd cri-o

make BUILDTAGS=""
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
apparmor apparmor profile support libapparmor

Running pods and containers

Follow this tutorial to get started with CRI-O.

Setup CNI networking

Follow the steps below in order to setup networking in your pods using the CNI bridge plugin. Nothing else is required after this since CRI-O automatically setup networking if it finds any CNI plugin.

$ go get -d github.com/containernetworking/cni
$ cd $GOPATH/src/github.com/containernetworking/cni
$ sudo mkdir -p /etc/cni/net.d
$ sudo sh -c 'cat >/etc/cni/net.d/10-mynet.conf <<-EOF
{
    "cniVersion": "0.2.0",
    "name": "mynet",
    "type": "bridge",
    "bridge": "cni0",
    "isGateway": true,
    "ipMasq": true,
    "ipam": {
        "type": "host-local",
        "subnet": "10.88.0.0/16",
        "routes": [
            { "dst": "0.0.0.0/0"  }
        ]
    }
}
EOF'
$ sudo sh -c 'cat >/etc/cni/net.d/99-loopback.conf <<-EOF
{
    "cniVersion": "0.2.0",
    "type": "loopback"
}
EOF'
$ ./build
$ sudo mkdir -p /opt/cni/bin
$ sudo cp bin/* /opt/cni/bin/

Running with kubernetes

You can run the local version of kubernetes using local-up-cluster.sh. After starting ocid daemon:

EXPERIMENTAL_CRI=true CONTAINER_RUNTIME=remote CONTAINER_RUNTIME_ENDPOINT='/var/run/ocid.sock --runtime-request-timeout=15m' ./hack/local-up-cluster.sh

For running on kubernetes cluster - see the instruction

Current Roadmap

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