Skip to content

Commit 6f4a4b4

Browse files
author
Ian Campbell
committed
Tailor README.md and CONTRIBUTING.md for split repository.
Signed-off-by: Ian Campbell <[email protected]>
1 parent c46e492 commit 6f4a4b4

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Contributing to LinuxKit
1+
# Contributing to LinuxKit/Kubernetes
22

33
Want to hack on this project? Awesome! Here are instructions to get you started.
44

5-
Additional information can be found in the docs:
5+
Additional information can be found in the docs of the main LinuxKit project:
66
[issue triage](https://github.com/linuxkit/linuxkit/blob/master/docs/issue-triage.md),
77
and [review process](https://github.com/linuxkit/linuxkit/blob/master/docs/reviewing.md).
88

README.md

+24-4
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,38 @@
22

33
This project aims to demonstrate how one can create minimal and immutable Kubernetes OS images with LinuxKit.
44

5-
Make sure to `cd projects/kubernetes` first.
5+
## Build requirements
66

7-
Build OS images:
7+
To build images you will need the [Moby tool](https://github.com/moby/tool), and to rebuild the individual packages you will need the [LinuxKit tool](https://github.com/linuxkit/linuxkit/tree/master/src/cmd/linuxkit)
8+
9+
If you already have `go` installed you can use `go get -u github.com/moby/tool/cmd/moby` to install the `moby` build tool, and `go get -u github.com/linuxkit/linuxkit/src/cmd/linuxkit` to install the `linuxkit` tool.
10+
11+
On MacOS there is a `brew tap` available. Detailed instructions are at [linuxkit/homebrew-linuxkit](https://github.com/linuxkit/homebrew-linuxkit), the short summary is
12+
```
13+
brew tap linuxkit/linuxkit
14+
brew install --HEAD moby
15+
brew install --HEAD linuxkit
16+
```
17+
18+
Build requirements from source:
19+
- GNU `make`
20+
- Docker
21+
- optionally `qemu`
22+
23+
## Building OS images
24+
25+
To build the default OS images:
826
```
9-
make build-vm-images
27+
make all
1028
```
1129

1230
By default this will build images using Docker Engine for execution. To instead use cri-containerd use:
1331
```
14-
make build-vm-images KUBE_RUNTIME=cri-containerd
32+
make all KUBE_RUNTIME=cri-containerd
1533
```
1634

35+
## Booting and initialising OS images
36+
1737
Boot Kubernetes master OS image using `hyperkit` on macOS: or `qemu` on Linux:
1838
```
1939
./boot.sh

0 commit comments

Comments
 (0)