1 [![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
3 # Distributed Cloud Emulator
6 The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
8 * Manuel Peuster (mpeuster)
9 * Steven Van Rossem (stevenvanrossem)
13 * Latest [Containernet](https://github.com/mpeuster/containernet) installed on the system
16 * pyaml (public domain)
18 * tabulate (public domain)
19 * argparse (Python software foundation license)
23 * oslo.config (Apache 2.0)
28 * requests (Apache 2.0)
29 * docker-py (Apache 2.0)
31 ### 3rd-party code used
37 * **src/emuvim/** all emulator code
38 * **api/** Data center API endpoint implementations (zerorpc, OpenStack REST, ...)
39 * **cli/** CLI client to interact with a running emulator
40 * **dcemulator/** Dockernet wrapper that introduces the notion of data centers and API endpoints
41 * **examples/** Example topology scripts
42 * **test/** Unit tests
43 * **ansible/** Ansible install scripts
44 * **util/** helper scripts
47 Automatic installation is provide through Ansible playbooks.
49 * Requires: Ubuntu 14.04 LTS
50 * `sudo apt-get install ansible git`
51 * `sudo vim /etc/ansible/hosts`
52 * Add: `localhost ansible_connection=local`
56 * `git clone -b dockernet-sonata https://github.com/mpeuster/dockernet.git`
57 * `cd ~/dockernet/ansible`
58 * `sudo ansible-playbook install.yml`
59 * Wait (and have a coffee) ...
62 * Fork the repository.
64 * `git clone https://github.com/<user>/son-emu.git`
65 * `cd ~/son-emu/ansible`
66 * `sudo ansible-playbook install.yml`
71 In the `~/son-emu` directory:
74 * `python setup.py develop`
75 * Otherwise, for a classic installation:
76 * `python setup.py install`
78 * `sudo python src/emuvim/examples/simple_topology.py
81 * `son-emu-cli compute start -d datacenter1 -n vnf1`
82 * `son-emu-cli compute start -d datacenter1 -n vnf2`
83 * `son-emu-cli compute list`
85 * `dockernet> vnf1 ping -c 2 vnf2`
87 * `son-emu-cli monitor get_rate -vnf vnf1`
91 * `sudo py.test -v src/emuvim` (equivalent to `python setup.py test -v --addopts 'src/emuvim'` but with direct access to the commandline arguments)
94 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)