584e3ac7b3
* curve25519: explictly depend on AS_AVX * curve25519: modularize dispatch It's now much cleaner to see which implementation we're calling, and it will be simpler to add more implementations in the future. * compat: support RAP in assembly This should fix PaX/Grsecurity support. * device: do not clear keys during sleep on Android While we want to clear keys when going to sleep on ordinary Linux, this doesn't make sense in the Android world, where phones often sleep but are woken up every few milliseconds by the radios to process packets. * compat: fix 3.10 backport Important compat fixes for non-x86. * device: clear last handshake timer on ifdown When bringing up an interface, we don't want the rate limiting to handshakes to apply. * netlink: rename symbol to avoid clashes Allows coexistance with horrible Android drivers. * kernel-tree: jury rig is the more common spelling * tools: no need to put this on the stack * blake2s-x86_64: fix spacing Small fixes. * contrib: keygen-html for generating keys in the browser This was covered here: https://lists.zx2c4.com/pipermail/wireguard/2017-December/002127.html * tools: remove undocumented unused syntax Not only did nobody know about this or use it, but the implementation actually exposed compiler bugs in Qualcomm's "Snapdragon Clang". * poly1305: update x86-64 kernel to AVX512F only From Samuel Neves, this pulls in Andy Polyakov's changes to only require F and not VL for the Poly implementation. * chacha20-arm: fix with clang -fno-integrated-as. This pulls in David Benjamin's clang fix. * global: add SPDX tags to all files From Greg KH, we now have SPDX annotations on all files, matching upstream kernel's new approach to file licenses. * chacha20poly1305: cleaner generic code This entirely removes the last remains of Martin Willi's ChaCha implementation, and now the generic C implementation is extremely small and clearly written, while delivering a small performance boost too. * poly1305: fix avx512f alignment bug Unlucky people may have had their linkers misalign a constant. This fixes that potential. * chacha20: avx512vl implementation From Samuel Neves, this imports Andy Polyakov's AVX512VL implementation of ChaCha which should have a ~50% performance improvement over AVX2, though it is still much slower than our AVX512F implementation. * chacha20poly1305: wire up avx512vl for skylake-x Some Skylake machines do not have two FMA units (though others do), so we prefer the AVX512VL implementation over the should-be-faster AVX512F implementation on those machines. What's needed now is to read the PIROM in order to determine at runtime whether the particular Skylake-X machine actually has the second FMA unit or not, but until that happens, we just fall back to the VL implementation for all Skylake-X. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com> |
||
|---|---|---|
| .circleci | ||
| .github | ||
| blueprints | ||
| docs | ||
| examples | ||
| kernel | ||
| logo | ||
| pkg | ||
| projects | ||
| reports | ||
| scripts | ||
| sigs | ||
| src/cmd/linuxkit | ||
| test | ||
| tools | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| AUTHORS | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| linuxkit.yml | ||
| MAINTAINERS | ||
| Makefile | ||
| NOTICE | ||
| poule.yml | ||
| README.md | ||
LinuxKit
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
Subprojects
- LinuxKit kubernetes aims to build minimal and immutable Kubernetes images. (previously
projects/kubernetesin this repository).
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:
- Local hypervisors
- Cloud based platforms:
- Baremetal:
- x86 and arm64 servers on packet.net
- Raspberry Pi Model 3b
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 -x run
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 -x -l slow run
To run tests that match the pattern linuxkit.examples you would use the following command:
rtf -x run 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 with the moby tool 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:
kernelspecifies a kernel Docker image, containing a kernel and a filesystem tarball, eg containing modules. The example kernels are built fromkernel/initis the baseinitprocess Docker image, which is unpacked as the base system, containinginit,containerd,runcand a few tools. Built frompkg/init/onbootare the system containers, executed sequentially in order. They should terminate quickly when done.servicesis the system services, which normally run for the whole time the system is upfilesare 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.