src/emuvim/examples/monitoring_demo_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
  32 from emuvim.api.rest.rest_api_endpoint import RestApiEndpoint
  33
  34 from emuvim.api.zerorpc.compute import ZeroRpcApiEndpoint
  35 from emuvim.api.zerorpc.network import ZeroRpcApiEndpointDCNetwork
  36
  37
  38 logging.basicConfig(level=logging.INFO)
  39
  40
  41 def create_topology1():
  42     """
  43     1. Create a data center network object (DCNetwork) with monitoring enabled
  44     """
  45     net = DCNetwork(monitor=True, enable_learning=False)
  46
  47     """
  48     1b. Add endpoint APIs for the whole DCNetwork,
  49         to access and control the networking from outside.
  50         e.g., to setup forwarding paths between compute
  51         instances aka. VNFs (represented by Docker containers), passing through
  52         different switches and datacenters of the emulated topology
  53     """
  54     # create monitoring api endpoint for backwards compatibility with zerorpc api
  55     mon_api = ZeroRpcApiEndpointDCNetwork("0.0.0.0", 5151)
  56     mon_api.connectDCNetwork(net)
  57     mon_api.start()
  58
  59     """
  60     2. Add (logical) data centers to the topology
  61        (each data center is one "bigswitch" in our simplified
  62         first prototype)
  63     """
  64     dc1 = net.addDatacenter("datacenter1")
  65     dc2 = net.addDatacenter("datacenter2")
  66
  67     """
  68     3. You can add additional SDN switches for data center
  69        interconnections to the network.
  70     """
  71     s1 = net.addSwitch("s1")
  72
  73     """
  74     4. Add links between your data centers and additional switches
  75        to define you topology.
  76        These links can use Mininet's features to limit bw, add delay or jitter.
  77     """
  78
  79     net.addLink(dc1, s1)
  80     net.addLink(s1, dc2)
  81
  82
  83     """
  84     5. We want to access and control our data centers from the outside,
  85        e.g., we want to connect an orchestrator to start/stop compute
  86        resources aka. VNFs (represented by Docker containers in the emulated)
  87
  88        So we need to instantiate API endpoints (e.g. a zerorpc or REST
  89        interface). Depending on the endpoint implementations, we can connect
  90        one or more data centers to it, which can then be controlled through
  91        this API, e.g., start/stop/list compute instances.
  92     """
  93     # keep the old zeroRPC interface for the prometheus metric query test
  94     zapi1 = ZeroRpcApiEndpoint("0.0.0.0", 4242)
  95     # connect data centers to this endpoint
  96     zapi1.connectDatacenter(dc1)
  97     zapi1.connectDatacenter(dc2)
  98     # run API endpoint server (in another thread, don't block)
  99     zapi1.start()
 100
 101     # create a new instance of a endpoint implementation
 102     # the restapi handles all compute, networking and monitoring commands in one api endpoint
 103     api1 = RestApiEndpoint("0.0.0.0", 5001)
 104     # connect data centers to this endpoint
 105     api1.connectDatacenter(dc1)
 106     api1.connectDatacenter(dc2)
 107     # connect total network also, needed to do the chaining and monitoring
 108     api1.connectDCNetwork(net)
 109     # run API endpoint server (in another thread, don't block)
 110     api1.start()
 111
 112     """
 113     5.1. For our example, we create a second endpoint to illustrate that
 114          this is supported by our design. This feature allows us to have
 115          one API endpoint for each data center. This makes the emulation
 116          environment more realistic because you can easily create one
 117          OpenStack-like REST API endpoint for *each* data center.
 118          This will look like a real-world multi PoP/data center deployment
 119          from the perspective of an orchestrator.
 120     """
 121     #zapi2 = ZeroRpcApiEndpoint("0.0.0.0", 4343)
 122     #zapi2.connectDatacenter(dc3)
 123     #zapi2.connectDatacenter(dc4)
 124     #zapi2.start()
 125
 126     """
 127     6. Finally we are done and can start our network (the emulator).
 128        We can also enter the Mininet CLI to interactively interact
 129        with our compute resources (just like in default Mininet).
 130        But we can also implement fully automated experiments that
 131        can be executed again and again.
 132     """
 133     net.start()
 134     net.CLI()
 135     # when the user types exit in the CLI, we stop the emulator
 136     net.stop()
 137
 138
 139 def main():
 140     setLogLevel('info')  # set Mininet loglevel
 141     create_topology1()
 142
 143
 144 if __name__ == '__main__':
 145     main()