X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=eefb97c952c4faf12d83a0c07137b801c80859a6;hb=e26487ba6b33c22a1e3f5f843364df9f0efc07eb;hp=e2b66587dda3de27046048fd928cfeb40587a714;hpb=3eef9fde234a4379d80e0435bac9ce650407a895;p=osm%2Fvim-emu.git diff --git a/README.md b/README.md index e2b6658..eefb97c 100755 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # Distributed Cloud Emulator -Contributors: +Lead developers (able to merge pull requests): * Manuel Peuster +* Steven Van Rossem ### Requirements @@ -43,26 +44,32 @@ Automatic installation is provide through Ansible playbooks. ### Run + +In the `~/son-emu` directory: + +* During development: + * `python setup.py develop` +* Otherwise, for a classic installation: + * `python setup.py install` * First terminal: - * `cd ~/son-emu/src/emuvim` - * `sudo python example_topology.py` + * `sudo python src/emuvim/examples/simple_topology.py +` * Second terminal: - * `cd ~/son-emu/src/emuvim/cli` - * `./son-emu-cli compute start -d datacenter1 -n vnf1` - * `./son-emu-cli compute start -d datacenter1 -n vnf2` - * `./son-emu-cli compute list` + * `son-emu-cli compute start -d datacenter1 -n vnf1` + * `son-emu-cli compute start -d datacenter1 -n vnf2` + * `son-emu-cli compute list` * First terminal: * `dockernet> vnf1 ping -c 2 vnf2` * Second terminal: - * `./son-emu-cli monitor get_rate -vnf vnf1` + * `son-emu-cli monitor get_rate -vnf vnf1` #### Example scripts: * `./start_dcnetwork` starts an example datacenter network with monitoring api endpoint * `./start_example_chain` sets up an example service chain, using the example docker container from `package_samples` https://github.com/sonata-nfv/packaging_samples/tree/master/VNFs ### Run Unit Tests -* `cd ~/son-emu/src/emuvim` -* `sudo python test` or `sudo python test -v` for more outputs +* `cd ~/son-emu` +* `sudo py.test -v src/emuvim` (equivalent to `python setup.py test -v --addopts 'src/emuvim'` but with direct access to the commandline arguments) ### CLI * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)