Update README

README.md

@@ -1,4 +1,12 @@
-This repo is for creating container and virtual machine images using Packer.
+This repo contains useful tools used in CI workflows at Zepben.
+
+# Local K8s
+
+Local Kind cluster tooling used for development as well as shared helm repos. See [README](local-k8s/README.md).
+
+# Pipelines
+
+Creating container and virtual machine images using Packer.
 
 #### Tools needed
 1. [Packer](https://www.packer.io/downloads.html)

local-k8s/README.md

@@ -1,4 +1,31 @@
 # Local K8s
 
-Reusable kubernetes cluster for development. Requires kind installed https://kind.sigs.k8s.io/docs/user/quick-start/.
+Reusable kubernetes cluster for development and CI. Requires kind installed https://kind.sigs.k8s.io/docs/user/quick-start/.
 
+## Required Files
+
+The tool requires two files:
+
+* kind-cluster.yaml - configures kind. See [example](examples/kind-cluster.yaml).
+* components.yaml - configures dependencies to be installed via helm when creating the kind cluster.
+
+## Development
+
+The Makefile in the root of the project contains some targets for interacting with the the tool. Simply run:
+
+```shell
+make check-local-k8s test-local-k8s
+```
+
+To execute the linters and tests. 
+
+To create a local kind cluster, you can run:
+```shell
+make setup-k8s
+```
+
+Be sure to set the env so kubectl and friends operate as expected:
+
+```shell
+export KUBECONFIG=/tmp/kind-k8s-conf.yaml
+```