From c698e66797bad69b4c77b26b487bf8322989beb0 Mon Sep 17 00:00:00 2001
From: Michael Hwang <mhwang@research.att.com>
Date: Tue, 12 Nov 2019 16:04:20 -0500
Subject: Copy dcae-cli->onboardingapi, copy component specs

Issue-ID: DCAEGEN2-1860
Change-Id: I4805398c76479fad51cbdb74470ccc8f706ce9dc
Signed-off-by: Michael Hwang <mhwang@research.att.com>
---
 mod/onboardingapi/resources/README.md | 39 +++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 mod/onboardingapi/resources/README.md

(limited to 'mod/onboardingapi/resources')

diff --git a/mod/onboardingapi/resources/README.md b/mod/onboardingapi/resources/README.md
new file mode 100644
index 0000000..d3619ea
--- /dev/null
+++ b/mod/onboardingapi/resources/README.md
@@ -0,0 +1,39 @@
+# Resources
+
+## `config.json`
+
+To be used to distribute backend configuration information like the onboarding database connection information to end users of dcae-cli.
+
+```
+curl -v --user <user>:<password> https://<your file server host>/dcae-cli/config.json --upload-file config.json
+```
+
+### Format
+
+```
+{
+    "active_profile": <active profile option>,
+    "db_url": <onboarding catalog database connection>
+}
+```
+
+## `profiles.json`
+
+To be used to distribute platform team approved environment profiles to end users of dcae-cli.
+
+```
+curl -v --user <user>:<password> https://<your file server host>/dcae-cli/profiles.json --upload-file profiles.json
+```
+
+### Format
+
+```
+{
+    "env-name": {
+        "docker_host": <docker hostname:port>,
+        "cdap_broker": <cdap broker consul name>,
+        "consul_host": <consul hostname>,
+        "config_binding_service": <config binding service consul name>
+    }
+}
+```
-- 
cgit 1.2.3-korg