github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-01 07:47:15 +00:00
Code Issues Projects Releases Wiki Activity
250 Commits 53 Branches 136 Tags 321 MiB
Rust 58%
Go 24.7%
Shell 10%
RPC 5.4%
Makefile 1%
Other 0.9%
d890478fa2
Go to file
Peng Tao d890478fa2 release: Kata Containers 1.5.0-rc2 
- docs: update compatibility matrix with s390
- setup: Add make and gcc as dependencies
- suse: fix port URL detection for aarch64
- s390x: set CC for fedora
- Add 'install' target to makefile
- rootfs: Bump golang version to 1.11.1
- tests: skip docker,kata install with KATA_DEV_MODE

c3d77ae docs: add s390 to the compatibility matrix
be97380 setup: Add make and gcc as dependencies
de7fe19 s390x: set CC for fedora
3366a32 README: add ARM architecture to openSUSE
804286f suse: fix port URL detection for aarch64
434fff8 rootfs_builder: Dont fail if GOPATH not defined.
1bbf1e4 rootfs: Allow use host repositories.
f994560 rootfs: Bump golang version to 1.11.1
06c8d88 makefile: Add make install
9c0773a test: avoid errors in exit_handler
eb92306 tests: skip docker,kata install with KATA_DEV_MODE

Signed-off-by: Peng Tao <bergwolf@gmail.com>
2018-12-21 17:11:51 +08:00
.ci setup: Add make and gcc as dependencies 2018-12-14 08:09:52 -06:00
image-builder docs: Fix link in README 2018-10-24 13:52:00 -04:00
initrd-builder initrd-builder: make initrd_builder.sh idempotent 2018-06-29 15:08:56 +01:00
rootfs-builder Merge pull request #216 from marcov/suse-arm-repo-fix 2018-12-14 07:08:45 -06:00
scripts rootfs: Allow use host repositories. 2018-11-30 10:44:26 -06:00
tests test: avoid errors in exit_handler 2018-11-21 09:47:03 +01:00
.pullapprove.yml CI: Require doc team signoff for doc changes 2018-01-24 12:11:48 +00:00
.travis.yml travis: remove AGENT_INIT env combinations 2018-10-02 12:59:18 +02:00
CODE_OF_CONDUCT.md CoC: Add Code of Conduct 2017-12-04 23:35:38 +01:00
CONTRIBUTING.md Docs : Add minimal contribution guidelines 2018-01-30 22:01:48 +05:30
LICENSE Initial commit 2017-11-13 12:24:56 +01:00
Makefile makefile: Add make install 2018-11-26 10:36:14 -06:00
README.md docs: add s390 to the compatibility matrix 2018-12-17 10:39:09 +01:00
VERSION release: Kata Containers 1.5.0-rc2 2018-12-21 17:11:51 +08:00

README.md

Build Status

osbuilder

Introduction

The Kata Containers runtime creates a virtual machine (VM) to isolate a set of container workloads. The VM requires a guest kernel and a guest operating system ("guest OS") to boot and create containers inside the guest environment.

This repository contains tools to create a guest OS disk image.

Terms

This section describes the terms used for all documentation in this repository.

  • rootfs

    The root filesystem or "rootfs" is a slight misnomer as it is not a true filesystem. It is a tree of files contained in a particular directory, which represents the root disk layout. A rootfs can be turned into either an image or an initrd.

    See the rootfs creation section.

  • "Guest OS" (or "Guest Image")

    A "virtual disk" or "disk image" built from a rootfs. It contains a filesystem that is used by the VM, in conjunction with a guest kernel, to create an environment to host the container. Neither the guest OS nor the guest kernel need to be the same as the host operating system.

    See the image creation section.

  • initrd (or "initramfs")

    A compressed cpio(1) archive, created from a rootfs which is loaded into memory and used as part of the Linux startup process. During startup, the kernel unpacks it into a special instance of a tmpfs that becomes the initial root filesystem.

    See the initrd creation section.

  • "Base OS"

    A particular version of a Linux distribution used to create a rootfs from.

Usage

The top-level Makefile contains an example of how to use the available components.

By default, components will run on the host system. However, some components offer the ability to run from within Docker (for ease of setup) by setting the USE_DOCKER=true variable.

For more detailed information, consult the documentation for a particular component.

Rootfs creation

This section shows how to build a basic rootfs using the default distribution. For further details, see the rootfs builder documentation.

Rootfs with systemd as init

$ sudo -E PATH=$PATH make USE_DOCKER=true rootfs

Rootfs with the agent as init

$ sudo -E PATH=$PATH make USE_DOCKER=true AGENT_INIT=yes rootfs

Image creation

This section shows how to create an image from the already-created rootfs. For further details, see the image builder documentation.

Image with systemd as init

$ sudo -E PATH=$PATH make USE_DOCKER=true image

Image with the agent as init

$ sudo -E PATH=$PATH make USE_DOCKER=true AGENT_INIT=yes image

Initrd creation

To create an initrd from the already-created rootfs with the agent acting as the init daemon:

$ sudo -E PATH=$PATH make AGENT_INIT=yes initrd

For further details, see the initrd builder documentation.

Tests

$ make test

For further details, see the tests documentation.

Platform-Distro Compatibility Matrix

Alpine CentOS ClearLinux Debian/Ubuntu EulerOS Fedora openSUSE
ARM64 ✔️ ✔️ ✔️ ✔️ ✔️
PPC64le ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
s390x ✔️ ✔️ ✔️
x86_64 ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️