summaryrefslogtreecommitdiffstats
path: root/src/main/yaml/README.md
diff options
context:
space:
mode:
authorDan Timoney <dtimoney@att.com>2017-09-05 12:37:04 -0400
committerDan Timoney <dtimoney@att.com>2017-09-05 12:37:13 -0400
commitd462aa59d784a8697b430fc1f641c92311993f99 (patch)
tree2a146405707aa58e934a03a5b36f224f060fe9b7 /src/main/yaml/README.md
parent1ea29657dc84d7f7b15b8d9ffce625985db0127e (diff)
Add docker-compose.yml
Add docker-compose.yml to bring up CCSDK docker containers for troubleshooting purposes. Change-Id: Ic0393621d568b52a06d3cdf958ae60dc10afbaca Issue-ID: CCSDK-76 Signed-off-by: Dan Timoney <dtimoney@att.com>
Diffstat (limited to 'src/main/yaml/README.md')
-rw-r--r--src/main/yaml/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/main/yaml/README.md b/src/main/yaml/README.md
new file mode 100644
index 00000000..6e536a60
--- /dev/null
+++ b/src/main/yaml/README.md
@@ -0,0 +1,10 @@
+This directory contains a docker-compose.yml that is intended for
+use by CCSDK developers to test and debug issues with the CCSDK
+docker containers.
+
+Please note that these containers are NOT intended to be used as standalone
+containers, with interface to other ONAP components. Rather, they are intended
+to be used as bases for other containers (e.g. odlsli is the container
+that SDN-C and APP-C would base their controller containers on), or as
+development environments (e.g. the dgbuilder container is a development
+tool for editing directed graphs)