aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 299a5daf5f88fa28e1ac7cfd115566182c8e64f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
This layer enables the clear containers runtime (cc-oci-runtime) for Docker:

Details about the Clear Containers project can be found at:

https://github.com/01org/cc-oci-runtime

https://clearlinux.org/features/intel%C2%AE-clear-containers

Dependencies
============

This layer depends on:

  URL: git://git.yoctoproject.org/poky.git
  layers: meta meta-poky meta-yocto-bsp
  branch: pyro

  URL: git://git.openembedded.org/meta-openembedded
  layers: meta-oe meta-python meta-networking meta-filesystems
  branch: pyro

  URI: git://git.yoctoproject.org/meta-virtualization
  branch: master

Patches
=======

Please submit any patches for meta-intel-clear-containers layer to the
meta-intel mailing list (meta-intel@yoctoproject.org):


Table of Contents
=================

  I. Adding the meta-intel-clear-containers layer to your build
 II. Misc


I. Adding the meta-intel-clear-containers layer to your build
=================================================

The clear containers runtime can be added to your images with the cc-oci-runtime recipe.

Example (add to conf/local.conf):
IMAGE_INSTALL_append += " cc-oci-runtime "

In order to use this layer, you need to make the build system aware of
it.

Assuming the meta-intel-clear-containers layer exists at the top-level of your
yocto build tree, you can add it to the build system by adding the
location of the meta-intel-clear-containers layer to bblayers.conf, along with any
other layers needed. e.g.:

  BBLAYERS ?= " \
    /path/to/yocto/meta \
    /path/to/yocto/meta-poky \
    /path/to/yocto/meta-yocto-bsp \
    /path/to/yocto/meta-openembedded/meta-oe \
    /path/to/yocto/meta-openembedded/meta-python \
    /path/to/yocto/meta-openembedded/meta-networking \
    /path/to/yocto/meta-openembedded/meta-filesystems \
    /path/to/yocto/meta-virtualization  \
    /path/to/yocto/meta-intel-clear-containers \
    "

II. Misc
========
* Clear Containers depends on the following kernel module.
It will be automatically enabled for 3.9.* and 3.10.* kernels

CONFIG_VHOST_NET=m

* To modify the amount of memory available to QEMU. Add the following variable to your conf/local.conf

QEMU_CC_MEM = "2G,slots=2,maxmem=2G"

* When building docker with clear containers support, the default docker runtime will be set to cor (cc-oci-runtime). To change the default docker runtime, please modify the docker.service file and restart docker.

Example for runc (docker.service):

ExecStart=/usr/bin/dockerd -D --add-runtime cor=/usr/bin/cc-oci-runtime.sh --default-runtime=runc -H fd://