Skip to content
This repository was archived by the owner on Jan 21, 2020. It is now read-only.

Commit 0ccd281

Browse files
author
David Chung
authored
Documentation update (#564)
Signed-off-by: David Chung <[email protected]> * Update links Signed-off-by: David Chung <[email protected]>
1 parent d30f4bf commit 0ccd281

File tree

4 files changed

+263
-61
lines changed

4 files changed

+263
-61
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,19 @@ InfraKit
66
[![codecov.io](https://codecov.io/github/docker/infrakit/coverage.svg?branch=master&token=z08ZKeIJfA)](https://codecov.io/github/docker/infrakit?branch=master)
77

88
_InfraKit_ is a toolkit for creating and managing declarative, self-healing infrastructure.
9-
It breaks infrastructure automation down into simple, pluggable components. These components work together to actively
10-
ensure the infrastructure state matches the user's specifications.
11-
Although _InfraKit_ emphasizes primitives for building self-healing infrastructure, it also can be used passively like
12-
conventional tools.
9+
It breaks infrastructure automation down into simple, pluggable components.
10+
These components work together to actively ensure the infrastructure state matches the user's specifications.
1311

14-
To get started, try the [tutorial](docs/tutorial.md).
12+
To get started, try the [tutorial](docs/tutorial.md), or check out the video below:
13+
14+
### InfraKit + [LinuxKit](https://github.com/linuxkit/linuxkit) POC
15+
16+
[![infrakit+linuxkit](./docs/images/infrakit_linuxkit_screencap.png)](https://www.youtube.com/watch?v=j50ovfRWpZM "InfraKit + LinuxKit")
17+
18+
In this video, InfraKit is used to build a custom linux operating system (based on [linuxkit](https://github.com/linuxkit/linuxkit))
19+
and deploy a cluster of virtual machine instances from a local Mac laptop to a bare-metal ARM server running on [Packet.net](https://packet.net).
20+
It demonstrates some of the key concepts and components in InfraKit and shows how InfraKit can be used to implement an integrated
21+
workflow from custom OS image creation to cluster deployment and Day N management.
1522

1623
### Who InfraKit is for
1724

452 KB
Loading

docs/playbooks/linuxkit/README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,46 @@
11
LinuxKit Playbook
22
=================
33

4-
This is a demo playbook for working with LinuxKit.
4+
This is a demo playbook for working with LinuxKit.
5+
6+
## How to Add
7+
8+
1. Make sure you have the `infrakit` CLI installed --
9+
+ Either build from source (see [tutorial](../../tutorial.md)), or
10+
+ Use built containers and cross-compile locally -- see [Quick Start](../README.md).
11+
12+
2. Add via the `playbook` command:
13+
14+
```shell
15+
$ infrakit playbook add linuxkit https://docker.github.io/infrakit/playbooks/linuxkit/index.yml
16+
$ infrakit playbook ls
17+
PLAYBOOK URL
18+
linuxkit https://docker.github.io/infrakit/playbooks/linuxkit/index.yml
19+
```
20+
21+
The URL `https://docker.github.io/infrakit/playbooks/linuxkit/index.yml` is for the file `index.yml`
22+
that is being served by github pages. If you cloned the repo, you can speed up things by referencing
23+
a local file via the `file://` scheme in the URL.
24+
25+
Now verify:
26+
```shell
27+
$ infrakit playbook linuxkit -h
28+
29+
30+
linuxkit
31+
32+
Usage:
33+
infrakit playbook linuxkit [command]
34+
35+
Available Commands:
36+
demo-sshd demo-sshd
37+
install-hyperkit install-hyperkit
38+
install-moby install-moby
39+
run-gcp run-gcp
40+
run-hyperkit run-hyperkit
41+
run-packet run-packet
42+
start start
43+
stop stop
44+
```
45+
46+
This playbook assumes you're running on a Mac, using Docker for Mac as the runtime for running the InfraKit plugins.

0 commit comments

Comments
 (0)