Added MOTD that explains how to run an example within the emulator VM
authorpeusterm <manuel.peuster@uni-paderborn.de>
Thu, 9 Jun 2016 00:52:08 +0000 (09:52 +0900)
committerpeusterm <manuel.peuster@uni-paderborn.de>
Thu, 9 Jun 2016 00:52:08 +0000 (09:52 +0900)
README.md
utils/vagrant/motd [new file with mode: 0644]

index b05908a..ba8a769 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -92,3 +92,10 @@ In the `~/son-emu` directory:
 
 ### CLI
 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
+
+### Vagrant VM creation
+A Vagrantfile allows to automatically create and provision a VM in which son-emu is installed and ready to be used.
+
+* `cd ~/son-emu`
+* `vagrant up`
+* `vagrant ssh` to enter the new VM in which the emulator is installed.
diff --git a/utils/vagrant/motd b/utils/vagrant/motd
new file mode 100644 (file)
index 0000000..ea9e8ca
--- /dev/null
@@ -0,0 +1,17 @@
+************************************************************
+**           Welcome to SONATA's son-emu VM               **
+**                 http://sonata-nfv.eu                   **
+**                                                        **
+** To run the emulator with a simple example topology     **
+** and its fake-gatekeeper run the following commands.    **
+**                                                        **
+** Switch to example folder:                              **
+** - cd son-emu/src/emuvim/examples                       **
+**                                                        **
+** Start the emulator with SONATA's example topology:     **
+** - sudo python sonata_y1_demo_topology_1.py             **
+**                                                        **
+** The emulator will be started and the fake-gatekeeper   **
+** API will be accessible on port 5000 from both, the     **
+** VM and your host machine.                              **
+************************************************************
\ No newline at end of file