Merge pull request #33 from kinvolk/alban/goals

README.md: add goals and architecture image
SAP-archive · Dec 19, 2018 · 9eb62ce · 9eb62ce
2 parents 886722d + 671ddc4
commit 9eb62ce
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,17 @@
 
 Status: alpha, work in progress
 
+karydia is a security add-on to Kubernets to help with good security practices
+and assist administrators in keeping their clusters safe. Is is implemented as
+[webhook admission
+controllers](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/)
+and configurable through its command line interface and Kubernetes resources.
+
+While it has been written with [Gardener](https://gardener.cloud/) in mind, it
+can be used on any Kubernetes cluster.
+
+![](karydia-architecture.png)
+
 ## Installing karydia
 
 See [installing karydia](docs/install.md).

diff --git a/karydia-architecture.png b/karydia-architecture.png