src/emuvim/examples/simple_topology.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 """
  29 This is an example that shows how a user of the emulation tool can
  30 define network topologies with multiple emulated cloud data centers.
  31
  32 The definition is done with a Python API which looks very similar to the
  33 Mininet API (in fact it is a wrapper for it).
  34
  35 We only specify the topology *between* data centers not within a single
  36 data center (data center internal setups or placements are not of interest,
  37 we want to experiment with VNF chains deployed across multiple PoPs).
  38
  39 The original Mininet API has to be completely hidden and not be used by this
  40 script.
  41 """
  42 import logging
  43 from mininet.log import setLogLevel
  44 from emuvim.dcemulator.net import DCNetwork
  45 from emuvim.api.rest.rest_api_endpoint import RestApiEndpoint
  46 from mininet.node import RemoteController
  47
  48 logging.basicConfig(level=logging.INFO)
  49
  50
  51 def create_topology1():
  52     """
  53     1. Create a data center network object (DCNetwork)
  54     """
  55     net = DCNetwork(controller=RemoteController, monitor=False, enable_learning=True)
  56
  57     """
  58     2. Add (logical) data centers to the topology
  59        (each data center is one "bigswitch" in our simplified
  60         first prototype)
  61     """
  62     dc1 = net.addDatacenter("datacenter1")
  63     dc2 = net.addDatacenter("datacenter2")
  64     dc3 = net.addDatacenter("long_data_center_name3")
  65     dc4 = net.addDatacenter(
  66         "datacenter4",
  67         metadata={"mydata": "we can also add arbitrary metadata to each DC"})
  68
  69     """
  70     3. You can add additional SDN switches for data center
  71        interconnections to the network.
  72     """
  73     s1 = net.addSwitch("s1")
  74
  75     """
  76     4. Add links between your data centers and additional switches
  77        to define you topology.
  78        These links can use Mininet's features to limit bw, add delay or jitter.
  79     """
  80     net.addLink(dc1, dc2)
  81     net.addLink("datacenter1", s1)
  82     net.addLink(s1, dc3)
  83     net.addLink(s1, "datacenter4")
  84
  85     """
  86     5. We want to access and control our data centers from the outside,
  87        e.g., we want to connect an orchestrator to start/stop compute
  88        resources aka. VNFs (represented by Docker containers in the emulated)
  89
  90        So we need to instantiate API endpoints (e.g. a zerorpc or REST
  91        interface). Depending on the endpoint implementations, we can connect
  92        one or more data centers to it, which can then be controlled through
  93        this API, e.g., start/stop/list compute instances.
  94     """
  95     # create a new instance of a endpoint implementation
  96     rapi1 = RestApiEndpoint("127.0.0.1", 5001)
  97     # connect data centers to this endpoint
  98     rapi1.connectDatacenter(dc1)
  99     rapi1.connectDatacenter(dc2)
 100     rapi1.connectDatacenter(dc3)
 101     rapi1.connectDatacenter(dc4)
 102     # run API endpoint server (in another thread, don't block)
 103
 104     rapi1.start()
 105
 106     """
 107     6. Finally we are done and can start our network (the emulator).
 108        We can also enter the Mininet CLI to interactively interact
 109        with our compute resources (just like in default Mininet).
 110        But we can also implement fully automated experiments that
 111        can be executed again and again.
 112     """
 113     net.start()
 114     net.CLI()
 115     # when the user types exit in the CLI, we stop the emulator
 116     net.stop()
 117
 118
 119 def main():
 120     setLogLevel('info')  # set Mininet loglevel
 121     create_topology1()
 122
 123
 124 if __name__ == '__main__':
 125     main()