Add a section on using with minikube
@@ -22,6 +22,7 @@ Embrace the inevitable failure. __Embrace The Seal__.
- [Label mode](#label-mode)
- [Demo mode](#demo-mode)
- [Setup](#setup)
+ - [Minikube setup](#minikube-setup)
- [Getting started](#getting-started)
- [Testing](#testing)
- [Read about the PowerfulSeal](#read-about-the-powerfulseal)
@@ -416,6 +417,66 @@ These interactions are available:
![pipeline](./media/setup.png)
+
+### Minikube setup
+
+It is possible to test a subset of Seal's functionality using a [`minikube`](https://kubernetes.io/docs/setup/minikube/) setup.
+
+To achieve that, please inspect the [Makefile](./Makefile). You will need to override the ssh host, specify the correct username and use minikube's ssh keys.
+
+
+If you'd like to test out the interactive mode, start with this:
+
+```sh
+seal \
+ -vv \
+ interactive \
+ --no-cloud \
+ --inventory-kubernetes \
+ --ssh-allow-missing-host-keys \
+ --remote-user docker \
+ --ssh-path-to-private-key `minikube ssh-key` \
+ --override-ssh-host `minikube ip`
+```
+
+For label mode, try something like this:
+
+```sh
+seal \
+ -vv \
+ label \
+ --no-cloud \
+ --min-seconds-between-runs 3 \
+ --max-seconds-between-runs 10 \
+ --inventory-kubernetes \
+ --ssh-allow-missing-host-keys \
+ --remote-user docker \
+ --ssh-path-to-private-key `minikube ssh-key` \
+ --override-ssh-host `minikube ip`
+```
+
+For autonomous mode, this should get you started:
+
+```sh
+seal \
+ -vv \
+ autonomous \
+ --no-cloud \
+ --policy-file ./examples/policy_kill_random_default.yml \
+ --inventory-kubernetes \
+ --prometheus-collector \
+ --prometheus-host 0.0.0.0 \
+ --prometheus-port 9999 \
+ --ssh-allow-missing-host-keys \
+ --remote-user docker \
+ --ssh-path-to-private-key `minikube ssh-key` \
+ --override-ssh-host `minikube ip` \
+ --host 0.0.0.0 \
+ --port 30100
+```
+
+
+
## Getting started
`PowerfulSeal` is available to install through pip:
