github/linuxkit
1
0
Fork 0
mirror of https://github.com/linuxkit/linuxkit.git synced 2025-07-19 17:26:28 +00:00
Code Issues Projects Releases Wiki Activity
A toolkit for building secure, portable and lean operating systems for containers
2,398 Commits 1 Branch 27 Tags 240 MiB
Go 47.8%
text 21.7%
Shell 13.7%
Dockerfile 5.8%
OCaml 4.7%
Other 6.3%
ea4ceab3f8
Go to file
Rolf Neugebauer ea4ceab3f8 moby: Add a 'run' command to execute an image on hyperkit 
'moby run' will use the kernel and initrd image produced
by 'moby build' and, on macOS, will run it inside a
hyperkit VM. This assumes that you have a recent version
of Docker for Mac installed as it re-uses the hyperkit
and VPNKit from it.

Signed-off-by: Rolf Neugebauer <rolf.neugebauer@docker.com>
2017-03-22 14:47:56 +00:00
base Move installable packages to pkg 2017-03-22 12:33:11 +00:00
docs docs: moby/alpine/kernel/ is now just moby/kernel/ 2017-03-15 15:14:56 +00:00
ebpf Move ebpf to top level 2017-02-01 10:58:52 +00:00
examples Make sshd output to stderr not syslog 2017-03-22 09:43:32 +00:00
kernel kernel: Add initial support for 4.10.x kernels 2017-03-20 13:50:27 +00:00
pkg Move installable packages to pkg 2017-03-22 12:33:11 +00:00
projects Merge pull request #1353 from tych0/selinux 2017-03-21 18:43:18 +00:00
reports Hyperlink the PR links in weekly report 2017-03-19 17:43:50 +00:00
scripts Fix hyperkit script to use correct command line 2017-03-20 15:51:33 +00:00
src moby: Add a 'run' command to execute an image on hyperkit 2017-03-22 14:47:56 +00:00
test test: Move test-ltp -> ltp 2017-03-21 09:47:42 +00:00
tools We no longer directly convert to initrd, we use Go libraries for this 2017-03-21 11:47:16 +00:00
vendor moby: Add a 'run' command to execute an image on hyperkit 2017-03-22 14:47:56 +00:00
.datakitci.json Out with the old, in with the new Moby 2017-03-06 22:28:41 +00:00
.gitignore Output kernel command line to a file in the kernel+initrd output case 2017-03-20 13:43:09 +00:00
Makefile moby: Introduce the "build" subcommand 2017-03-22 14:38:02 +00:00
moby.yaml Clean up apk cache in init 2017-03-16 19:14:08 +00:00
README.md moby: Introduce the "build" subcommand 2017-03-22 14:38:02 +00:00
vendor.conf moby: Add a 'run' command to execute an image on hyperkit 2017-03-22 14:47:56 +00:00

README.md

Moby

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

  • Good, secure defaults included
  • 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

Getting Started

Build

Simple build instructions: use make to build. This will build the Moby customisation tool and a Moby initrd image.

If you already have a Go build environment and installed the source in your GOPATH you can do go install github.com/docker/moby/cmd/moby to install the moby tool instead, and then use moby build moby.yaml to build the example configuration.

Build requirements

  • GNU make
  • GNU or BSD tar (not busybox tar)
  • Docker

Booting and Testing

  • make qemu will boot up a sample Moby in qemu in a container
  • on OSX: make hyperkit will boot up Moby in hyperkit
  • make test or make hyperkit-test will run the test suite
  • There are also docs for booting on Google Cloud
  • More detailed docs will be available shortly, for running single hosts and clusters.

Customise

To customise, copy or modify the moby.yaml to your own file.yaml or use on of the examples and then run ./bin/moby build file.yaml to generate its specified output. You can run the output with ./scripts/qemu.sh or ./scripts/hyperkit.sh, or on other platforms.

Yaml Specification

The Yaml format is loosely based on Docker Compose:

  • kernel specifies a kernel Docker image, containing a kernel and a filesystem tarball, eg containing modules. mobylinux/kernel is 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 base/init/
  • system are the system containers, executed sequentially in order. They should terminate quickly when done.
  • daemon is the system daemons, which normally run for the whole time
  • files are additional files to add to the image
  • outputs are descriptions of what to build, such as ISOs.

For the images, you can specify the configuration much like Compose, with some changes, eg capabilities must be specified in full, rather than add and drop, and there are no volumes only binds.

The config is liable to be changed, and there are missing features; full documentation will be available shortly.