Add docker-compose.yml

[ccsdk/distribution.git] / src / main / yaml / README.md

diff --git a/src/main/yaml/README.md b/src/main/yaml/README.md
new file mode 100644 (file)
index 0000000..6e536a6
--- /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)