Adding diagram to user manual
[nepi.git] / examples / planetlab / testing / scalability.py
1 #!/usr/bin/env python
2 #
3 #    NEPI, a framework to manage network experiments
4 #    Copyright (C) 2013 INRIA
5 #
6 #    This program is free software: you can redistribute it and/or modify
7 #    it under the terms of the GNU General Public License as published by
8 #    the Free Software Foundation, either version 3 of the License, or
9 #    (at your option) any later version.
10 #
11 #    This program is distributed in the hope that it will be useful,
12 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 #    GNU General Public License for more details.
15 #
16 #    You should have received a copy of the GNU General Public License
17 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 #
19 # Author: Lucia Guevgeozian <lucia.guevgeozian_odizzio@inria.fr>
20
21 from nepi.execution.ec import ExperimentController
22 from nepi.execution.resource import ResourceAction, ResourceState
23
24 import os
25 import time
26
27 def create_node(ec, username, pl_user, pl_password, critical=True, hostname=None, 
28                 country=None, operatingSystem=None, minBandwidth=None, minCpu=None):
29
30     node = ec.register_resource("PlanetlabNode")
31
32     if username:
33         ec.set(node, "username", username)
34     if pl_user:
35         ec.set(node, "pluser", pl_user)
36     if pl_password:
37         ec.set(node, "plpassword", pl_password)
38
39     if hostname:
40         ec.set(node, "hostname", hostname)
41     if country:
42         ec.set(node, "country", country)
43     if operatingSystem:
44         ec.set(node, "operatingSystem", operatingSystem)
45     if minBandwidth:
46         ec.set(node, "minBandwidth", minBandwidth)
47     if minCpu:
48         ec.set(node, "minCpu", minCpu)
49     ec.set(node, "critical", critical)
50
51     #ec.set(node, "cleanHome", True)
52     #ec.set(node, "cleanProcesses", True)
53     
54     return node
55
56 exp_id = "scalability_exp"
57
58 # Create the entity Experiment Controller:
59 ec = ExperimentController(exp_id)
60
61 # Register the nodes resources:
62
63 # The username in this case is the slice name, the one to use for login in 
64 # via ssh into PlanetLab nodes. Replace with your own slice name.
65 username = os.environ.get("PL_SLICE")
66
67 # The pluser and plpassword are the ones used to login in the PlanetLab web 
68 # site. Replace with your own user and password account information.
69 pl_user = os.environ.get("PL_USER")
70 pl_password =  os.environ.get("PL_PASS")
71
72 # Choose the PlanetLab nodes for the experiment, in this example 5 nodes are
73 # used, and they are picked according to different criterias.
74
75 first_set_nodes = []
76 second_set_nodes = []
77 third_set_nodes = []
78
79 # First set of nodes will be defined by its hostname.
80 hostnames = ['planetlab2.utt.fr',
81 'planetlab-2.man.poznan.pl',
82 'planetlab-1.ing.unimo.it',
83 'gschembra3.diit.unict.it',
84 'planetlab2.ionio.gr',
85 'planetlab-1.imag.fr',
86 'node2pl.planet-lab.telecom-lille1.eu',
87 'planetlab1.xeno.cl.cam.ac.uk',
88 'planetlab3.hiit.fi',
89 'planetlab2.fri.uni-lj.si',
90 'planetlab1.informatik.uni-erlangen.de',
91 'node1pl.planet-lab.telecom-lille1.eu',
92 'planet2.servers.ua.pt',
93 'iraplab1.iralab.uni-karlsruhe.de',
94 'planetlab-node3.it-sudparis.eu',
95 'planet1.elte.hu',
96 'planet1.l3s.uni-hannover.de',
97 'planetlab1.fct.ualg.pt',
98 'host1.planetlab.informatik.tu-darmstadt.de',
99 'vicky.planetlab.ntua.gr',
100 'planetlab1.rutgers.edu']
101
102 for hostname in hostnames:
103     node = create_node(ec, username, pl_user, pl_password, hostname=hostname,
104             critical=False)
105     first_set_nodes.append(node)
106
107 # Second set of nodes will be U.S.A. nodes.
108 country = "United States"
109 for i in range(15):
110     node = create_node(ec, username, pl_user, pl_password, country=country,
111             critical=False)
112     second_set_nodes.append(node)
113
114 # Third set of nodes can be any node in Planetlab testbed.
115 for i in range(70):
116     node = create_node(ec, username, pl_user, pl_password, critical=False)
117     third_set_nodes.append(node)
118
119 # Register conditions
120
121 # The nodes that are completely identified by their hostnames have to be provisioned 
122 # before the rest of the nodes. This assures that no other resource will use the
123 # identified node even if the constraints matchs. 
124 # In this example the nodes from the first need to be provisioned before the ones in
125 # the second and third group. Using the same logic, is convenient that nodes from the
126 # second group are provisioned before nodes from the third group.
127
128 ec.register_condition(second_set_nodes, ResourceAction.DEPLOY, first_set_nodes, ResourceState.PROVISIONED)
129 ec.register_condition(third_set_nodes, ResourceAction.DEPLOY, second_set_nodes, ResourceState.PROVISIONED)
130  
131 # Deploy the experiment:
132 ec.deploy()
133
134 # Wait until all nodes are provisioned:
135 ec.wait_deployed(first_set_nodes)
136 ec.wait_deployed(second_set_nodes)
137 ec.wait_deployed(third_set_nodes)
138
139 # Do the experiment controller shutdown:
140 ec.shutdown()
141
142 # END