diff options
author | 2019-11-12 16:04:20 -0500 | |
---|---|---|
committer | 2019-12-13 16:46:11 -0500 | |
commit | c698e66797bad69b4c77b26b487bf8322989beb0 (patch) | |
tree | e40a8449728768107e4ab4c1ac506af13230a580 /mod/onboardingapi/resources/README.md | |
parent | 9cb529e42f5625f2fa802e21919b10f814a89ca7 (diff) |
Copy dcae-cli->onboardingapi, copy component specs
Issue-ID: DCAEGEN2-1860
Change-Id: I4805398c76479fad51cbdb74470ccc8f706ce9dc
Signed-off-by: Michael Hwang <mhwang@research.att.com>
Diffstat (limited to 'mod/onboardingapi/resources/README.md')
-rw-r--r-- | mod/onboardingapi/resources/README.md | 39 |
1 files changed, 39 insertions, 0 deletions
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> + } +} +``` |