Add README for st2web-enterprise Helm chart component

StackStorm · Aug 23, 2018 · 44189af · 44189af
1 parent 6c87b24
commit 44189af
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/.helmignore b/.helmignore
@@ -19,3 +19,4 @@
 .project
 .idea/
 *.tmproj
+
diff --git a/README.md b/README.md
@@ -1 +1,13 @@
-helm repo update
+# `stackstorm-enterprise-ha` Helm Chart
+StackStorm Enterprise K8s Helm Chart, optimized for running StackStorm in HA environment.
+
+To install the chart:
+```
+helm install .
+```
+For advanced configuration you may need to edit the default settings in `values.yaml`.
+
+## st2web
+By default, st2web includes a Pod Deployment and a Service for st2web Enterprise Web UI.
+Service uses NodePort, so installing this chart will not provision a LoadBalancer or Ingress (TODO!).
+Depending on your Kubernetes cluster configuration you may need to add additional configuration to access the example service.