No description
Find a file
Mrunal Patel 0ae21a5f08 Add support for displaying git commit in version
Signed-off-by: Mrunal Patel <mrunalp@gmail.com>
2017-09-08 10:16:01 -07:00
.tool lint: Exit and give instructions when linter missing 2017-09-06 10:15:20 -04:00
cmd Add support for displaying git commit in version 2017-09-08 10:16:01 -07:00
completions/bash Implement kpod rm 2017-09-05 14:35:36 -04:00
conmon Add inotify watcher for container exits 2017-08-13 08:01:48 -07:00
contrib contrib: test: run kube tests in CI with same cgroup driver 2017-09-08 14:26:39 +02:00
docs Implement kpod rm 2017-09-05 14:35:36 -04:00
hack Fix bug in find-godeps 2017-07-19 16:49:22 -04:00
libkpod Merge pull request #803 from rhatdan/libpod 2017-09-07 15:20:31 -04:00
libpod Begin converting kpod pull to use libpod/runtime 2017-09-06 19:38:47 +00:00
logo Adding cri-o logo artwork 2017-03-01 13:34:30 -05:00
oci server: port to github.com/cri-o/ocicni; remove pkg/ocicni 2017-09-06 16:07:50 -05:00
pause pause: Fix compilation warning 2017-04-21 16:17:53 -07:00
pkg pkg: storage: image: get size from image ID 2017-09-08 07:27:48 -07:00
server Merge pull request #562 from rhatdan/hooks 2017-09-07 19:06:01 +02:00
test contrib: test: run kube tests in CI with same cgroup driver 2017-09-08 14:26:39 +02:00
utils utils: Fix close conn after starting scope 2017-08-27 07:34:45 -07:00
vendor container_create: handle cap add/drop ALL 2017-09-07 16:43:33 +02:00
.gitignore .gitignore: do not ignore *.rej files 2017-05-26 15:46:32 +02:00
.travis.yml streamlining travis 2017-08-30 17:21:23 -05:00
code-of-conduct.md Number of minor touch ups to Code of Conduct 2017-08-16 11:34:58 -04:00
Dockerfile test: replace bash CNI plugin with a custom bridge 2017-09-06 17:14:53 +02:00
hooks.md Add support for oci-hooks to libkpod 2017-09-05 07:39:31 -04:00
kpod-images.json add kpod stats function 2017-08-17 11:34:10 -04:00
kubernetes.md Rename ocid to crio. 2017-05-12 09:56:06 -04:00
LICENSE Initial commit 2016-09-09 12:56:31 -07:00
Makefile When installing content make sure it gets labeled correctly. 2017-09-05 17:09:28 -04:00
OWNERS I would like to add @nalind to the OWNERS of cri-o 2017-08-07 16:16:07 -04:00
README.md README: more copy-pastable code sample 2017-09-08 09:27:50 -04:00
seccomp.json add seccomp support 2016-11-28 22:05:34 +01:00
transfer.md Update README 2017-08-23 07:36:10 -04:00
tutorial.md Fix Typo in cri-o Tutorial 2017-08-15 10:00:20 +05:30
vendor.conf container_create: handle cap add/drop ALL 2017-09-07 16:43:33 +02:00

cri-o logo

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

Build Status Go Report Card

Status: beta

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.

Commands

Command Description Demo
crio(8) OCI Kubernetes Container Runtime daemon
kpod(1) Simple management tool for pods and images
kpod-cp(1) Copy files/folders between a container and the local filesystem
kpod-diff(1) Inspect changes on a container or image's filesystem
kpod-export(1) Export container's filesystem contents as a tar archive
kpod-history(1) Shows the history of an image ...
kpod-images(1) List images in local storage ...
kpod-info(1) Display system information
kpod-inspect(1) Display the configuration of a container or image ...
kpod-load(1) Load an image from docker archive or oci ...
kpod-logs(1) Display the logs of a container
kpod-mount(1) Mount a working container's root filesystem
kpod-ps(1) Prints out information about containers
kpod-pull(1) Pull an image from a registry ...
kpod-push(1) Push an image to a specified destination ...
kpod-rename(1) Rename a container
kpod-rm(1) Removes one or more containers
kpod-rmi(1) Removes one or more images ...
kpod-save(1) Saves an image to an archive ...
kpod-stats(1) Display a live stream of one or more containers' resource usage statistics
kpod-tag(1) Add an additional name to a local image ...
kpod-umount(1) Unmount a working container's root filesystem
kpod-version(1) Display the version information ...

Configuration

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

Communication

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 chat.freenode.net, that everyone is welcome to join and chat about development.

Getting started

Prerequisites

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

Build Dependencies

Required

Fedora, CentOS, RHEL, and related distributions:

yum install -y \
  btrfs-progs-devel \
  device-mapper-devel \
  glib2-devel \
  glibc-devel \
  glibc-static \
  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 \
  libassuan-dev \
  libdevmapper-dev \
  libglib2.0-dev \
  libc6-dev \
  libgpgme11-dev \
  libgpg-error-dev \
  libseccomp-dev \
  libselinux1-dev \
  pkg-config \
  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.

Optional

Fedora, CentOS, RHEL, and related distributions:

(no optional packages)

Debian, Ubuntu, and related distributions:

apt-get install -y \
  libapparmor-dev

Get Source Code

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

GOPATH
└── src
    └── github.com
        └── 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/github.com/kubernetes-incubator
cd $_ # or cd $GOPATH/src/github.com/kubernetes-incubator
git clone https://github.com/kubernetes-incubator/cri-o # or your fork
cd cri-o

Build

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.

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 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 local-up-cluster.sh:

  1. Clone the kubernetes repository
  2. Start the cri-o daemon (crio)
  3. From the kubernetes project directory, run:
CONTAINER_RUNTIME=remote \
CONTAINER_RUNTIME_ENDPOINT='/var/run/crio.sock  --runtime-request-timeout=15m' \
./hack/local-up-cluster.sh

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. Release 1.0
  8. Track upstream k8s releases