Skip to content
Linuxkit

Linuxkit

github.com • November 18, 2026

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 (renamed to deploykit which has been archived in 2019) 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).

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.

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).

homebrew Homebrew packages for the linuxkit tool.

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 install github.com/linuxkit/linuxkit/src/cmd/linuxkit@latest to install the linuxkit tool.

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

Build requirements from source using a container

Docker (see Docker contexts and alternative backends )

For a local build using make local

go get -u golang.org/x/lint/golint

go get -u github.com/gordonklaus/ineffassign

Once you have built the tool, use

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.

You can use linuxkit run or linuxkit run . to execute the image you created with linuxkit build .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:

Local hypervisors Virtualization.Framework (macOS) [x86_64, arm64] HyperKit (macOS) [x86_64] Hyper-V (Windows) [x86_64] qemu (macOS, Linux, Windows) [x86_64, arm64, s390x] VMware (macOS, Windows) [x86_64]

Virtualization.Framework (macOS) [x86_64, arm64]

HyperKit (macOS) [x86_64]

Hyper-V (Windows) [x86_64]

qemu (macOS, Linux, Windows) [x86_64, arm64, s390x]

VMware (macOS, Windows) [x86_64]

Cloud based platforms: Amazon Web Services [x86_64] Google Cloud [x86_64] Microsoft Azure [x86_64] OpenStack [x86_64] Scaleway [x86_64]

Amazon Web Services [x86_64]

Google Cloud [x86_64]

Microsoft Azure [x86_64]

Baremetal: deploy.equinix.com [x86_64, arm64] Raspberry Pi Model 3b [arm64]

deploy.equinix.com [x86_64, arm64]

Raspberry Pi Model 3b [arm64]

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:

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:

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

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 .

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.

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

There are monthly development reports summarising the work carried out each month.

We maintain an incomplete list of adopters . Please open a PR if you are using LinuxKit in production or in your project, or both.

Released under the Apache 2.0 license .