Add k8s bootstrap container

Change-Id: Ib21bd80a1e43d1005974527cecf93e99462e94fa
Issue-ID: DCAEGEN2-421
Signed-off-by: Jack Lucas <jflucas@research.att.com>

1 files changed, 20 insertions, 0 deletions

diff --git a/k8s-bootstrap-container/README.md b/k8s-bootstrap-container/README.md
new file mode 100644
index 0000000..614669b
--- /dev/null
+++ b/k8s-bootstrap-container/README.md
@@ -0,0 +1,20 @@
+# DCAE Bootstrap Container
+This container is responsible for loading plugins and wagons onto the
+DCAE Cloudify Manager instance and for launching DCAE components.
+
+The script builds plugins and loads blueprints for the DCAE components
+to be deployed into the container image
+at image build time.   At run time, the main script in the container
+(`bootstrap.sh`) uploads the plugins to Cloudify Manager, then installs
+components using the blueprints.
+
+The container expects to be started with two environment variables:
+  - `CMADDR` -- the address of the target Cloudify Manager
+  - `CMPASS` -- the password for Cloudify Manager
+
+The container expects input files to use when deploying the blueprints.
+It expects to find them in /inputs.   The normal method for launching
+the container is via a Helm Chart launched by OOM.  That chart creates
+a Kubernetes ConfigMap containing the input files.  The ConfigMap is 
+mounted as a volume at /inputs.
+