Merge pull request #127 from hadik3r/master
[osm/vim-emu.git] / src / emuvim / examples / monitoring_demo_topology_restapi.py
1 """
2 This is an example topology for the distributed cloud emulator (dcemulator).
3 (c) 2015 by Manuel Peuster <manuel.peuster@upb.de>
4
5
6 This is an example that shows how a user of the emulation tool can
7 define network topologies with multiple emulated cloud data centers.
8
9 The definition is done with a Python API which looks very similar to the
10 Mininet API (in fact it is a wrapper for it).
11
12 We only specify the topology *between* data centers not within a single
13 data center (data center internal setups or placements are not of interest,
14 we want to experiment with VNF chains deployed across multiple PoPs).
15
16 The original Mininet API has to be completely hidden and not be used by this
17 script.
18 """
19 import logging
20 from mininet.log import setLogLevel
21 from emuvim.dcemulator.net import DCNetwork
22
23 from emuvim.api.rest.rest_api_endpoint import RestApiEndpoint
24
25 from emuvim.api.zerorpc.compute import ZeroRpcApiEndpoint
26 from emuvim.api.zerorpc.network import ZeroRpcApiEndpointDCNetwork
27
28
29 logging.basicConfig(level=logging.INFO)
30
31
32 def create_topology1():
33 """
34 1. Create a data center network object (DCNetwork) with monitoring enabled
35 """
36 net = DCNetwork(monitor=True, enable_learning=False)
37
38 """
39 1b. Add endpoint APIs for the whole DCNetwork,
40 to access and control the networking from outside.
41 e.g., to setup forwarding paths between compute
42 instances aka. VNFs (represented by Docker containers), passing through
43 different switches and datacenters of the emulated topology
44 """
45 mon_api = ZeroRpcApiEndpointDCNetwork("0.0.0.0", 5151)
46 mon_api.connectDCNetwork(net)
47 mon_api.start()
48
49 """
50 2. Add (logical) data centers to the topology
51 (each data center is one "bigswitch" in our simplified
52 first prototype)
53 """
54 dc1 = net.addDatacenter("datacenter1")
55 dc2 = net.addDatacenter("datacenter2")
56
57 """
58 3. You can add additional SDN switches for data center
59 interconnections to the network.
60 """
61 s1 = net.addSwitch("s1")
62
63 """
64 4. Add links between your data centers and additional switches
65 to define you topology.
66 These links can use Mininet's features to limit bw, add delay or jitter.
67 """
68
69 net.addLink(dc1, s1)
70 net.addLink(s1, dc2)
71
72
73 """
74 5. We want to access and control our data centers from the outside,
75 e.g., we want to connect an orchestrator to start/stop compute
76 resources aka. VNFs (represented by Docker containers in the emulated)
77
78 So we need to instantiate API endpoints (e.g. a zerorpc or REST
79 interface). Depending on the endpoint implementations, we can connect
80 one or more data centers to it, which can then be controlled through
81 this API, e.g., start/stop/list compute instances.
82 """
83 # keep the old zeroRPC interface for the prometheus metric query test
84 zapi1 = ZeroRpcApiEndpoint("0.0.0.0", 4242)
85 # connect data centers to this endpoint
86 zapi1.connectDatacenter(dc1)
87 zapi1.connectDatacenter(dc2)
88 # run API endpoint server (in another thread, don't block)
89 zapi1.start()
90
91 # create a new instance of a endpoint implementation
92 api1 = RestApiEndpoint("0.0.0.0", 5000)
93 # connect data centers to this endpoint
94 api1.connectDatacenter(dc1)
95 api1.connectDatacenter(dc2)
96 # connect total network also, needed to do the chaining and monitoring
97 api1.connectDCNetwork(net)
98 # run API endpoint server (in another thread, don't block)
99 api1.start()
100
101 """
102 5.1. For our example, we create a second endpoint to illustrate that
103 this is supported by our design. This feature allows us to have
104 one API endpoint for each data center. This makes the emulation
105 environment more realistic because you can easily create one
106 OpenStack-like REST API endpoint for *each* data center.
107 This will look like a real-world multi PoP/data center deployment
108 from the perspective of an orchestrator.
109 """
110 #zapi2 = ZeroRpcApiEndpoint("0.0.0.0", 4343)
111 #zapi2.connectDatacenter(dc3)
112 #zapi2.connectDatacenter(dc4)
113 #zapi2.start()
114
115 """
116 6. Finally we are done and can start our network (the emulator).
117 We can also enter the Mininet CLI to interactively interact
118 with our compute resources (just like in default Mininet).
119 But we can also implement fully automated experiments that
120 can be executed again and again.
121 """
122 net.start()
123 net.CLI()
124 # when the user types exit in the CLI, we stop the emulator
125 net.stop()
126
127
128 def main():
129 setLogLevel('info') # set Mininet loglevel
130 create_topology1()
131
132
133 if __name__ == '__main__':
134 main()