blob: bf20e86aa27fff8be1821ea1a1f9b331265bdad9 [file] [log] [blame]
Scott Bakere9ff7ce2015-04-14 17:19:16 -07001from django.db import models
Scott Baker839daa82015-11-16 22:53:49 -08002from core.models import Service, PlCoreBase, Slice, Instance, Tenant, TenantWithContainer, Node, Image, User, Flavor, Subscriber, NetworkParameter, NetworkParameterType, Port
Scott Bakere9ff7ce2015-04-14 17:19:16 -07003from core.models.plcorebase import StrippedCharField
4import os
Scott Baker192da222015-07-08 19:01:56 -07005from django.db import models, transaction
Scott Bakere9ff7ce2015-04-14 17:19:16 -07006from django.forms.models import model_to_dict
7from django.db.models import Q
8from operator import itemgetter, attrgetter, methodcaller
Scott Baker5b8eb412016-02-02 16:56:18 -08009from core.models import Tag
10from core.models.service import LeastLoadedNodeScheduler
Scott Bakerfa5cdd62015-04-20 09:16:17 -070011import traceback
Scott Baker7f8ef8f2015-04-20 14:24:29 -070012from xos.exceptions import *
Scott Bakere9ff7ce2015-04-14 17:19:16 -070013
14"""
15import os
16import sys
17sys.path.append("/opt/xos")
18os.environ.setdefault("DJANGO_SETTINGS_MODULE", "xos.settings")
19import django
Scott Bakerc749d622015-12-29 23:47:06 -080020from core.models import *
21from services.hpc.models import *
Scott Baker98f51552015-12-31 10:18:28 -080022from services.cord.models import *
Scott Bakere9ff7ce2015-04-14 17:19:16 -070023django.setup()
Scott Bakere9ff7ce2015-04-14 17:19:16 -070024
Scott Baker323eca92015-04-20 09:48:34 -070025t = VOLTTenant()
Scott Bakere9ff7ce2015-04-14 17:19:16 -070026t.caller = User.objects.all()[0]
27t.save()
28
Scott Bakerdfc0bef2015-05-11 08:31:24 -070029for v in VOLTTenant.get_tenant_objects().all():
Scott Bakerd4b48c02015-04-15 20:59:15 -070030 v.caller = User.objects.all()[0]
31 v.delete()
32
Scott Bakerdfc0bef2015-05-11 08:31:24 -070033for v in VCPETenant.get_tenant_objects().all():
Scott Bakere9ff7ce2015-04-14 17:19:16 -070034 v.caller = User.objects.all()[0]
35 v.delete()
Scott Bakerfa5cdd62015-04-20 09:16:17 -070036
Scott Bakerdfc0bef2015-05-11 08:31:24 -070037for v in VOLTTenant.get_tenant_objects().all():
Scott Bakerfa5cdd62015-04-20 09:16:17 -070038 v.caller = User.objects.all()[0]
39 v.delete()
Scott Bakerc633dc92015-05-05 17:49:46 -070040
Scott Bakerdfc0bef2015-05-11 08:31:24 -070041for v in VOLTTenant.get_tenant_objects().all():
Scott Bakerc633dc92015-05-05 17:49:46 -070042 if not v.creator:
43 v.creator= User.objects.all()[0]
44 v.save()
45
Scott Bakerdfc0bef2015-05-11 08:31:24 -070046for v in VCPETenant.get_tenant_objects().all():
Scott Bakerc633dc92015-05-05 17:49:46 -070047 if not v.creator:
48 v.creator= User.objects.all()[0]
49 v.save()
Scott Bakere9ff7ce2015-04-14 17:19:16 -070050"""
51
52class ConfigurationError(Exception):
53 pass
54
Scott Bakerd9133342015-07-06 14:38:02 -070055VOLT_KIND = "vOLT"
56VCPE_KIND = "vCPE"
57VBNG_KIND = "vBNG"
Scott Baker81de6402015-07-06 16:50:30 -070058CORD_SUBSCRIBER_KIND = "CordSubscriberRoot"
59
60# -------------------------------------------
61# CordSubscriberRoot
62# -------------------------------------------
63
64class CordSubscriberRoot(Subscriber):
Scott Bakere4364d12015-07-06 17:21:21 -070065 class Meta:
66 proxy = True
67
Scott Baker81de6402015-07-06 16:50:30 -070068 KIND = CORD_SUBSCRIBER_KIND
69
70 default_attributes = {"firewall_enable": False,
71 "firewall_rules": "accept all anywhere anywhere",
72 "url_filter_enable": False,
73 "url_filter_rules": "allow all",
74 "url_filter_level": "PG",
75 "cdn_enable": False,
Scott Baker126ad472015-07-07 17:59:44 -070076 "users": [],
77 "is_demo_user": False }
Scott Baker81de6402015-07-06 16:50:30 -070078
Scott Baker050f8b32015-07-07 12:15:03 -070079 sync_attributes = ("firewall_enable",
80 "firewall_rules",
81 "url_filter_enable",
82 "url_filter_rules",
83 "cdn_enable",)
84
Scott Baker81de6402015-07-06 16:50:30 -070085 def __init__(self, *args, **kwargs):
86 super(CordSubscriberRoot, self).__init__(*args, **kwargs)
87 self.cached_volt = None
Scott Baker050f8b32015-07-07 12:15:03 -070088 self._initial_url_filter_enable = self.url_filter_enable
Scott Baker81de6402015-07-06 16:50:30 -070089
90 @property
91 def volt(self):
92 volt = self.get_newest_subscribed_tenant(VOLTTenant)
93 if not volt:
94 return None
95
96 # always return the same object when possible
97 if (self.cached_volt) and (self.cached_volt.id == volt.id):
Scott Baker126ad472015-07-07 17:59:44 -070098 return self.cached_volt
Scott Baker81de6402015-07-06 16:50:30 -070099
Scott Bakere4364d12015-07-06 17:21:21 -0700100 #volt.caller = self.creator
Scott Baker81de6402015-07-06 16:50:30 -0700101 self.cached_volt = volt
102 return volt
103
104 @property
105 def firewall_enable(self):
106 return self.get_attribute("firewall_enable", self.default_attributes["firewall_enable"])
107
108 @firewall_enable.setter
109 def firewall_enable(self, value):
110 self.set_attribute("firewall_enable", value)
111
112 @property
113 def firewall_rules(self):
114 return self.get_attribute("firewall_rules", self.default_attributes["firewall_rules"])
115
116 @firewall_rules.setter
117 def firewall_rules(self, value):
118 self.set_attribute("firewall_rules", value)
119
120 @property
121 def url_filter_enable(self):
122 return self.get_attribute("url_filter_enable", self.default_attributes["url_filter_enable"])
123
124 @url_filter_enable.setter
125 def url_filter_enable(self, value):
126 self.set_attribute("url_filter_enable", value)
127
128 @property
129 def url_filter_level(self):
130 return self.get_attribute("url_filter_level", self.default_attributes["url_filter_level"])
131
132 @url_filter_level.setter
133 def url_filter_level(self, value):
134 self.set_attribute("url_filter_level", value)
135
136 @property
137 def url_filter_rules(self):
138 return self.get_attribute("url_filter_rules", self.default_attributes["url_filter_rules"])
139
140 @url_filter_rules.setter
141 def url_filter_rules(self, value):
142 self.set_attribute("url_filter_rules", value)
143
144 @property
145 def cdn_enable(self):
146 return self.get_attribute("cdn_enable", self.default_attributes["cdn_enable"])
147
148 @cdn_enable.setter
149 def cdn_enable(self, value):
150 self.set_attribute("cdn_enable", value)
151
152 @property
153 def users(self):
154 return self.get_attribute("users", self.default_attributes["users"])
155
156 @users.setter
157 def users(self, value):
158 self.set_attribute("users", value)
159
160 def find_user(self, uid):
161 uid = int(uid)
162 for user in self.users:
163 if user["id"] == uid:
164 return user
165 return None
166
167 def update_user(self, uid, **kwargs):
168 # kwargs may be "level" or "mac"
169 # Setting one of these to None will cause None to be stored in the db
170 uid = int(uid)
171 users = self.users
172 for user in users:
173 if user["id"] == uid:
174 for arg in kwargs.keys():
175 user[arg] = kwargs[arg]
176 self.users = users
177 return user
178 raise ValueError("User %d not found" % uid)
179
180 def create_user(self, **kwargs):
181 if "name" not in kwargs:
182 raise XOSMissingField("The name field is required")
183
184 for user in self.users:
185 if kwargs["name"] == user["name"]:
186 raise XOSDuplicateKey("User %s already exists" % kwargs["name"])
187
188 uids = [x["id"] for x in self.users]
189 if uids:
190 uid = max(uids)+1
191 else:
192 uid = 0
193 newuser = kwargs.copy()
194 newuser["id"] = uid
195
196 users = self.users
197 users.append(newuser)
198 self.users = users
199
200 return newuser
201
202 def delete_user(self, uid):
203 uid = int(uid)
204 users = self.users
205 for user in users:
206 if user["id"]==uid:
207 users.remove(user)
208 self.users = users
209 return
210
211 raise ValueError("Users %d not found" % uid)
212
213 @property
214 def services(self):
215 return {"cdn": self.cdn_enable,
216 "url_filter": self.url_filter_enable,
217 "firewall": self.firewall_enable}
218
219 @services.setter
220 def services(self, value):
221 pass
Scott Bakerd9133342015-07-06 14:38:02 -0700222
Scott Baker050f8b32015-07-07 12:15:03 -0700223 def save(self, *args, **kwargs):
Scott Bakerfe38c2a2015-07-24 18:56:57 -0700224 if (not hasattr(self, 'caller') or not self.caller.is_admin):
225 if (self.has_field_changed("service_specific_id")):
226 raise XOSPermissionDenied("You do not have permission to change service_specific_id")
Scott Baker050f8b32015-07-07 12:15:03 -0700227 super(CordSubscriberRoot, self).save(*args, **kwargs)
228 if (self.volt) and (self.volt.vcpe): # and (self._initial_url_filter_enabled != self.url_filter_enable):
229 # 1) trigger manage_bbs_account to run
230 # 2) trigger vcpe observer to wake up
231 self.volt.vcpe.save()
232
Scott Baker126ad472015-07-07 17:59:44 -0700233 @property
234 def is_demo_user(self):
235 return self.get_attribute("is_demo_user", self.default_attributes["is_demo_user"])
236
237 @is_demo_user.setter
238 def is_demo_user(self, value):
239 self.set_attribute("is_demo_user", value)
240
Scott Bakerd4b48c02015-04-15 20:59:15 -0700241# -------------------------------------------
242# VOLT
243# -------------------------------------------
244
245class VOLTService(Service):
Scott Bakerd9133342015-07-06 14:38:02 -0700246 KIND = VOLT_KIND
Scott Bakerd4b48c02015-04-15 20:59:15 -0700247
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700248 class Meta:
Scott Bakerd4b48c02015-04-15 20:59:15 -0700249 app_label = "cord"
250 verbose_name = "vOLT Service"
251 proxy = True
252
253class VOLTTenant(Tenant):
254 class Meta:
255 proxy = True
256
Scott Bakerd9133342015-07-06 14:38:02 -0700257 KIND = VOLT_KIND
Scott Bakerd4b48c02015-04-15 20:59:15 -0700258
Scott Bakerf1527cd2015-11-09 20:25:21 -0800259 default_attributes = {"vlan_id": None, "s_tag": None, "c_tag": None}
Scott Baker323eca92015-04-20 09:48:34 -0700260 def __init__(self, *args, **kwargs):
261 volt_services = VOLTService.get_service_objects().all()
262 if volt_services:
263 self._meta.get_field("provider_service").default = volt_services[0].id
264 super(VOLTTenant, self).__init__(*args, **kwargs)
Scott Bakerd9133342015-07-06 14:38:02 -0700265 self.cached_vcpe = None
Scott Baker868dabf2015-06-24 12:54:24 -0700266
Scott Bakerd4b48c02015-04-15 20:59:15 -0700267 @property
Scott Bakerf1527cd2015-11-09 20:25:21 -0800268 def s_tag(self):
269 return self.get_attribute("s_tag", self.default_attributes["s_tag"])
270
271 @s_tag.setter
272 def s_tag(self, value):
273 self.set_attribute("s_tag", value)
274
275 @property
276 def c_tag(self):
277 return self.get_attribute("c_tag", self.default_attributes["c_tag"])
278
279 @c_tag.setter
280 def c_tag(self, value):
281 self.set_attribute("c_tag", value)
282
283 # for now, vlan_id is a synonym for c_tag
284
285 @property
Scott Baker679f7022015-04-20 11:50:09 -0700286 def vlan_id(self):
Scott Bakerf1527cd2015-11-09 20:25:21 -0800287 return self.c_tag
Scott Baker679f7022015-04-20 11:50:09 -0700288
289 @vlan_id.setter
290 def vlan_id(self, value):
Scott Bakerf1527cd2015-11-09 20:25:21 -0800291 self.c_tag = value
Scott Baker679f7022015-04-20 11:50:09 -0700292
293 @property
Scott Bakerd4b48c02015-04-15 20:59:15 -0700294 def vcpe(self):
Scott Bakerd9133342015-07-06 14:38:02 -0700295 vcpe = self.get_newest_subscribed_tenant(VCPETenant)
296 if not vcpe:
297 return None
298
299 # always return the same object when possible
300 if (self.cached_vcpe) and (self.cached_vcpe.id == vcpe.id):
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700301 return self.cached_vcpe
Scott Bakerd9133342015-07-06 14:38:02 -0700302
Scott Bakerc633dc92015-05-05 17:49:46 -0700303 vcpe.caller = self.creator
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700304 self.cached_vcpe = vcpe
305 return vcpe
Scott Bakerd4b48c02015-04-15 20:59:15 -0700306
307 @vcpe.setter
308 def vcpe(self, value):
Scott Bakere4364d12015-07-06 17:21:21 -0700309 raise XOSConfigurationError("vOLT.vCPE cannot be set this way -- create a new vCPE object and set its subscriber_tenant instead")
310
311 @property
312 def subscriber(self):
313 if not self.subscriber_root:
314 return None
315 subs = CordSubscriberRoot.objects.filter(id=self.subscriber_root.id)
316 if not subs:
317 return None
318 return subs[0]
Scott Bakerd4b48c02015-04-15 20:59:15 -0700319
Scott Bakerc633dc92015-05-05 17:49:46 -0700320 @property
321 def creator(self):
322 if getattr(self, "cached_creator", None):
323 return self.cached_creator
324 creator_id=self.get_attribute("creator_id")
325 if not creator_id:
326 return None
327 users=User.objects.filter(id=creator_id)
328 if not users:
329 return None
330 user=users[0]
331 self.cached_creator = users[0]
332 return user
333
334 @creator.setter
335 def creator(self, value):
336 if value:
337 value = value.id
338 if (value != self.get_attribute("creator_id", None)):
339 self.cached_creator=None
340 self.set_attribute("creator_id", value)
341
Scott Bakerd4b48c02015-04-15 20:59:15 -0700342 def manage_vcpe(self):
343 # Each VOLT object owns exactly one VCPE object
344
345 if self.deleted:
346 return
347
348 if self.vcpe is None:
349 vcpeServices = VCPEService.get_service_objects().all()
350 if not vcpeServices:
Scott Baker7f8ef8f2015-04-20 14:24:29 -0700351 raise XOSConfigurationError("No VCPE Services available")
Scott Bakerd4b48c02015-04-15 20:59:15 -0700352
353 vcpe = VCPETenant(provider_service = vcpeServices[0],
354 subscriber_tenant = self)
Scott Bakerc633dc92015-05-05 17:49:46 -0700355 vcpe.caller = self.creator
Scott Bakerd4b48c02015-04-15 20:59:15 -0700356 vcpe.save()
357
Scott Baker050f8b32015-07-07 12:15:03 -0700358 def manage_subscriber(self):
359 if (self.subscriber_root is None):
360 # The vOLT is not connected to a Subscriber, so either find an
361 # existing subscriber with the same SSID, or autogenerate a new
362 # subscriber.
363 #
364 # TODO: This probably goes away when we rethink the ONOS-to-XOS
365 # vOLT API.
366
367 subs = CordSubscriberRoot.get_tenant_objects().filter(service_specific_id = self.service_specific_id)
368 if subs:
369 sub = subs[0]
370 else:
371 sub = CordSubscriberRoot(service_specific_id = self.service_specific_id,
372 name = "autogenerated-for-vOLT-%s" % self.id)
373 sub.save()
374 self.subscriber_root = sub
375 self.save()
376
Scott Bakerd4b48c02015-04-15 20:59:15 -0700377 def cleanup_vcpe(self):
378 if self.vcpe:
Scott Bakerd9133342015-07-06 14:38:02 -0700379 # print "XXX cleanup vcpe", self.vcpe
Scott Bakerd4b48c02015-04-15 20:59:15 -0700380 self.vcpe.delete()
Scott Bakerd4b48c02015-04-15 20:59:15 -0700381
Scott Baker868dabf2015-06-24 12:54:24 -0700382 def cleanup_orphans(self):
Scott Bakerd9133342015-07-06 14:38:02 -0700383 # ensure vOLT only has one vCPE
384 cur_vcpe = self.vcpe
385 for vcpe in list(self.get_subscribed_tenants(VCPETenant)):
386 if (not cur_vcpe) or (vcpe.id != cur_vcpe.id):
387 # print "XXX clean up orphaned vcpe", vcpe
388 vcpe.delete()
Scott Baker868dabf2015-06-24 12:54:24 -0700389
Scott Bakerd4b48c02015-04-15 20:59:15 -0700390 def save(self, *args, **kwargs):
Scott Baker7f8ef8f2015-04-20 14:24:29 -0700391 self.validate_unique_service_specific_id()
392
Scott Baker050f8b32015-07-07 12:15:03 -0700393 if (self.subscriber_root is not None):
394 subs = self.subscriber_root.get_subscribed_tenants(VOLTTenant)
395 if (subs) and (self not in subs):
396 raise XOSDuplicateKey("Subscriber should only be linked to one vOLT")
397
Scott Bakerc633dc92015-05-05 17:49:46 -0700398 if not self.creator:
399 if not getattr(self, "caller", None):
400 # caller must be set when creating a vCPE since it creates a slice
401 raise XOSProgrammingError("VOLTTenant's self.caller was not set")
402 self.creator = self.caller
403 if not self.creator:
404 raise XOSProgrammingError("VOLTTenant's self.creator was not set")
405
Scott Bakerd4b48c02015-04-15 20:59:15 -0700406 super(VOLTTenant, self).save(*args, **kwargs)
Scott Baker192da222015-07-08 19:01:56 -0700407 model_policy_volt(self.pk)
408 #self.manage_vcpe()
409 #self.manage_subscriber()
410 #self.cleanup_orphans()
Scott Bakerd4b48c02015-04-15 20:59:15 -0700411
412 def delete(self, *args, **kwargs):
413 self.cleanup_vcpe()
414 super(VOLTTenant, self).delete(*args, **kwargs)
415
Scott Baker192da222015-07-08 19:01:56 -0700416def model_policy_volt(pk):
417 # TODO: this should be made in to a real model_policy
418 with transaction.atomic():
419 volt = VOLTTenant.objects.select_for_update().filter(pk=pk)
420 if not volt:
421 return
422 volt = volt[0]
423 volt.manage_vcpe()
424 volt.manage_subscriber()
425 volt.cleanup_orphans()
426
Scott Bakerd4b48c02015-04-15 20:59:15 -0700427# -------------------------------------------
428# VCPE
429# -------------------------------------------
430
431class VCPEService(Service):
Scott Bakerd9133342015-07-06 14:38:02 -0700432 KIND = VCPE_KIND
Scott Bakerd4b48c02015-04-15 20:59:15 -0700433
Scott Baker2b56cf42015-07-15 18:08:06 -0700434 simple_attributes = ( ("bbs_api_hostname", None),
435 ("bbs_api_port", None),
Scott Baker80157da2015-07-15 17:42:43 -0700436 ("bbs_server", None),
Scott Bakerd4829ea2015-07-15 18:04:22 -0700437 ("backend_network_label", "hpc_client"), )
Scott Baker62312972015-07-13 14:30:25 -0700438
439 def __init__(self, *args, **kwargs):
440 super(VCPEService, self).__init__(*args, **kwargs)
441
Scott Bakerd4b48c02015-04-15 20:59:15 -0700442 class Meta:
443 app_label = "cord"
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700444 verbose_name = "vCPE Service"
Scott Bakerd4b48c02015-04-15 20:59:15 -0700445 proxy = True
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700446
Scott Baker4e6d60d2015-05-20 20:45:11 -0700447 def allocate_bbs_account(self):
448 vcpes = VCPETenant.get_tenant_objects().all()
449 bbs_accounts = [vcpe.bbs_account for vcpe in vcpes]
450
451 # There's a bit of a race here; some other user could be trying to
452 # allocate a bbs_account at the same time we are.
453
Scott Baker2f0b3462015-06-09 12:03:56 -0700454 for i in range(2,21):
Scott Baker4e6d60d2015-05-20 20:45:11 -0700455 account_name = "bbs%02d@onlab.us" % i
456 if (account_name not in bbs_accounts):
457 return account_name
458
459 raise XOSConfigurationError("We've run out of available broadbandshield accounts. Delete some vcpe and try again.")
460
Scott Baker80157da2015-07-15 17:42:43 -0700461 @property
462 def bbs_slice(self):
463 bbs_slice_id=self.get_attribute("bbs_slice_id")
464 if not bbs_slice_id:
465 return None
466 bbs_slices=Slice.objects.filter(id=bbs_slice_id)
467 if not bbs_slices:
468 return None
469 return bbs_slices[0]
470
471 @bbs_slice.setter
472 def bbs_slice(self, value):
473 if value:
474 value = value.id
475 self.set_attribute("bbs_slice_id", value)
476
Scott Baker62312972015-07-13 14:30:25 -0700477VCPEService.setup_simple_attributes()
478
Scott Baker5b8eb412016-02-02 16:56:18 -0800479#class STagBlock(PlCoreBase):
480# instance = models.ForeignKey(Instance, related_name="s_tags")
481# s_tag = models.CharField(null=false, blank=false, unique=true, max_length=10)
482# #c_tags = models.TextField(null=true, blank=true)
483#
484# def __unicode__(self): return u'%s' % (self.s_tag)
Scott Baker62312972015-07-13 14:30:25 -0700485
Scott Bakerc1584b82015-09-09 16:36:06 -0700486class VCPETenant(TenantWithContainer):
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700487 class Meta:
488 proxy = True
489
Scott Bakerd9133342015-07-06 14:38:02 -0700490 KIND = VCPE_KIND
Scott Bakerd4b48c02015-04-15 20:59:15 -0700491
Scott Baker92a81d42015-09-09 10:57:16 -0700492 sync_attributes = ("nat_ip", "nat_mac",
493 "lan_ip", "lan_mac",
Andy Bavier733733d2015-10-29 14:01:47 -0400494 "wan_ip", "wan_mac", "wan_container_mac",
Scott Baker92a81d42015-09-09 10:57:16 -0700495 "private_ip", "private_mac",
496 "hpc_client_ip", "hpc_client_mac")
Scott Bakerc633dc92015-05-05 17:49:46 -0700497
Tony Mackd8515472015-08-19 11:58:18 -0400498 default_attributes = {"instance_id": None,
Scott Baker4b206972015-11-02 20:55:07 -0800499 "container_id": None,
Scott Baker4e6d60d2015-05-20 20:45:11 -0700500 "users": [],
Scott Baker4aa660e2015-06-09 12:22:29 -0700501 "bbs_account": None,
502 "last_ansible_hash": None}
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700503
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700504 def __init__(self, *args, **kwargs):
505 super(VCPETenant, self).__init__(*args, **kwargs)
506 self.cached_vbng=None
Scott Bakerc633dc92015-05-05 17:49:46 -0700507
508 @property
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700509 def vbng(self):
Scott Bakerd9133342015-07-06 14:38:02 -0700510 vbng = self.get_newest_subscribed_tenant(VBNGTenant)
511 if not vbng:
512 return None
513
514 # always return the same object when possible
515 if (self.cached_vbng) and (self.cached_vbng.id == vbng.id):
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700516 return self.cached_vbng
Scott Bakerd9133342015-07-06 14:38:02 -0700517
Scott Bakerc633dc92015-05-05 17:49:46 -0700518 vbng.caller = self.creator
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700519 self.cached_vbng = vbng
520 return vbng
521
522 @vbng.setter
523 def vbng(self, value):
Scott Bakerd9133342015-07-06 14:38:02 -0700524 raise XOSConfigurationError("vCPE.vBNG cannot be set this way -- create a new vBNG object and set it's subscriber_tenant instead")
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700525
Scott Bakere4364d12015-07-06 17:21:21 -0700526 @property
527 def volt(self):
528 if not self.subscriber_tenant:
529 return None
530 volts = VOLTTenant.objects.filter(id=self.subscriber_tenant.id)
531 if not volts:
532 return None
533 return volts[0]
534
Scott Baker81de6402015-07-06 16:50:30 -0700535 @property
536 def bbs_account(self):
537 return self.get_attribute("bbs_account", self.default_attributes["bbs_account"])
538
539 @bbs_account.setter
540 def bbs_account(self, value):
541 return self.set_attribute("bbs_account", value)
542
543 @property
544 def last_ansible_hash(self):
545 return self.get_attribute("last_ansible_hash", self.default_attributes["last_ansible_hash"])
546
547 @last_ansible_hash.setter
548 def last_ansible_hash(self, value):
549 return self.set_attribute("last_ansible_hash", value)
550
551 @property
552 def ssh_command(self):
Tony Mackd8515472015-08-19 11:58:18 -0400553 if self.instance:
554 return self.instance.get_ssh_command()
Scott Baker81de6402015-07-06 16:50:30 -0700555 else:
Tony Mackd8515472015-08-19 11:58:18 -0400556 return "no-instance"
Scott Baker81de6402015-07-06 16:50:30 -0700557
558 @ssh_command.setter
559 def ssh_command(self, value):
560 pass
561
Scott Baker5571c692015-05-20 08:19:25 -0700562 @property
563 def addresses(self):
Scott Baker4b206972015-11-02 20:55:07 -0800564 if self.instance:
565 ports = self.instance.ports.all()
566 elif self.container:
567 ports = self.container.ports.all()
568 else:
Scott Baker5571c692015-05-20 08:19:25 -0700569 return {}
570
571 addresses = {}
Scott Baker4b206972015-11-02 20:55:07 -0800572 for ns in ports:
Scott Baker5571c692015-05-20 08:19:25 -0700573 if "lan" in ns.network.name.lower():
Scott Baker92a81d42015-09-09 10:57:16 -0700574 addresses["lan"] = (ns.ip, ns.mac)
Scott Baker5571c692015-05-20 08:19:25 -0700575 elif "wan" in ns.network.name.lower():
Scott Baker92a81d42015-09-09 10:57:16 -0700576 addresses["wan"] = (ns.ip, ns.mac)
Scott Baker5571c692015-05-20 08:19:25 -0700577 elif "private" in ns.network.name.lower():
Scott Baker92a81d42015-09-09 10:57:16 -0700578 addresses["private"] = (ns.ip, ns.mac)
Scott Baker5571c692015-05-20 08:19:25 -0700579 elif "nat" in ns.network.name.lower():
Scott Baker92a81d42015-09-09 10:57:16 -0700580 addresses["nat"] = (ns.ip, ns.mac)
Scott Baker281b1af2015-06-04 10:26:44 -0700581 elif "hpc_client" in ns.network.name.lower():
Scott Baker92a81d42015-09-09 10:57:16 -0700582 addresses["hpc_client"] = (ns.ip, ns.mac)
Scott Baker5571c692015-05-20 08:19:25 -0700583 return addresses
584
Scott Baker432d1402015-05-20 08:25:29 -0700585 @property
586 def nat_ip(self):
Scott Baker92a81d42015-09-09 10:57:16 -0700587 return self.addresses.get("nat", (None,None) )[0]
588
589 @property
590 def nat_mac(self):
591 return self.addresses.get("nat", (None,None) )[1]
Scott Baker432d1402015-05-20 08:25:29 -0700592
593 @property
594 def lan_ip(self):
Scott Baker92a81d42015-09-09 10:57:16 -0700595 return self.addresses.get("lan", (None, None) )[0]
596
597 @property
598 def lan_mac(self):
599 return self.addresses.get("lan", (None, None) )[1]
Scott Baker432d1402015-05-20 08:25:29 -0700600
601 @property
602 def wan_ip(self):
Scott Baker92a81d42015-09-09 10:57:16 -0700603 return self.addresses.get("wan", (None, None) )[0]
Scott Baker432d1402015-05-20 08:25:29 -0700604
605 @property
Scott Baker4f972592015-06-05 12:08:34 -0700606 def wan_mac(self):
Andy Bavier4c7e76d2015-09-09 18:06:30 -0400607 return self.addresses.get("wan", (None, None) )[1]
Scott Baker4f972592015-06-05 12:08:34 -0700608
Andy Bavier733733d2015-10-29 14:01:47 -0400609 # Generate the MAC for the container interface connected to WAN
610 @property
611 def wan_container_mac(self):
612 (a, b, c, d) = self.wan_ip.split('.')
613 return "02:42:%02x:%02x:%02x:%02x" % (int(a), int(b), int(c), int(d))
614
Scott Baker4f972592015-06-05 12:08:34 -0700615 @property
Scott Baker432d1402015-05-20 08:25:29 -0700616 def private_ip(self):
Scott Baker92a81d42015-09-09 10:57:16 -0700617 return self.addresses.get("private", (None, None) )[0]
618
619 @property
620 def private_mac(self):
621 return self.addresses.get("private", (None, None) )[1]
Scott Baker432d1402015-05-20 08:25:29 -0700622
Scott Baker281b1af2015-06-04 10:26:44 -0700623 @property
624 def hpc_client_ip(self):
Scott Baker92a81d42015-09-09 10:57:16 -0700625 return self.addresses.get("hpc_client", (None, None) )[0]
626
627 @property
628 def hpc_client_mac(self):
629 return self.addresses.get("hpc_client", (None, None) )[1]
Scott Baker281b1af2015-06-04 10:26:44 -0700630
Scott Bakerd517a102015-06-09 12:30:30 -0700631 @property
632 def is_synced(self):
633 return (self.enacted is not None) and (self.enacted >= self.updated)
634
635 @is_synced.setter
636 def is_synced(self, value):
637 pass
638
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700639 def manage_vbng(self):
640 # Each vCPE object owns exactly one vBNG object
641
642 if self.deleted:
643 return
644
645 if self.vbng is None:
646 vbngServices = VBNGService.get_service_objects().all()
647 if not vbngServices:
Scott Baker7f8ef8f2015-04-20 14:24:29 -0700648 raise XOSConfigurationError("No VBNG Services available")
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700649
650 vbng = VBNGTenant(provider_service = vbngServices[0],
651 subscriber_tenant = self)
Scott Bakerc633dc92015-05-05 17:49:46 -0700652 vbng.caller = self.creator
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700653 vbng.save()
654
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700655 def cleanup_vbng(self):
656 if self.vbng:
Scott Bakerd9133342015-07-06 14:38:02 -0700657 # print "XXX cleanup vnbg", self.vbng
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700658 self.vbng.delete()
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700659
Scott Baker868dabf2015-06-24 12:54:24 -0700660 def cleanup_orphans(self):
Scott Bakerd9133342015-07-06 14:38:02 -0700661 # ensure vCPE only has one vBNG
662 cur_vbng = self.vbng
663 for vbng in list(self.get_subscribed_tenants(VBNGTenant)):
664 if (not cur_vbng) or (vbng.id != cur_vbng.id):
665 # print "XXX clean up orphaned vbng", vbng
666 vbng.delete()
Scott Baker868dabf2015-06-24 12:54:24 -0700667
Tony Mackd8515472015-08-19 11:58:18 -0400668 if self.orig_instance_id and (self.orig_instance_id != self.get_attribute("instance_id")):
669 instances=Instance.objects.filter(id=self.orig_instance_id)
670 if instances:
671 # print "XXX clean up orphaned instance", instances[0]
672 instances[0].delete()
Scott Baker868dabf2015-06-24 12:54:24 -0700673
Scott Baker5b8eb412016-02-02 16:56:18 -0800674 def get_slice(self):
675 if not self.provider_service.slices.count():
676 raise XOSConfigurationError("The service has no slices")
677 slice = self.provider_service.slices.all()[0]
678 return slice
679
680 def find_instance_for_s_tag(self, s_tag):
681 #s_tags = STagBlock.objects.find(s_s_tag)
682 #if s_tags:
683 # return s_tags[0].instance
684
685 tags = Tag.objects.filter(name="s_tag", value=s_tag)
686 if tags:
687 return tags[0].content_object
688
689 return None
690
691 def find_or_make_instance_for_s_tag(self, s_tag):
692 instance = self.find_instance_for_s_tag(self.volt.s_tag)
693 if instance:
694 return instance
695
696 flavors = Flavor.objects.filter(name="m1.small")
697 if not flavors:
698 raise XOSConfigurationError("No m1.small flavor")
699
700 slice = self.provider_service.slices.all()[0]
701
702 if slice.default_isolation == "container_vm":
703 (node, parent) = ContainerVmScheduler(slice).pick()
704 else:
705 (node, parent) = LeastLoadedNodeScheduler(slice).pick()
706
707 instance = Instance(slice = slice,
708 node = node,
709 image = self.image,
710 creator = self.creator,
711 deployment = node.site_deployment.deployment,
712 flavor = flavors[0],
713 isolation = slice.default_isolation,
714 parent = parent)
715 self.save_instance(instance)
716
717 return instance
718
719 def manage_container(self):
720 from core.models import Instance, Flavor
721
722 if self.deleted:
723 return
724
725 # For container or container_vm isolation, use what TenantWithCotnainer
726 # provides us
727 slice = self.get_slice()
728 if slice.default_isolation in ["container_vm", "container"]:
729 super(VCPETenant,self).manage_container()
730 return
731
732 if not self.volt:
733 raise XOSConfigurationError("This vCPE container has no volt")
734
735 instance = self.find_or_make_instance_for_s_tag(self.volt.s_tag)
736 self.instance = instance
737 super(TenantWithContainer, self).save()
738
739 def cleanup_container(self):
740 if self.get_slice().default_isolation in ["container_vm", "container"]:
741 super(VCPETenant,self).cleanup_container()
742
743 # To-do: cleanup unused instances
744 pass
745
Scott Baker4e6d60d2015-05-20 20:45:11 -0700746 def manage_bbs_account(self):
747 if self.deleted:
748 return
749
Scott Baker126ad472015-07-07 17:59:44 -0700750 if self.volt and self.volt.subscriber and self.volt.subscriber.url_filter_enable:
Scott Baker642126f2015-05-20 20:57:28 -0700751 if not self.bbs_account:
752 # make sure we use the proxied VCPEService object, not the generic Service object
753 vcpe_service = VCPEService.objects.get(id=self.provider_service.id)
Scott Baker050f8b32015-07-07 12:15:03 -0700754 self.bbs_account = vcpe_service.allocate_bbs_account()
Scott Baker642126f2015-05-20 20:57:28 -0700755 super(VCPETenant, self).save()
756 else:
757 if self.bbs_account:
758 self.bbs_account = None
759 super(VCPETenant, self).save()
Scott Baker4e6d60d2015-05-20 20:45:11 -0700760
Scott Baker839daa82015-11-16 22:53:49 -0800761 def find_or_make_port(self, instance, network, **kwargs):
762 port = Port.objects.filter(instance=instance, network=network)
763 if port:
764 port = port[0]
765 else:
766 port = Port(instance=instance, network=network, **kwargs)
767 port.save()
768 return port
769
770 def save_instance(self, instance):
771 with transaction.atomic():
Andy Bavier1aa49af2015-12-16 14:10:01 -0500772 instance.volumes = "/etc/dnsmasq.d,/etc/ufw"
Scott Baker839daa82015-11-16 22:53:49 -0800773 super(VCPETenant, self).save_instance(instance)
774
775 if instance.isolation in ["container", "container_vm"]:
776 lan_networks = [x for x in instance.slice.networks.all() if "lan" in x.name]
777 if not lan_networks:
778 raise XOSProgrammingError("No lan_network")
779 port = self.find_or_make_port(instance, lan_networks[0], ip="192.168.0.1", port_id="unmanaged")
780 port.set_parameter("c_tag", self.volt.c_tag)
781 port.set_parameter("s_tag", self.volt.s_tag)
782 port.set_parameter("device", "eth1")
Scott Bakere2920b22015-11-19 16:51:27 -0800783 port.set_parameter("bridge", "br-lan")
Scott Baker839daa82015-11-16 22:53:49 -0800784
785 wan_networks = [x for x in instance.slice.networks.all() if "wan" in x.name]
786 if not wan_networks:
787 raise XOSProgrammingError("No wan_network")
788 port = self.find_or_make_port(instance, wan_networks[0])
789 port.set_parameter("next_hop", value="10.0.1.253") # FIX ME
790 port.set_parameter("device", "eth0")
791
Scott Baker5b8eb412016-02-02 16:56:18 -0800792 # tag the instance with the s-tag, so we can easily find the
793 # instance later
794 if self.volt and self.volt.s_tag:
795 tags = Tag.objects.filter(name="s_tag", value=self.volt.s_tag)
796 if not tags:
797 tag = Tag(service=self.provider_service, content_object=instance, name="s_tag", value=self.volt.s_tag)
798 tag.save()
799
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700800 def save(self, *args, **kwargs):
Scott Bakerc633dc92015-05-05 17:49:46 -0700801 if not self.creator:
802 if not getattr(self, "caller", None):
803 # caller must be set when creating a vCPE since it creates a slice
Scott Bakerf6790db2015-05-06 15:46:34 -0700804 raise XOSProgrammingError("VCPETenant's self.caller was not set")
Scott Bakerc633dc92015-05-05 17:49:46 -0700805 self.creator = self.caller
806 if not self.creator:
Scott Bakerf6790db2015-05-06 15:46:34 -0700807 raise XOSProgrammingError("VCPETenant's self.creator was not set")
Scott Bakerc633dc92015-05-05 17:49:46 -0700808
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700809 super(VCPETenant, self).save(*args, **kwargs)
Scott Baker192da222015-07-08 19:01:56 -0700810 model_policy_vcpe(self.pk)
Tony Mackd8515472015-08-19 11:58:18 -0400811 #self.manage_instance()
Scott Baker192da222015-07-08 19:01:56 -0700812 #self.manage_vbng()
813 #self.manage_bbs_account()
814 #self.cleanup_orphans()
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700815
816 def delete(self, *args, **kwargs):
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700817 self.cleanup_vbng()
Scott Bakerc1584b82015-09-09 16:36:06 -0700818 self.cleanup_container()
Scott Bakere9ff7ce2015-04-14 17:19:16 -0700819 super(VCPETenant, self).delete(*args, **kwargs)
820
Scott Baker192da222015-07-08 19:01:56 -0700821def model_policy_vcpe(pk):
822 # TODO: this should be made in to a real model_policy
823 with transaction.atomic():
824 vcpe = VCPETenant.objects.select_for_update().filter(pk=pk)
825 if not vcpe:
826 return
827 vcpe = vcpe[0]
Scott Bakerc1584b82015-09-09 16:36:06 -0700828 vcpe.manage_container()
Scott Baker192da222015-07-08 19:01:56 -0700829 vcpe.manage_vbng()
830 vcpe.manage_bbs_account()
831 vcpe.cleanup_orphans()
832
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700833#----------------------------------------------------------------------------
834# vBNG
835#----------------------------------------------------------------------------
836
837class VBNGService(Service):
Scott Bakerd9133342015-07-06 14:38:02 -0700838 KIND = VBNG_KIND
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700839
Scott Baker6667ddc2015-10-20 22:12:51 -0700840 simple_attributes = ( ("vbng_url", ""), ) # "http://10.0.3.136:8181/onos/virtualbng/"
Scott Baker21d18932015-07-21 18:24:21 -0700841
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700842 class Meta:
843 app_label = "cord"
844 verbose_name = "vBNG Service"
845 proxy = True
846
Scott Baker21d18932015-07-21 18:24:21 -0700847VBNGService.setup_simple_attributes()
848
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700849class VBNGTenant(Tenant):
850 class Meta:
851 proxy = True
852
Scott Bakerd9133342015-07-06 14:38:02 -0700853 KIND = VBNG_KIND
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700854
Scott Baker61c8e8d2015-06-02 14:34:04 -0700855 default_attributes = {"routeable_subnet": "",
Scott Bakercf155f42015-06-08 19:09:53 -0700856 "mapped_ip": "",
857 "mapped_mac": "",
858 "mapped_hostname": ""}
Scott Bakerfa5cdd62015-04-20 09:16:17 -0700859
860 @property
861 def routeable_subnet(self):
862 return self.get_attribute("routeable_subnet", self.default_attributes["routeable_subnet"])
863
864 @routeable_subnet.setter
865 def routeable_subnet(self, value):
866 self.set_attribute("routeable_subnet", value)
Scott Baker61c8e8d2015-06-02 14:34:04 -0700867
868 @property
869 def mapped_ip(self):
870 return self.get_attribute("mapped_ip", self.default_attributes["mapped_ip"])
871
872 @mapped_ip.setter
873 def mapped_ip(self, value):
874 self.set_attribute("mapped_ip", value)
Scott Bakercf155f42015-06-08 19:09:53 -0700875
876 @property
877 def mapped_mac(self):
878 return self.get_attribute("mapped_mac", self.default_attributes["mapped_mac"])
879
880 @mapped_mac.setter
881 def mapped_mac(self, value):
882 self.set_attribute("mapped_mac", value)
883
884 @property
885 def mapped_hostname(self):
886 return self.get_attribute("mapped_hostname", self.default_attributes["mapped_hostname"])
887
888 @mapped_hostname.setter
889 def mapped_hostname(self, value):
890 self.set_attribute("mapped_hostname", value)