2 # -*- coding: utf-8 -*-
6 from constants import TESTBED_ID, TESTBED_VERSION
7 from nepi.core import metadata
8 from nepi.core.metadata import Parallel
9 from nepi.core.attributes import Attribute
10 from nepi.util import tags, validation
11 from nepi.util.constants import ApplicationStatus as AS, \
12 FactoryCategories as FC, \
13 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP, \
14 DeploymentConfiguration as DC
21 NODEIFACE = "NodeInterface"
22 TUNIFACE = "TunInterface"
23 TAPIFACE = "TapInterface"
24 APPLICATION = "Application"
25 DEPENDENCY = "Dependency"
26 NEPIDEPENDENCY = "NepiDependency"
27 NS3DEPENDENCY = "NS3Dependency"
31 PL_TESTBED_ID = "planetlab"
34 ### Custom validation functions ###
35 def is_addrlist(attribute, value):
36 if not validation.is_string(attribute, value):
43 components = value.split(',')
45 for component in components:
47 addr, mask = component.split('/',1)
49 addr, mask = component, '32'
51 if mask is not None and not (mask and mask.isdigit()):
52 # No empty or nonnumeric masks
55 if not validation.is_ip4_address(attribute, addr):
56 # Address part must be ipv4
61 def is_portlist(attribute, value):
62 if not validation.is_string(attribute, value):
69 components = value.split(',')
71 for component in components:
73 pfrom, pto = component.split('-',1)
75 pfrom = pto = component
77 if not pfrom or not pto or not pfrom.isdigit() or not pto.isdigit():
78 # No empty or nonnumeric ports
84 ### Connection functions ####
86 def connect_node_iface_node(testbed_instance, node_guid, iface_guid):
87 node = testbed_instance._elements[node_guid]
88 iface = testbed_instance._elements[iface_guid]
91 def connect_node_iface_inet(testbed_instance, iface_guid, inet_guid):
92 iface = testbed_instance._elements[iface_guid]
93 iface.has_internet = True
95 def connect_tun_iface_node(testbed_instance, node_guid, iface_guid):
96 node = testbed_instance._elements[node_guid]
97 iface = testbed_instance._elements[iface_guid]
99 node.required_vsys.update(('fd_tuntap', 'vif_up', 'vif_down'))
100 node.required_packages.update(('python', 'python-crypto', 'python-setuptools', 'gcc'))
102 def connect_tun_iface_peer(proto, testbed_instance, iface_guid, peer_iface_guid):
103 iface = testbed_instance._elements[iface_guid]
104 peer_iface = testbed_instance._elements[peer_iface_guid]
105 iface.peer_iface = peer_iface
107 iface.tun_proto = proto
108 iface.tun_key = peer_iface.tun_key
110 def crossconnect_tun_iface_peer_init(proto, testbed_instance, iface_guid, peer_iface_data):
111 iface = testbed_instance._elements[iface_guid]
112 iface.peer_iface = None
113 iface.peer_addr = peer_iface_data.get("tun_addr")
114 iface.peer_proto = peer_iface_data.get("tun_proto") or proto
115 iface.peer_port = peer_iface_data.get("tun_port")
116 iface.tun_key = min(iface.tun_key, peer_iface_data.get("tun_key"))
117 iface.tun_proto = proto
119 preconfigure_tuniface(testbed_instance, iface_guid)
121 def crossconnect_tun_iface_peer_compl(proto, testbed_instance, iface_guid, peer_iface_data):
122 # refresh (refreshable) attributes for second-phase
123 iface = testbed_instance._elements[iface_guid]
124 iface.peer_addr = peer_iface_data.get("tun_addr")
125 iface.peer_proto = peer_iface_data.get("tun_proto") or proto
126 iface.peer_port = peer_iface_data.get("tun_port")
128 postconfigure_tuniface(testbed_instance, iface_guid)
130 def crossconnect_tun_iface_peer_both(proto, testbed_instance, iface_guid, peer_iface_data):
131 crossconnect_tun_iface_peer_init(proto, testbed_instance, iface_guid, peer_iface_data)
132 crossconnect_tun_iface_peer_compl(proto, testbed_instance, iface_guid, peer_iface_data)
134 def connect_dep(testbed_instance, node_guid, app_guid):
135 node = testbed_instance._elements[node_guid]
136 app = testbed_instance._elements[app_guid]
140 node.required_packages.update(set(
141 app.depends.split() ))
144 if app.home_path and app.home_path not in node.pythonpath:
145 node.pythonpath.append(app.home_path)
148 for envkey, envval in app.env.iteritems():
149 envval = app._replace_paths(envval)
150 node.env[envkey].append(envval)
153 node.rpmFusion = True
155 def connect_node_netpipe(testbed_instance, node_guid, netpipe_guid):
156 node = testbed_instance._elements[node_guid]
157 netpipe = testbed_instance._elements[netpipe_guid]
159 node.required_vsys.add('ipfw-be')
160 node.required_packages.add('ipfwslice')
163 ### Creation functions ###
165 def create_node(testbed_instance, guid):
166 parameters = testbed_instance._get_parameters(guid)
168 # create element with basic attributes
169 element = testbed_instance._make_node(parameters)
171 # add constraint on number of (real) interfaces
172 # by counting connected devices
173 dev_guids = testbed_instance.get_connected(guid, "devs", "node")
174 num_open_ifaces = sum( # count True values
175 NODEIFACE == testbed_instance._get_factory_id(guid)
176 for guid in dev_guids )
177 element.min_num_external_ifaces = num_open_ifaces
179 # require vroute vsys if we have routes to set up
180 routes = testbed_instance._add_route.get(guid)
182 element.required_vsys.add("vroute")
184 testbed_instance.elements[guid] = element
186 def create_nodeiface(testbed_instance, guid):
187 parameters = testbed_instance._get_parameters(guid)
188 element = testbed_instance._make_node_iface(parameters)
189 testbed_instance.elements[guid] = element
191 def create_tuniface(testbed_instance, guid):
192 parameters = testbed_instance._get_parameters(guid)
193 element = testbed_instance._make_tun_iface(parameters)
195 # Set custom addresses, if there are any already
196 # Setting this early helps set up P2P links
197 if guid in testbed_instance._add_address and not (element.address or element.netmask or element.netprefix):
198 addresses = testbed_instance._add_address[guid]
199 for address in addresses:
200 (address, netprefix, broadcast) = address
201 element.add_address(address, netprefix, broadcast)
203 testbed_instance.elements[guid] = element
205 def create_tapiface(testbed_instance, guid):
206 parameters = testbed_instance._get_parameters(guid)
207 element = testbed_instance._make_tap_iface(parameters)
209 # Set custom addresses, if there are any already
210 # Setting this early helps set up P2P links
211 if guid in testbed_instance._add_address and not (element.address or element.netmask or element.netprefix):
212 addresses = testbed_instance._add_address[guid]
213 for address in addresses:
214 (address, netprefix, broadcast) = address
215 element.add_address(address, netprefix, broadcast)
217 testbed_instance.elements[guid] = element
219 def create_application(testbed_instance, guid):
220 parameters = testbed_instance._get_parameters(guid)
221 element = testbed_instance._make_application(parameters)
223 # Just inject configuration stuff
224 element.home_path = "nepi-app-%s" % (guid,)
226 testbed_instance.elements[guid] = element
228 def create_dependency(testbed_instance, guid):
229 parameters = testbed_instance._get_parameters(guid)
230 element = testbed_instance._make_dependency(parameters)
232 # Just inject configuration stuff
233 element.home_path = "nepi-dep-%s" % (guid,)
235 testbed_instance.elements[guid] = element
237 def create_nepi_dependency(testbed_instance, guid):
238 parameters = testbed_instance._get_parameters(guid)
239 element = testbed_instance._make_nepi_dependency(parameters)
241 # Just inject configuration stuff
242 element.home_path = "nepi-nepi-%s" % (guid,)
244 testbed_instance.elements[guid] = element
246 def create_ns3_dependency(testbed_instance, guid):
247 parameters = testbed_instance._get_parameters(guid)
248 element = testbed_instance._make_ns3_dependency(parameters)
250 # Just inject configuration stuff
251 element.home_path = "nepi-ns3-%s" % (guid,)
253 testbed_instance.elements[guid] = element
255 def create_internet(testbed_instance, guid):
256 parameters = testbed_instance._get_parameters(guid)
257 element = testbed_instance._make_internet(parameters)
258 testbed_instance.elements[guid] = element
260 def create_netpipe(testbed_instance, guid):
261 parameters = testbed_instance._get_parameters(guid)
262 element = testbed_instance._make_netpipe(parameters)
263 testbed_instance.elements[guid] = element
265 ### Start/Stop functions ###
267 def start_application(testbed_instance, guid):
268 parameters = testbed_instance._get_parameters(guid)
269 traces = testbed_instance._get_traces(guid)
270 app = testbed_instance.elements[guid]
272 app.stdout = "stdout" in traces
273 app.stderr = "stderr" in traces
274 app.buildlog = "buildlog" in traces
278 def stop_application(testbed_instance, guid):
279 app = testbed_instance.elements[guid]
282 ### Status functions ###
284 def status_application(testbed_instance, guid):
285 if guid not in testbed_instance.elements.keys():
286 return AS.STATUS_NOT_STARTED
288 app = testbed_instance.elements[guid]
291 ### Configure functions ###
293 def configure_nodeiface(testbed_instance, guid):
294 element = testbed_instance._elements[guid]
296 # Cannot explicitly configure addresses
297 if guid in testbed_instance._add_address:
298 raise ValueError, "Cannot explicitly set address of public PlanetLab interface"
301 node_guid = testbed_instance.get_connected(guid, "node", "devs")[0]
302 dev_guids = testbed_instance.get_connected(node_guid, "node", "devs")
303 siblings = [ self._element[dev_guid]
304 for dev_guid in dev_guids
305 if dev_guid != guid ]
307 # Fetch address from PLC api
308 element.pick_iface(siblings)
310 # Do some validations
313 def preconfigure_tuniface(testbed_instance, guid):
314 element = testbed_instance._elements[guid]
316 # Set custom addresses if any, and if not set already
317 if guid in testbed_instance._add_address and not (element.address or element.netmask or element.netprefix):
318 addresses = testbed_instance._add_address[guid]
319 for address in addresses:
320 (address, netprefix, broadcast) = address
321 element.add_address(address, netprefix, broadcast)
323 # Link to external interface, if any
324 for iface in testbed_instance._elements.itervalues():
325 if isinstance(iface, testbed_instance._interfaces.NodeIface) and iface.node is element.node and iface.has_internet:
326 element.external_iface = iface
329 # Set standard TUN attributes
330 if (not element.tun_addr or not element.tun_port) and element.external_iface:
331 element.tun_addr = element.external_iface.address
332 element.tun_port = testbed_instance.tapPortBase + int(guid)
335 traces = testbed_instance._get_traces(guid)
336 for capmode in ('pcap', 'packets'):
337 if capmode in traces:
338 element.capture = capmode
341 element.capture = False
343 # Do some validations
347 if element.peer_proto:
348 if element.peer_iface and isinstance(element.peer_iface, testbed_instance._interfaces.TunIface):
350 listening = id(element) < id(element.peer_iface)
353 if not element.tun_addr or not element.tun_port:
355 elif not element.peer_addr or not element.peer_port:
358 # both have addresses...
359 # ...the one with the lesser address listens
360 listening = element.tun_addr < element.peer_addr
365 def postconfigure_tuniface(testbed_instance, guid):
366 element = testbed_instance._elements[guid]
371 def wait_tuniface(testbed_instance, guid):
372 element = testbed_instance._elements[guid]
375 element.async_launch_wait()
378 def configure_node(testbed_instance, guid):
379 node = testbed_instance._elements[guid]
381 # Just inject configuration stuff
382 node.home_path = "nepi-node-%s" % (guid,)
383 node.ident_path = testbed_instance.sliceSSHKey
384 node.slicename = testbed_instance.slicename
386 # Do some validations
389 # this will be done in parallel in all nodes
390 # this call only spawns the process
391 node.install_dependencies()
393 def configure_node_routes(testbed_instance, guid):
394 node = testbed_instance._elements[guid]
395 routes = testbed_instance._add_route.get(guid)
399 for dev_guid in testbed_instance.get_connected(guid, "devs", "node")
400 for dev in ( testbed_instance._elements.get(dev_guid) ,)
401 if dev and isinstance(dev, testbed_instance._interfaces.TunIface) ]
403 node.configure_routes(routes, devs)
405 def configure_application(testbed_instance, guid):
406 app = testbed_instance._elements[guid]
408 # Do some validations
411 # Wait for dependencies
412 app.node.wait_dependencies()
417 def configure_dependency(testbed_instance, guid):
418 dep = testbed_instance._elements[guid]
420 # Do some validations
423 # Wait for dependencies
424 dep.node.wait_dependencies()
429 def configure_netpipe(testbed_instance, guid):
430 netpipe = testbed_instance._elements[guid]
432 # Do some validations
435 # Wait for dependencies
436 netpipe.node.wait_dependencies()
441 ### Factory information ###
443 connector_types = dict({
445 "help": "Connector from node to applications",
451 "help": "Connector from node to network interfaces",
457 "help": "Connector from node to application dependencies "
458 "(packages and applications that need to be installed)",
464 "help": "Connector from network interfaces to the internet",
470 "help": "Connector to a Node",
476 "help": "Connector to a NetPipe",
483 "help": "ip-ip tunneling over TCP link",
489 "help": "ip-ip tunneling over UDP datagrams",
495 "help": "TUN device file descriptor provider",
504 "from": (TESTBED_ID, NODE, "devs"),
505 "to": (TESTBED_ID, NODEIFACE, "node"),
506 "init_code": connect_node_iface_node,
510 "from": (TESTBED_ID, NODE, "devs"),
511 "to": (TESTBED_ID, TUNIFACE, "node"),
512 "init_code": connect_tun_iface_node,
516 "from": (TESTBED_ID, NODE, "devs"),
517 "to": (TESTBED_ID, TAPIFACE, "node"),
518 "init_code": connect_tun_iface_node,
522 "from": (TESTBED_ID, NODEIFACE, "inet"),
523 "to": (TESTBED_ID, INTERNET, "devs"),
524 "init_code": connect_node_iface_inet,
528 "from": (TESTBED_ID, NODE, "apps"),
529 "to": (TESTBED_ID, APPLICATION, "node"),
530 "init_code": connect_dep,
534 "from": (TESTBED_ID, NODE, "deps"),
535 "to": (TESTBED_ID, DEPENDENCY, "node"),
536 "init_code": connect_dep,
540 "from": (TESTBED_ID, NODE, "deps"),
541 "to": (TESTBED_ID, NEPIDEPENDENCY, "node"),
542 "init_code": connect_dep,
546 "from": (TESTBED_ID, NODE, "deps"),
547 "to": (TESTBED_ID, NS3DEPENDENCY, "node"),
548 "init_code": connect_dep,
552 "from": (TESTBED_ID, NODE, "pipes"),
553 "to": (TESTBED_ID, NETPIPE, "node"),
554 "init_code": connect_node_netpipe,
558 "from": (TESTBED_ID, TUNIFACE, "tcp"),
559 "to": (TESTBED_ID, TUNIFACE, "tcp"),
560 "init_code": functools.partial(connect_tun_iface_peer,"tcp"),
564 "from": (TESTBED_ID, TUNIFACE, "udp"),
565 "to": (TESTBED_ID, TUNIFACE, "udp"),
566 "init_code": functools.partial(connect_tun_iface_peer,"udp"),
570 "from": (TESTBED_ID, TAPIFACE, "tcp"),
571 "to": (TESTBED_ID, TAPIFACE, "tcp"),
572 "init_code": functools.partial(connect_tun_iface_peer,"tcp"),
576 "from": (TESTBED_ID, TAPIFACE, "udp"),
577 "to": (TESTBED_ID, TAPIFACE, "udp"),
578 "init_code": functools.partial(connect_tun_iface_peer,"udp"),
582 "from": (TESTBED_ID, TUNIFACE, "tcp"),
583 "to": (None, None, "tcp"),
584 "init_code": functools.partial(crossconnect_tun_iface_peer_init,"tcp"),
585 "compl_code": functools.partial(crossconnect_tun_iface_peer_compl,"tcp"),
589 "from": (TESTBED_ID, TUNIFACE, "udp"),
590 "to": (None, None, "udp"),
591 "init_code": functools.partial(crossconnect_tun_iface_peer_init,"udp"),
592 "compl_code": functools.partial(crossconnect_tun_iface_peer_compl,"udp"),
596 "from": (TESTBED_ID, TUNIFACE, "fd->"),
597 "to": (None, None, "->fd"),
598 "compl_code": functools.partial(crossconnect_tun_iface_peer_both,"fd"),
602 "from": (TESTBED_ID, TAPIFACE, "tcp"),
603 "to": (None, None, "tcp"),
604 "init_code": functools.partial(crossconnect_tun_iface_peer_init,"tcp"),
605 "compl_code": functools.partial(crossconnect_tun_iface_peer_compl,"tcp"),
609 "from": (TESTBED_ID, TAPIFACE, "udp"),
610 "to": (None, None, "udp"),
611 "init_code": functools.partial(crossconnect_tun_iface_peer_init,"udp"),
612 "compl_code": functools.partial(crossconnect_tun_iface_peer_compl,"udp"),
616 "from": (TESTBED_ID, TAPIFACE, "fd->"),
617 "to": (None, None, "->fd"),
618 "compl_code": functools.partial(crossconnect_tun_iface_peer_both,"fd"),
624 "forward_X11": dict({
625 "name": "forward_X11",
626 "help": "Forward x11 from main namespace to the node",
627 "type": Attribute.BOOL,
629 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
630 "validation_function": validation.is_bool,
634 "help": "Constrain hostname during resource discovery. May use wildcards.",
635 "type": Attribute.STRING,
636 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
637 "validation_function": validation.is_string,
641 "help": "Constrain location (city) during resource discovery. May use wildcards.",
642 "type": Attribute.STRING,
643 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
644 "validation_function": validation.is_string,
648 "help": "Constrain location (country) during resource discovery. May use wildcards.",
649 "type": Attribute.STRING,
650 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
651 "validation_function": validation.is_string,
655 "help": "Constrain location (region) during resource discovery. May use wildcards.",
656 "type": Attribute.STRING,
657 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
658 "validation_function": validation.is_string,
660 "architecture": dict({
661 "name": "architecture",
662 "help": "Constrain architexture during resource discovery.",
663 "type": Attribute.ENUM,
664 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
665 "allowed": ["x86_64",
667 "validation_function": validation.is_enum,
669 "operating_system": dict({
670 "name": "operatingSystem",
671 "help": "Constrain operating system during resource discovery.",
672 "type": Attribute.ENUM,
673 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
679 "validation_function": validation.is_enum,
683 "help": "Constrain the PlanetLab site this node should reside on.",
684 "type": Attribute.ENUM,
685 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
689 "validation_function": validation.is_enum,
691 "min_reliability": dict({
692 "name": "minReliability",
693 "help": "Constrain reliability while picking PlanetLab nodes. Specifies a lower acceptable bound.",
694 "type": Attribute.DOUBLE,
696 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
697 "validation_function": validation.is_number,
699 "max_reliability": dict({
700 "name": "maxReliability",
701 "help": "Constrain reliability while picking PlanetLab nodes. Specifies an upper acceptable bound.",
702 "type": Attribute.DOUBLE,
704 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
705 "validation_function": validation.is_number,
707 "min_bandwidth": dict({
708 "name": "minBandwidth",
709 "help": "Constrain available bandwidth while picking PlanetLab nodes. Specifies a lower acceptable bound.",
710 "type": Attribute.DOUBLE,
712 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
713 "validation_function": validation.is_number,
715 "max_bandwidth": dict({
716 "name": "maxBandwidth",
717 "help": "Constrain available bandwidth while picking PlanetLab nodes. Specifies an upper acceptable bound.",
718 "type": Attribute.DOUBLE,
720 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
721 "validation_function": validation.is_number,
725 "help": "Constrain node load average while picking PlanetLab nodes. Specifies a lower acceptable bound.",
726 "type": Attribute.DOUBLE,
728 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
729 "validation_function": validation.is_number,
733 "help": "Constrain node load average while picking PlanetLab nodes. Specifies an upper acceptable bound.",
734 "type": Attribute.DOUBLE,
736 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
737 "validation_function": validation.is_number,
741 "help": "Constrain available cpu time while picking PlanetLab nodes. Specifies a lower acceptable bound.",
742 "type": Attribute.DOUBLE,
744 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
745 "validation_function": validation.is_number,
749 "help": "Constrain available cpu time while picking PlanetLab nodes. Specifies an upper acceptable bound.",
750 "type": Attribute.DOUBLE,
752 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
753 "validation_function": validation.is_number,
759 "type": Attribute.BOOL,
761 "validation_function": validation.is_bool
765 "help": "This is the primary interface for the attached node",
766 "type": Attribute.BOOL,
768 "validation_function": validation.is_bool
770 "device_name": dict({
772 "help": "Device name",
773 "type": Attribute.STRING,
774 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
775 "validation_function": validation.is_string
779 "help": "Maximum transmition unit for device",
780 "type": Attribute.INTEGER,
782 "validation_function": validation.is_integer_range(0,1500)
786 "help": "Network mask for the device (eg: 24 for /24 network)",
787 "type": Attribute.INTEGER,
788 "validation_function": validation.is_integer_range(8,24)
792 "help": "Enable SNAT (source NAT to the internet) no this device",
793 "type": Attribute.BOOL,
795 "validation_function": validation.is_bool
797 "pointopoint": dict({
798 "name": "pointopoint",
799 "help": "If the interface is a P2P link, the remote endpoint's IP "
800 "should be set on this attribute.",
801 "type": Attribute.STRING,
802 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
803 "validation_function": validation.is_string
806 "name": "txqueuelen",
807 "help": "Transmission queue length (in packets)",
808 "type": Attribute.INTEGER,
810 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
812 "validation_function": validation.is_integer
817 "help": "Command line string",
818 "type": Attribute.STRING,
819 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
820 "validation_function": validation.is_string
824 "help": "Run with root privileges",
825 "type": Attribute.BOOL,
826 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
828 "validation_function": validation.is_bool
832 "help": "Standard input",
833 "type": Attribute.STRING,
834 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
835 "validation_function": validation.is_string
840 "help": "Space-separated list of packages required to run the application",
841 "type": Attribute.STRING,
842 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
843 "validation_function": validation.is_string
845 "build-depends": dict({
846 "name": "buildDepends",
847 "help": "Space-separated list of packages required to build the application",
848 "type": Attribute.STRING,
849 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
850 "validation_function": validation.is_string
854 "help": "True if required packages can be found in the RpmFusion repository",
855 "type": Attribute.BOOL,
856 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
858 "validation_function": validation.is_bool
862 "help": "Space-separated list of regular files to be deployed in the working path prior to building. "
863 "Archives won't be expanded automatically.",
864 "type": Attribute.STRING,
865 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
866 "validation_function": validation.is_string
870 "help": "Build commands to execute after deploying the sources. "
871 "Sources will be in the ${SOURCES} folder. "
872 "Example: tar xzf ${SOURCES}/my-app.tgz && cd my-app && ./configure && make && make clean.\n"
873 "Try to make the commands return with a nonzero exit code on error.\n"
874 "Also, do not install any programs here, use the 'install' attribute. This will "
875 "help keep the built files constrained to the build folder (which may "
876 "not be the home folder), and will result in faster deployment. Also, "
877 "make sure to clean up temporary files, to reduce bandwidth usage between "
878 "nodes when transferring built packages.",
879 "type": Attribute.STRING,
880 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
881 "validation_function": validation.is_string
885 "help": "Commands to transfer built files to their final destinations. "
886 "Sources will be in the initial working folder, and a special "
887 "tag ${SOURCES} can be used to reference the experiment's "
888 "home folder (where the application commands will run).\n"
889 "ALL sources and targets needed for execution must be copied there, "
890 "if building has been enabled.\n"
891 "That is, 'slave' nodes will not automatically get any source files. "
892 "'slave' nodes don't get build dependencies either, so if you need "
893 "make and other tools to install, be sure to provide them as "
894 "actual dependencies instead.",
895 "type": Attribute.STRING,
896 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
897 "validation_function": validation.is_string
900 "netpipe_mode": dict({
902 "help": "Link mode:\n"
903 " * SERVER: applies to incoming connections\n"
904 " * CLIENT: applies to outgoing connections\n"
905 " * SERVICE: applies to both",
906 "type": Attribute.ENUM,
907 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
908 "allowed": ["SERVER",
911 "validation_function": validation.is_enum,
915 "help": "Port list or range. Eg: '22', '22,23,27', '20-2000'",
916 "type": Attribute.STRING,
917 "validation_function": is_portlist,
921 "help": "Address list or range. Eg: '127.0.0.1', '127.0.0.1,127.0.1.1', '127.0.0.1/8'",
922 "type": Attribute.STRING,
923 "validation_function": is_addrlist,
927 "help": "Inbound bandwidth limit (in Mbit/s)",
928 "type": Attribute.DOUBLE,
929 "validation_function": validation.is_number,
933 "help": "Outbound bandwidth limit (in Mbit/s)",
934 "type": Attribute.DOUBLE,
935 "validation_function": validation.is_number,
939 "help": "Inbound packet loss rate (0 = no loss, 1 = 100% loss)",
940 "type": Attribute.DOUBLE,
941 "validation_function": validation.is_number,
945 "help": "Outbound packet loss rate (0 = no loss, 1 = 100% loss)",
946 "type": Attribute.DOUBLE,
947 "validation_function": validation.is_number,
951 "help": "Inbound packet delay (in milliseconds)",
952 "type": Attribute.INTEGER,
954 "validation_function": validation.is_integer,
958 "help": "Outbound packet delay (in milliseconds)",
959 "type": Attribute.INTEGER,
961 "validation_function": validation.is_integer,
968 "help": "Standard output stream"
972 "help": "Application standard error",
976 "help": "Output of the build process",
979 "netpipe_stats": dict({
980 "name": "netpipeStats",
981 "help": "Information about rule match counters, packets dropped, etc.",
986 "help": "Detailled log of all packets going through the interface",
990 "help": "PCAP trace of all packets going through the interface",
994 create_order = [ INTERNET, NODE, NODEIFACE, TAPIFACE, TUNIFACE, NETPIPE, NEPIDEPENDENCY, NS3DEPENDENCY, DEPENDENCY, APPLICATION ]
996 configure_order = [ INTERNET, Parallel(NODE), NODEIFACE, Parallel(TAPIFACE), Parallel(TUNIFACE), NETPIPE, Parallel(NEPIDEPENDENCY), Parallel(NS3DEPENDENCY), Parallel(DEPENDENCY), Parallel(APPLICATION) ]
998 # Start (and prestart) node after ifaces, because the node needs the ifaces in order to set up routes
999 start_order = [ INTERNET, NODEIFACE, Parallel(TAPIFACE), Parallel(TUNIFACE), Parallel(NODE), NETPIPE, Parallel(NEPIDEPENDENCY), Parallel(NS3DEPENDENCY), Parallel(DEPENDENCY), Parallel(APPLICATION) ]
1001 factories_info = dict({
1003 "help": "Virtualized Node (V-Server style)",
1004 "category": FC.CATEGORY_NODES,
1005 "create_function": create_node,
1006 "preconfigure_function": configure_node,
1007 "prestart_function": configure_node_routes,
1019 # NEPI-in-NEPI attributes
1020 ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP,
1022 "connector_types": ["devs", "apps", "pipes", "deps"],
1023 "tags": [tags.NODE, tags.ALLOW_ROUTES],
1026 "help": "External network interface - they cannot be brought up or down, and they MUST be connected to the internet.",
1027 "category": FC.CATEGORY_DEVICES,
1028 "create_function": create_nodeiface,
1029 "preconfigure_function": configure_nodeiface,
1030 "box_attributes": [ ],
1031 "connector_types": ["node", "inet"],
1032 "tags": [tags.INTERFACE, tags.HAS_ADDRESSES],
1035 "help": "Virtual TUN network interface (layer 3)",
1036 "category": FC.CATEGORY_DEVICES,
1037 "create_function": create_tuniface,
1038 "preconfigure_function": preconfigure_tuniface,
1039 "configure_function": postconfigure_tuniface,
1040 "prestart_function": wait_tuniface,
1042 "up", "device_name", "mtu", "snat", "pointopoint",
1044 "tun_proto", "tun_addr", "tun_port", "tun_key"
1046 "traces": ["packets", "pcap"],
1047 "connector_types": ["node","udp","tcp","fd->"],
1048 "tags": [tags.INTERFACE, tags.ALLOW_ADDRESSES],
1051 "help": "Virtual TAP network interface (layer 2)",
1052 "category": FC.CATEGORY_DEVICES,
1053 "create_function": create_tapiface,
1054 "preconfigure_function": preconfigure_tuniface,
1055 "configure_function": postconfigure_tuniface,
1056 "prestart_function": wait_tuniface,
1058 "up", "device_name", "mtu", "snat", "pointopoint",
1060 "tun_proto", "tun_addr", "tun_port", "tun_key"
1062 "traces": ["packets", "pcap"],
1063 "connector_types": ["node","udp","tcp","fd->"],
1064 "tags": [tags.INTERFACE, tags.ALLOW_ADDRESSES],
1067 "help": "Generic executable command line application",
1068 "category": FC.CATEGORY_APPLICATIONS,
1069 "create_function": create_application,
1070 "start_function": start_application,
1071 "status_function": status_application,
1072 "stop_function": stop_application,
1073 "configure_function": configure_application,
1074 "box_attributes": ["command", "sudo", "stdin",
1075 "depends", "build-depends", "build", "install",
1076 "sources", "rpm-fusion" ],
1077 "connector_types": ["node"],
1078 "traces": ["stdout", "stderr", "buildlog"],
1079 "tags": [tags.APPLICATION],
1082 "help": "Requirement for package or application to be installed on some node",
1083 "category": FC.CATEGORY_APPLICATIONS,
1084 "create_function": create_dependency,
1085 "preconfigure_function": configure_dependency,
1086 "box_attributes": ["depends", "build-depends", "build", "install",
1087 "sources", "rpm-fusion" ],
1088 "connector_types": ["node"],
1089 "traces": ["buildlog"],
1091 NEPIDEPENDENCY: dict({
1092 "help": "Requirement for NEPI inside NEPI - required to run testbed instances inside a node",
1093 "category": FC.CATEGORY_APPLICATIONS,
1094 "create_function": create_nepi_dependency,
1095 "preconfigure_function": configure_dependency,
1096 "box_attributes": [],
1097 "connector_types": ["node"],
1098 "traces": ["buildlog"],
1100 NS3DEPENDENCY: dict({
1101 "help": "Requirement for NS3 inside NEPI - required to run NS3 testbed instances inside a node. It also needs NepiDependency.",
1102 "category": FC.CATEGORY_APPLICATIONS,
1103 "create_function": create_ns3_dependency,
1104 "preconfigure_function": configure_dependency,
1105 "box_attributes": [ ],
1106 "connector_types": ["node"],
1107 "traces": ["buildlog"],
1110 "help": "Internet routing",
1111 "category": FC.CATEGORY_CHANNELS,
1112 "create_function": create_internet,
1113 "connector_types": ["devs"],
1114 "tags": [tags.INTERNET],
1117 "help": "Link emulation",
1118 "category": FC.CATEGORY_CHANNELS,
1119 "create_function": create_netpipe,
1120 "configure_function": configure_netpipe,
1121 "box_attributes": ["netpipe_mode",
1122 "addr_list", "port_list",
1123 "bw_in","plr_in","delay_in",
1124 "bw_out","plr_out","delay_out"],
1125 "connector_types": ["node"],
1126 "traces": ["netpipe_stats"],
1130 testbed_attributes = dict({
1133 "help": "The name of the PlanetLab slice to use",
1134 "type": Attribute.STRING,
1135 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable | Attribute.NoDefaultValue,
1136 "validation_function": validation.is_string
1140 "help": "The name of the PlanetLab user to use for API calls - it must have at least a User role.",
1141 "type": Attribute.STRING,
1142 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable | Attribute.NoDefaultValue,
1143 "validation_function": validation.is_string
1147 "help": "The PlanetLab user's password.",
1148 "type": Attribute.STRING,
1149 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable | Attribute.NoDefaultValue,
1150 "validation_function": validation.is_string
1154 "help": "The PlanetLab PLC API host",
1155 "type": Attribute.STRING,
1156 "value": "www.planet-lab.eu",
1157 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
1158 "validation_function": validation.is_string
1162 "help": "The PlanetLab PLC API url pattern - %(hostname)s is replaced by plcHost.",
1163 "type": Attribute.STRING,
1164 "value": "https://%(hostname)s:443/PLCAPI/",
1165 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
1166 "validation_function": validation.is_string
1168 "p2p_deployment": dict({
1169 "name": "p2pDeployment",
1170 "help": "Enable peer-to-peer deployment of applications and dependencies. "
1171 "When enabled, dependency packages and applications are "
1172 "deployed in a P2P fashion, picking a single node to do "
1173 "the building or repo download, while all the others "
1174 "cooperatively exchange resulting binaries or rpms. "
1175 "When deploying to many nodes, this is a far more efficient "
1176 "use of resources. It does require re-encrypting and distributing "
1177 "the slice's private key. Though it is implemented in a secure "
1178 "fashion, if they key's sole purpose is not PlanetLab, then this "
1179 "feature should be disabled.",
1180 "type": Attribute.BOOL,
1182 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable,
1183 "validation_function": validation.is_bool
1185 "slice_ssh_key": dict({
1186 "name": "sliceSSHKey",
1187 "help": "The controller-local path to the slice user's ssh private key. "
1188 "It is the user's responsability to deploy this file where the controller "
1189 "will run, it won't be done automatically because it's sensitive information. "
1190 "It is recommended that a NEPI-specific user be created for this purpose and "
1191 "this purpose alone.",
1192 "type": Attribute.STRING,
1193 "flags": Attribute.ExecReadOnly | Attribute.ExecImmutable | Attribute.NoDefaultValue,
1194 "validation_function": validation.is_string
1196 "pl_log_level": dict({
1197 "name": "plLogLevel",
1198 "help": "Verbosity of logging of planetlab events.",
1200 "type": Attribute.ENUM,
1201 "allowed": ["DEBUG",
1206 "validation_function": validation.is_enum,
1208 "tap_port_base": dict({
1209 "name": "tapPortBase",
1210 "help": "Base port to use when connecting TUN/TAPs. Effective port will be BASE + GUID.",
1211 "type": Attribute.INTEGER,
1213 "range": (2000,30000),
1214 "validation_function": validation.is_integer_range(2000,30000)
1218 supported_recovery_policies = [
1224 class MetadataInfo(metadata.MetadataInfo):
1226 def connector_types(self):
1227 return connector_types
1230 def connections(self):
1234 def attributes(self):
1242 def create_order(self):
1246 def configure_order(self):
1247 return configure_order
1250 def prestart_order(self):
1254 def start_order(self):
1258 def factories_info(self):
1259 return factories_info
1262 def testbed_attributes(self):
1263 return testbed_attributes
1266 def testbed_id(self):
1270 def testbed_version(self):
1271 return TESTBED_VERSION
1274 def supported_recovery_policies(self):
1275 return supported_recovery_policies