1 ##############################################################################
2 # Copyright (c) 2015 Ericsson AB and others.
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
13 from __future__ import absolute_import
14 from six.moves import range
18 """Base class for classes in the logical model
19 Contains common attributes and methods
22 def __init__(self, name, context):
23 # model identities and reference
25 self._context = context
28 self.stack_name = None
33 """returns distinguished name for object"""
34 return self.name + "." + self._context.name
37 class PlacementGroup(Object):
38 """Class that represents a placement group in the logical model
39 Concept comes from the OVF specification. Policy should be one of
40 "availability" or "affinity (there are more but they are not supported)"
44 def __init__(self, name, context, policy):
45 if policy not in ["affinity", "availability"]:
46 raise ValueError("placement group '%s', policy '%s' is not valid" %
50 self.stack_name = context.name + "-" + name
52 PlacementGroup.map[name] = self
54 def add_member(self, name):
55 self.members.add(name)
59 return PlacementGroup.map.get(name)
62 class ServerGroup(Object): # pragma: no cover
63 """Class that represents a server group in the logical model
64 Policy should be one of "anti-affinity" or "affinity"
68 def __init__(self, name, context, policy):
69 super(ServerGroup, self).__init__(name, context)
70 if policy not in {"affinity", "anti-affinity"}:
71 raise ValueError("server group '%s', policy '%s' is not valid" %
75 self.stack_name = context.name + "-" + name
77 ServerGroup.map[name] = self
79 def add_member(self, name):
80 self.members.add(name)
84 return ServerGroup.map.get(name)
88 """Class that represents a router in the logical model"""
90 def __init__(self, name, network_name, context, external_gateway_info):
91 super(Router, self).__init__(name, context)
93 self.stack_name = context.name + "-" + network_name + "-" + self.name
94 self.stack_if_name = self.stack_name + "-if0"
95 self.external_gateway_info = external_gateway_info
98 class Network(Object):
99 """Class that represents a network in the logical model"""
102 def __init__(self, name, context, attrs):
103 super(Network, self).__init__(name, context)
104 self.stack_name = context.name + "-" + self.name
105 self.subnet_stack_name = self.stack_name + "-subnet"
106 self.subnet_cidr = attrs.get('cidr', '10.0.1.0/24')
108 self.physical_network = attrs.get('physical_network', 'physnet1')
109 self.provider = attrs.get('provider', None)
111 if "external_network" in attrs:
112 self.router = Router("router", self.name,
113 context, attrs["external_network"])
115 Network.list.append(self)
117 def has_route_to(self, network_name):
118 """determines if this network has a route to the named network"""
119 if self.router and self.router.external_gateway_info == network_name:
124 def find_by_route_to(external_network):
125 """finds a network that has a route to the specified network"""
126 for network in Network.list:
127 if network.has_route_to(external_network):
131 def find_external_network():
132 """return the name of an external network some network in this
133 context has a route to"""
134 for network in Network.list:
136 return network.router.external_gateway_info
140 class Server(Object): # pragma: no cover
141 """Class that represents a server in the logical model"""
144 def __init__(self, name, context, attrs):
145 super(Server, self).__init__(name, context)
146 self.stack_name = self.name + "." + context.name
147 self.keypair_name = context.keypair_name
148 self.secgroup_name = context.secgroup_name
149 self.user = context.user
150 self.context = context
151 self.public_ip = None
152 self.private_ip = None
157 self.placement_groups = []
158 placement = attrs.get("placement", [])
159 placement = placement if isinstance(placement, list) else [placement]
161 pg = PlacementGroup.get(p)
163 raise ValueError("server '%s', placement '%s' is invalid" %
165 self.placement_groups.append(pg)
166 pg.add_member(self.stack_name)
168 # support servergroup attr
169 self.server_group = None
170 sg = attrs.get("server_group")
172 server_group = ServerGroup.get(sg)
174 raise ValueError("server '%s', server_group '%s' is invalid" %
176 self.server_group = server_group
177 server_group.add_member(self.stack_name)
180 if "instances" in attrs:
181 self.instances = attrs["instances"]
183 # dict with key network name, each item is a dict with port name and ip
186 self.floating_ip = None
187 self.floating_ip_assoc = None
188 if "floating_ip" in attrs:
189 self.floating_ip = {}
190 self.floating_ip_assoc = {}
192 if self.floating_ip is not None:
193 ext_net = Network.find_external_network()
194 assert ext_net is not None
195 self.floating_ip["external_network"] = ext_net
199 self._image = attrs["image"]
202 if "flavor" in attrs:
203 self._flavor = attrs["flavor"]
205 Server.list.append(self)
209 """returns a server's image name"""
213 return self._context.image
217 """returns a server's flavor name"""
221 return self._context.flavor
223 def _add_instance(self, template, server_name, networks, scheduler_hints):
224 """adds to the template one server and corresponding resources"""
226 for network in networks:
227 port_name = server_name + "-" + network.name + "-port"
228 self.ports[network.name] = {"stack_name": port_name}
229 template.add_port(port_name, network.stack_name,
230 network.subnet_stack_name,
231 sec_group_id=self.secgroup_name,
232 provider=network.provider)
233 port_name_list.append(port_name)
236 external_network = self.floating_ip["external_network"]
237 if network.has_route_to(external_network):
238 self.floating_ip["stack_name"] = server_name + "-fip"
239 template.add_floating_ip(self.floating_ip["stack_name"],
242 network.router.stack_if_name,
244 self.floating_ip_assoc["stack_name"] = \
245 server_name + "-fip-assoc"
246 template.add_floating_ip_association(
247 self.floating_ip_assoc["stack_name"],
248 self.floating_ip["stack_name"],
251 template.add_server(server_name, self.image, self.flavor,
252 ports=port_name_list,
254 key_name=self.keypair_name,
255 scheduler_hints=scheduler_hints)
257 def add_to_template(self, template, networks, scheduler_hints=None):
258 """adds to the template one or more servers (instances)"""
259 if self.instances == 1:
260 server_name = self.stack_name
261 self._add_instance(template, server_name, networks,
262 scheduler_hints=scheduler_hints)
264 # TODO(hafe) fix or remove, no test/sample for this
265 for i in range(self.instances):
266 server_name = "%s-%d" % (self.stack_name, i)
267 self._add_instance(template, server_name, networks,
268 scheduler_hints=scheduler_hints)
271 def update_scheduler_hints(scheduler_hints, added_servers, placement_group):
272 """ update scheduler hints from server's placement configuration
273 TODO: this code is openstack specific and should move somewhere else
275 if placement_group.policy == "affinity":
276 if "same_host" in scheduler_hints:
277 host_list = scheduler_hints["same_host"]
279 host_list = scheduler_hints["same_host"] = []
281 if "different_host" in scheduler_hints:
282 host_list = scheduler_hints["different_host"]
284 host_list = scheduler_hints["different_host"] = []
286 for name in added_servers:
287 if name in placement_group.members:
288 host_list.append({'get_resource': name})