Skip to content

Commit

Permalink
Update README for micro-demos
Browse files Browse the repository at this point in the history
Also remove kubectl script, which should not have been committed.
  • Loading branch information
thockin committed Nov 8, 2017
1 parent d978838 commit d268bec
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 9 deletions.
36 changes: 30 additions & 6 deletions micro-demos/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,34 @@
# kube-demos
Kubernetes demos
# Kubernetes micro-demos

To run these demos you need 'pv' and 'tmux' installed.
This is a collection of highly-targetted demonstrations of Kubernetes features.
The demos are all text-based and automated, making them perfect for customer
meetings, meetups, or just showing off to your colleagues.

To make best use of these demos:
## Running the demos

SSH to your kubernetes-master and set the following flags (in this order):
* kube-controllermanager: --pod-eviction-timeout=10s
To run these demos you need `pv` and `tmux` installed, and you need `kubectl`
in your PATH.

Some of the demos try to act in faster-than-real time. For best results:
* SSH to your kubernetes-master and set the following flags (in this order):
* kube-controllermanager: --pod-eviction-timeout=10s

Before running a demo, make sure your cluster is demo-ready. The `reset.sh`
script is provided for that.

## Writing new demos

Each demo lives in its own directory. The bulk of the logic lives in
`util.sh`.

Demos should be small and focused - 2 to 3 minutes each.

Demos should be repeatable. Make sure you are not relying on timing effects.
If you need to `sleep`, you might have a problem.

Demos should be self-contained. If you are depending on something being done
before-hand, don't. Do it in the demo script.

Demos should be single-terminal. Use `tmux` to split the window to show
multiple parallel things.

3 changes: 0 additions & 3 deletions micro-demos/kubectl

This file was deleted.

0 comments on commit d268bec

Please sign in to comment.