github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-06-28 00:07:16 +00:00
Code Issues Projects Releases Wiki Activity
146 Commits 82 Branches 134 Tags 325 MiB
Rust 57.9%
Go 24.8%
Shell 10%
RPC 5.4%
Makefile 1%
Other 0.9%
7b581c25d8
Go to file
James O. D. Hunt 7b581c25d8 tests: Convert bats test to shell script 
The tests perform a lot of configuration and call other commands. Since
the tests are running under BATS, any "stdout pollution" results in the
test failing. This is too rigid for current purposes so convert the
BATS test into a `set -e` test. This will still fail if any command
fails, but does not impose the output pollution restriction. It also
makes debugging easier.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-25 15:06:49 +01:00
.ci tests: Convert bats test to shell script 2018-06-25 15:06:49 +01:00
image-builder rootfs: add '-rm' to delete intermediate container 2018-06-12 08:16:56 +00:00
initrd-builder initrd: Remove mention of USE_DOCKER 2018-04-20 11:17:02 +01:00
rootfs-builder rootfs-builder: Support building centos-rootfs on Arm64 2018-06-13 07:21:17 +00:00
scripts rootfs-builder: Support building centos-rootfs on Arm64 2018-06-13 07:21:17 +00:00
tests tests: Convert bats test to shell script 2018-06-25 15:06:49 +01:00
.pullapprove.yml CI: Require doc team signoff for doc changes 2018-01-24 12:11:48 +00:00
.travis.yml CI: enable agent as init process and kata initrd tests 2018-02-01 23:27:40 +08: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 rootfs: Create a summary file inside the image 2018-04-20 11:46:55 +01:00
README.md docs: Update README, Fix a minor space issue 2018-06-07 19:45:08 +05:30
VERSION rootfs: Create a summary file inside the image 2018-04-20 11:46:55 +01: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-only

Image with the agent as init

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

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-only

For further details, see the initrd builder documentation.