Merge pull request #222 from edmaas/master

[osm/vim-emu.git] / src / emuvim / api / sonata / README.md

diff --git a/src/emuvim/api/sonata/README.md b/src/emuvim/api/sonata/README.md
old mode 100644 (file)
new mode 100755 (executable)
index 30586e7..d662f1e
--- a/src/emuvim/api/sonata/README.md
+++ b/src/emuvim/api/sonata/README.md
@@ -20,9 +20,9 @@ The example starts a small network with two data centers.
 
 ## Upload a package (*.son) file:
 
-To upload the file `sonata-demo.son` (from son-schema repo) do:
+To upload the file `sonata-demo-docker.son` (can be found in `son-emu/misc/`) do:
 
-* `curl -i -X POST -F package=@sonata-demo.son http://127.0.0.1:5000/packages`
+* `curl -i -X POST -F package=@sonata-demo-docker.son http://127.0.0.1:5000/packages`
 
 To list all uploaded packages do:
 
@@ -37,6 +37,15 @@ To list all running services do:
 
 * `curl http://127.0.0.1:5000/instantiations`
 
+## VNF Requirements
+
+A VNF container that is used with the dummy gatekeeper should specify a emulator specific entrypoint script in its Dockerfile:
+
+* `ENV SON_EMU_CMD ./start.sh`
+
+This script is called by the dummy gatekeeper after a VNF was started and the chaining was done. The script can then be used to trigger the execution of individual VNF software.
+
+ATTENTION: The specified script must not block!
 
 ## API definition