A toolkit for building secure, portable and lean operating systems for containers
Switch branches/tags
Clone or download
justincormack Merge pull request #3199 from zimbatm/patch-1
README: add the LinuxKit Nix project
Latest commit 31e7201 Oct 16, 2018
Permalink
Failed to load latest commit information.
.circleci Fix golint on circleci Oct 15, 2018
.github Add code of conduct link to Github recommended location Jan 22, 2018
contrib Update YAMLs to latest kernels Oct 6, 2018
docs Add some documentation. Aug 14, 2018
examples update -rt to 4.14.71-rt44 Oct 15, 2018
kernel update -rt to 4.14.71-rt44 Oct 15, 2018
logo Add the LinuxKit logos to the repo Oct 31, 2017
pkg Bump runc to version from containerd v1.1.4 Sep 25, 2018
projects Update YAMLs to latest kernels Oct 6, 2018
reports September 2018 development report Oct 1, 2018
scripts update-component-sha.sh: ignore changes in directories named "vendor" Apr 25, 2018
sigs Update SIG reports link May 15, 2017
src/cmd/linuxkit gcp: output error message when client could not be created Oct 16, 2018
test Sleep in GCP test Oct 15, 2018
tools alpine: Bump to containerd v1.1.4 Sep 25, 2018
.gitattributes Improve language detection Nov 17, 2017
.gitignore kernel: Use local kernel source if available Aug 20, 2017
.mailmap Update my email in AUTHORS and MAINTAINERS Jul 26, 2018
AUTHORS Update my email in AUTHORS and MAINTAINERS Jul 26, 2018
CHANGELOG.md Update CHANGELOG Jul 26, 2018
CONTRIBUTING.md Change docker/linuxkit to linuxkit/linuxkit Apr 17, 2017
LICENSE Add license files Apr 24, 2017
MAINTAINERS Update my email in AUTHORS and MAINTAINERS Jul 26, 2018
Makefile Update version to v0.6+ Jul 26, 2018
NOTICE Add license files Apr 24, 2017
README.md README: add the LinuxKit Nix project Oct 16, 2018
linuxkit.yml Update YAMLs to latest kernels Oct 6, 2018
poule.yml add initial poule config Nov 14, 2017

README.md

LinuxKit

CircleCI

LinuxKit, a toolkit for building custom minimal, immutable Linux distributions.

  • Secure defaults without compromising usability
  • Everything is replaceable and customisable
  • Immutable infrastructure applied to building Linux distributions
  • Completely stateless, but persistent storage can be attached
  • Easy tooling, with easy iteration
  • Built with containers, for running containers
  • Designed for building and running clustered applications, including but not limited to container orchestration such as Docker or Kubernetes
  • Designed from the experience of building Docker Editions, but redesigned as a general-purpose toolkit
  • Designed to be managed by external tooling, such as Infrakit or similar tools
  • Includes a set of longer-term collaborative projects in various stages of development to innovate on kernel and userspace changes, particularly around security

LinuxKit currently supports the x86_64, arm64, and s390x architectures on a variety of platforms, both as virtual machines and baremetal (see below for details).

Subprojects

  • LinuxKit kubernetes aims to build minimal and immutable Kubernetes images. (previously projects/kubernetes in this repository).
  • LinuxKit LCOW LinuxKit images and utilities for Microsoft's Linux Containers on Windows.
  • LinuxKit Nix aims to provide a Linux Nix VM for macOS.
  • linux A copy of the Linux stable tree with branches LinuxKit kernels.
  • virtsock A go library and test utilities for virtio and Hyper-V sockets.
  • rtf A regression test framework used for the LinuxKit CI tests (and other projects).

Getting Started

Build the linuxkit tool

LinuxKit uses the linuxkit tool for building, pushing and running VM images.

Simple build instructions: use make to build. This will build the tool in bin/. Add this to your PATH or copy it to somewhere in your PATH eg sudo cp bin/* /usr/local/bin/. Or you can use sudo make install.

If you already have go installed you can use go get -u github.com/linuxkit/linuxkit/src/cmd/linuxkit to install the linuxkit tool.

On MacOS there is a brew tap available. Detailed instructions are at linuxkit/homebrew-linuxkit, the short summary is

brew tap linuxkit/linuxkit
brew install --HEAD linuxkit

Build requirements from source:

  • GNU make
  • Docker
  • optionally qemu

Building images

Once you have built the tool, use

linuxkit build linuxkit.yml

to build the example configuration. You can also specify different output formats, eg linuxkit build -format raw-bios linuxkit.yml to output a raw BIOS bootable disk image, or linuxkit build -format iso-efi linuxkit.yml to output an EFI bootable ISO image. See linuxkit build -help for more information.

Booting and Testing

You can use linuxkit run <name> or linuxkit run <name>.<format> to execute the image you created with linuxkit build <name>.yml. This will use a suitable backend for your platform or you can choose one, for example VMWare. See linuxkit run --help.

Currently supported platforms are:

Running the Tests

The test suite uses rtf To install this you should use make bin/rtf && make install. You will also need to install expect on your system as some tests use it.

To run the test suite:

cd test
rtf -v run -x

This will run the tests and put the results in a the _results directory!

Run control is handled using labels and with pattern matching. To run add a label you may use:

rtf -v -l slow run -x

To run tests that match the pattern linuxkit.examples you would use the following command:

rtf -v run -x linuxkit.examples

Building your own customised image

To customise, copy or modify the linuxkit.yml to your own file.yml or use one of the examples and then run linuxkit build file.yml to generate its specified output. You can run the output with linuxkit run file.

The yaml file specifies a kernel and base init system, a set of containers that are built into the generated image and started at boot time. You can specify the type of artifact to build eg linuxkit build -format vhd linuxkit.yml.

If you want to build your own packages, see this document.

Yaml Specification

The yaml format specifies the image to be built:

  • kernel specifies a kernel Docker image, containing a kernel and a filesystem tarball, eg containing modules. The example kernels are built from kernel/
  • init is the base init process Docker image, which is unpacked as the base system, containing init, containerd, runc and a few tools. Built from pkg/init/
  • onboot are the system containers, executed sequentially in order. They should terminate quickly when done.
  • services is the system services, which normally run for the whole time the system is up
  • files are additional files to add to the image

For a more detailed overview of the options see yaml documentation

Architecture and security

There is an overview of the architecture covering how the system works.

There is an overview of the security considerations and direction covering the security design of the system.

Roadmap

This project was extensively reworked from the code we are shipping in Docker Editions, and the result is not yet production quality. The plan is to return to production quality during Q3 2017, and rebase the Docker Editions on this open source project during this quarter. We plan to start making stable releases on this timescale.

This is an open project without fixed judgements, open to the community to set the direction. The guiding principles are:

  • Security informs design
  • Infrastructure as code: immutable, manageable with code
  • Sensible, secure, and well-tested defaults
  • An open, pluggable platform for diverse use cases
  • Easy to use and participate in the project
  • Built with containers, for portability and reproducibility
  • Run with system containers, for isolation and extensibility
  • A base for robust products

Development reports

There are weekly development reports summarizing work carried out in the week.

FAQ

See FAQ.

Released under the Apache 2.0 license.