summaryrefslogtreecommitdiffstats
path: root/consul-loader-container/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'consul-loader-container/README.md')
-rw-r--r--consul-loader-container/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/consul-loader-container/README.md b/consul-loader-container/README.md
new file mode 100644
index 0000000..f3869d7
--- /dev/null
+++ b/consul-loader-container/README.md
@@ -0,0 +1,11 @@
+# DCAE Consul Loader Container
+
+The Dockerfile in this directory builds an image that can be used to spin up a container (typical a Kubernetes init container) that can load
+service registrations and key-value pairs into a Consul instance. This capability supports moving certain DCAE platform components from
+deployment using a Cloudify blueprint and the ONAP Kubernetes plugin to a Helm-based deployment. An init container can do the Consul
+setup previously handled by the ONAP Kubernetes plugin and the ONAP DCAE bootstrap script.
+
+The entrypoint for the container is the script `consul_store.sh`. See the documentation for `consul_store.sh` to see how to provide arguments to the script
+as well as how to use environment variables to set the Consul API protocol, host, and port.
+
+Note that the container runs the script to completion. It is not intended to be a long-running service. \ No newline at end of file