Merge pull request #133 from mpeuster/master
[osm/vim-emu.git] / src / emuvim / examples / simple_topology_restapi.py
1 """
2 Copyright (c) 2015 SONATA-NFV
3 ALL RIGHTS RESERVED.
4
5 Licensed under the Apache License, Version 2.0 (the "License");
6 you may not use this file except in compliance with the License.
7 You may obtain a copy of the License at
8
9 http://www.apache.org/licenses/LICENSE-2.0
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16
17 Neither the name of the SONATA-NFV [, ANY ADDITIONAL AFFILIATION]
18 nor the names of its contributors may be used to endorse or promote
19 products derived from this software without specific prior written
20 permission.
21
22 This work has been performed in the framework of the SONATA project,
23 funded by the European Commission under Grant number 671517 through
24 the Horizon 2020 and 5G-PPP programmes. The authors would like to
25 acknowledge the contributions of their colleagues of the SONATA
26 partner consortium (www.sonata-nfv.eu).
27 """
28 import logging
29 from mininet.log import setLogLevel
30 from emuvim.dcemulator.net import DCNetwork
31 from emuvim.api.rest.rest_api_endpoint import RestApiEndpoint
32
33 from emuvim.api.zerorpc.compute import ZeroRpcApiEndpoint
34 from emuvim.api.zerorpc.network import ZeroRpcApiEndpointDCNetwork
35
36 logging.basicConfig(level=logging.INFO)
37
38
39 def create_topology1():
40 """
41 1. Create a data center network object (DCNetwork)
42 """
43 net = DCNetwork(monitor=True, enable_learning=True)
44
45 """
46 1b. add a monitoring agent to the DCNetwork
47 """
48 #keep old zeroRPC interface to test the prometheus metric query
49 mon_api = ZeroRpcApiEndpointDCNetwork("0.0.0.0", 5151)
50 mon_api.connectDCNetwork(net)
51 mon_api.start()
52 """
53 2. Add (logical) data centers to the topology
54 (each data center is one "bigswitch" in our simplified
55 first prototype)
56 """
57 dc1 = net.addDatacenter("datacenter1")
58 dc2 = net.addDatacenter("datacenter2")
59 dc3 = net.addDatacenter("long_data_center_name3")
60 dc4 = net.addDatacenter(
61 "datacenter4",
62 metadata={"mydata": "we can also add arbitrary metadata to each DC"})
63
64 """
65 3. You can add additional SDN switches for data center
66 interconnections to the network.
67 """
68 s1 = net.addSwitch("s1")
69
70 """
71 4. Add links between your data centers and additional switches
72 to define you topology.
73 These links can use Mininet's features to limit bw, add delay or jitter.
74 """
75 net.addLink(dc1, dc2)
76 net.addLink("datacenter1", s1)
77 net.addLink(s1, dc3)
78 net.addLink(s1, "datacenter4")
79
80 """
81 5. We want to access and control our data centers from the outside,
82 e.g., we want to connect an orchestrator to start/stop compute
83 resources aka. VNFs (represented by Docker containers in the emulated)
84
85 So we need to instantiate API endpoints (e.g. a zerorpc or REST
86 interface). Depending on the endpoint implementations, we can connect
87 one or more data centers to it, which can then be controlled through
88 this API, e.g., start/stop/list compute instances.
89 """
90 # keep the old zeroRPC interface for the prometheus metric query test
91 zapi1 = ZeroRpcApiEndpoint("0.0.0.0", 4242)
92 # connect data centers to this endpoint
93 zapi1.connectDatacenter(dc1)
94 zapi1.connectDatacenter(dc2)
95 # run API endpoint server (in another thread, don't block)
96 zapi1.start()
97
98 # create a new instance of a endpoint implementation
99 api1 = RestApiEndpoint("127.0.0.1", 5001)
100 # connect data centers to this endpoint
101 api1.connectDatacenter(dc1)
102 api1.connectDatacenter(dc2)
103 api1.connectDatacenter(dc3)
104 api1.connectDatacenter(dc4)
105 # connect total network also, needed to do the chaining and monitoring
106 api1.connectDCNetwork(net)
107 # run API endpoint server (in another thread, don't block)
108 api1.start()
109
110 """
111 6. Finally we are done and can start our network (the emulator).
112 We can also enter the Mininet CLI to interactively interact
113 with our compute resources (just like in default Mininet).
114 But we can also implement fully automated experiments that
115 can be executed again and again.
116 """
117 net.start()
118 net.CLI()
119 # when the user types exit in the CLI, we stop the emulator
120 net.stop()
121
122
123 def main():
124 setLogLevel('info') # set Mininet loglevel
125 create_topology1()
126
127
128 if __name__ == '__main__':
129 main()