Documentation update (docker-archive#564)

Signed-off-by: David Chung <[email protected]> * Update links Signed-off-by: David Chung <[email protected]>
Giovan · May 25, 2017 · 0ccd281 · 0ccd281
1 parent d30f4bf
commit 0ccd281
Show file tree

Hide file tree

Showing 4 changed files with 263 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -6,12 +6,19 @@ InfraKit
 [![codecov.io](https://codecov.io/github/docker/infrakit/coverage.svg?branch=master&token=z08ZKeIJfA)](https://codecov.io/github/docker/infrakit?branch=master)
 
 _InfraKit_ is a toolkit for creating and managing declarative, self-healing infrastructure.
-It breaks infrastructure automation down into simple, pluggable components. These components work together to actively
-ensure the infrastructure state matches the user's specifications.
-Although _InfraKit_ emphasizes primitives for building self-healing infrastructure, it also can be used passively like
-conventional tools.
+It breaks infrastructure automation down into simple, pluggable components.
+These components work together to actively ensure the infrastructure state matches the user's specifications.
 
-To get started, try the [tutorial](docs/tutorial.md).
+To get started, try the [tutorial](docs/tutorial.md), or check out the video below:
+
+### InfraKit + [LinuxKit](https://github.com/linuxkit/linuxkit) POC
+
+[![infrakit+linuxkit](./docs/images/infrakit_linuxkit_screencap.png)](https://www.youtube.com/watch?v=j50ovfRWpZM "InfraKit + LinuxKit")
+
+In this video, InfraKit is used to build a custom linux operating system (based on [linuxkit](https://github.com/linuxkit/linuxkit))
+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).
+It demonstrates some of the key concepts and components in InfraKit and shows how InfraKit can be used to implement an integrated
+workflow from custom OS image creation to cluster deployment and Day N management.
 
 ### Who InfraKit is for
 

diff --git a/docs/images/infrakit_linuxkit_screencap.png b/docs/images/infrakit_linuxkit_screencap.png
diff --git a/docs/playbooks/linuxkit/README.md b/docs/playbooks/linuxkit/README.md
@@ -1,4 +1,46 @@
 LinuxKit Playbook
 =================
 
-This is a demo playbook for working with LinuxKit.
+This is a demo playbook for working with LinuxKit.
+
+## How to Add
+
+1. Make sure you have the `infrakit` CLI installed --
+  + Either build from source (see [tutorial](../../tutorial.md)), or
+  + Use built containers and cross-compile locally -- see [Quick Start](../README.md).
+
+2. Add via the `playbook` command:
+
+```shell
+$ infrakit playbook add linuxkit https://docker.github.io/infrakit/playbooks/linuxkit/index.yml
+$ infrakit playbook ls
+PLAYBOOK                      	URL
+linuxkit                      	https://docker.github.io/infrakit/playbooks/linuxkit/index.yml
+```
+
+The URL `https://docker.github.io/infrakit/playbooks/linuxkit/index.yml` is for the file `index.yml`
+that is being served by github pages.  If you cloned the repo, you can speed up things by referencing
+a local file via the `file://` scheme in the URL.
+
+Now verify:
+```shell
+$ infrakit playbook linuxkit -h
+
+
+linuxkit
+
+Usage:
+  infrakit playbook linuxkit [command]
+
+Available Commands:
+  demo-sshd        demo-sshd
+  install-hyperkit install-hyperkit
+  install-moby     install-moby
+  run-gcp          run-gcp
+  run-hyperkit     run-hyperkit
+  run-packet       run-packet
+  start            start
+  stop             stop
+```
+
+This playbook assumes you're running on a Mac, using Docker for Mac as the runtime for running the InfraKit plugins.