No description
Find a file
Samuel Ortiz 4cab8ed06a
sandbox: Use persistent networking namespace
Because they need to prepare the hypervisor networking interfaces
and have them match the ones created in the pod networking
namespace (typically to bridge TAP and veth interfaces), hypervisor
based container runtimes need the sandbox pod networking namespace
to be set up before it's created. They can then prepare and start
the hypervisor interfaces when creating the pod virtual machine.

In order to do so, we need to create per pod persitent networking
namespaces that we pass to the CNI plugin. This patch leverages
the CNI ns package to create such namespaces under /var/run/netns,
and assign them to all pod containers.
The persitent namespace is removed when either the pod is stopped
or removed.

Since the StopPodSandbox() API can be called multiple times from
kubelet, we track the pod networking namespace state (closed or
not) so that we don't get a containernetworking/ns package error
when calling its Close() routine multiple times as well.

Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
2016-12-12 19:48:23 +01:00
.tool Add support for pod /dev/shm that is shared by the pod ctrs 2016-12-08 15:32:17 -08:00
cmd store annotations and image for a container 2016-12-12 11:12:03 +01:00
completions/bash Add missing man pages and bash completions for kpod 2016-12-02 10:17:58 -05:00
conmon Merge pull request #194 from sameo/master 2016-11-15 09:47:13 -08:00
contrib foobar 2016-10-31 15:17:23 -04:00
docs Merge pull request #215 from xlgao-zju/support-apparmor 2016-12-05 21:24:50 -08:00
hack add seccomp support 2016-11-28 22:05:34 +01:00
oci sandbox: Use persistent networking namespace 2016-12-12 19:48:23 +01:00
pause *: add pause binary as a build target 2016-10-02 19:36:39 +11:00
server sandbox: Use persistent networking namespace 2016-12-12 19:48:23 +01:00
test test: add restart ocid with pod stopped test 2016-12-09 11:56:25 +01:00
utils Log more information about exited children 2016-11-03 12:07:52 -04:00
vendor/src vendor: Add CNI ns package 2016-12-12 19:48:23 +01:00
.gitignore Add missing man pages and bash completions for kpod 2016-12-02 10:17:58 -05:00
.travis.yml .travis.yml: enable make docs 2016-09-28 23:55:50 +02: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 add test cases 2016-12-01 21:42:13 +08:00
LICENSE Initial commit 2016-09-09 12:56:31 -07:00
Makefile Makefile: fix the creation of man5 2016-12-08 14:49:02 -05:00
OWNERS Add feiskyer as an OWNER 2016-11-18 09:05:14 -08:00
README.md add apparmor build tag and update readme 2016-12-06 11:51:15 +08:00
seccomp.json add seccomp support 2016-11-28 22:05:34 +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

glib2-devel and glibc-static packages on Fedora or libglib2.0-dev on Ubuntu or equivalent is required. In order to enable seccomp support you will need to install libseccomp on your platform.

e.g. libseccomp-devel for CentOS/Fedora, or libseccomp-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

Start the server

# ocid --debug

If the default --runtime value does not point to your runtime:

# ocid --runtime $(which runc)

Create a pod

$ ocic pod create --config test/testdata/sandbox_config.json

Get pod status

# ocic pod status --id <pod_id>

Run a container inside a pod

# ocic ctr create --pod <pod_id> --config test/testdata/container_redis.json

Start a container

# ocic ctr start --id <ctr_id>

Get container status

# ocic ctr status --id <ctr_id>

Stop a container

# ocic ctr stop --id <ctr_id>

Remove a container

# ocic ctr remove --id <ctr_id>

Stop a pod

# ocic pod stop --id <pod_id>

Remove a pod

# ocic pod remove --id <pod_id>

List pods

# ocic pod list

List containers

# ocic ctr list

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