| from django.db import models |
| from core.models import Service, PlCoreBase, Slice, Instance, Tenant, TenantWithContainer, Node, Image, User, Flavor, Subscriber |
| from core.models.plcorebase import StrippedCharField |
| import os |
| from django.db import models, transaction |
| from django.forms.models import model_to_dict |
| from django.db.models import Q |
| from operator import itemgetter, attrgetter, methodcaller |
| import traceback |
| from xos.exceptions import * |
| |
| """ |
| import os |
| import sys |
| sys.path.append("/opt/xos") |
| os.environ.setdefault("DJANGO_SETTINGS_MODULE", "xos.settings") |
| import django |
| from core.models import *
|
| from hpc.models import *
|
| from cord.models import *
|
| django.setup() |
| |
| t = VOLTTenant() |
| t.caller = User.objects.all()[0] |
| t.save() |
| |
| for v in VOLTTenant.get_tenant_objects().all(): |
| v.caller = User.objects.all()[0] |
| v.delete() |
| |
| for v in VCPETenant.get_tenant_objects().all(): |
| v.caller = User.objects.all()[0] |
| v.delete() |
| |
| for v in VOLTTenant.get_tenant_objects().all(): |
| v.caller = User.objects.all()[0] |
| v.delete() |
| |
| for v in VOLTTenant.get_tenant_objects().all(): |
| if not v.creator: |
| v.creator= User.objects.all()[0] |
| v.save() |
| |
| for v in VCPETenant.get_tenant_objects().all(): |
| if not v.creator: |
| v.creator= User.objects.all()[0] |
| v.save() |
| """ |
| |
| class ConfigurationError(Exception): |
| pass |
| |
| VOLT_KIND = "vOLT" |
| VCPE_KIND = "vCPE" |
| VBNG_KIND = "vBNG" |
| CORD_SUBSCRIBER_KIND = "CordSubscriberRoot" |
| |
| # ------------------------------------------- |
| # CordSubscriberRoot |
| # ------------------------------------------- |
| |
| class CordSubscriberRoot(Subscriber): |
| class Meta: |
| proxy = True |
| |
| KIND = CORD_SUBSCRIBER_KIND |
| |
| default_attributes = {"firewall_enable": False, |
| "firewall_rules": "accept all anywhere anywhere", |
| "url_filter_enable": False, |
| "url_filter_rules": "allow all", |
| "url_filter_level": "PG", |
| "cdn_enable": False, |
| "users": [], |
| "is_demo_user": False } |
| |
| sync_attributes = ("firewall_enable", |
| "firewall_rules", |
| "url_filter_enable", |
| "url_filter_rules", |
| "cdn_enable",) |
| |
| def __init__(self, *args, **kwargs): |
| super(CordSubscriberRoot, self).__init__(*args, **kwargs) |
| self.cached_volt = None |
| self._initial_url_filter_enable = self.url_filter_enable |
| |
| @property |
| def volt(self): |
| volt = self.get_newest_subscribed_tenant(VOLTTenant) |
| if not volt: |
| return None |
| |
| # always return the same object when possible |
| if (self.cached_volt) and (self.cached_volt.id == volt.id): |
| return self.cached_volt |
| |
| #volt.caller = self.creator |
| self.cached_volt = volt |
| return volt |
| |
| @property |
| def firewall_enable(self): |
| return self.get_attribute("firewall_enable", self.default_attributes["firewall_enable"]) |
| |
| @firewall_enable.setter |
| def firewall_enable(self, value): |
| self.set_attribute("firewall_enable", value) |
| |
| @property |
| def firewall_rules(self): |
| return self.get_attribute("firewall_rules", self.default_attributes["firewall_rules"]) |
| |
| @firewall_rules.setter |
| def firewall_rules(self, value): |
| self.set_attribute("firewall_rules", value) |
| |
| @property |
| def url_filter_enable(self): |
| return self.get_attribute("url_filter_enable", self.default_attributes["url_filter_enable"]) |
| |
| @url_filter_enable.setter |
| def url_filter_enable(self, value): |
| self.set_attribute("url_filter_enable", value) |
| |
| @property |
| def url_filter_level(self): |
| return self.get_attribute("url_filter_level", self.default_attributes["url_filter_level"]) |
| |
| @url_filter_level.setter |
| def url_filter_level(self, value): |
| self.set_attribute("url_filter_level", value) |
| |
| @property |
| def url_filter_rules(self): |
| return self.get_attribute("url_filter_rules", self.default_attributes["url_filter_rules"]) |
| |
| @url_filter_rules.setter |
| def url_filter_rules(self, value): |
| self.set_attribute("url_filter_rules", value) |
| |
| @property |
| def cdn_enable(self): |
| return self.get_attribute("cdn_enable", self.default_attributes["cdn_enable"]) |
| |
| @cdn_enable.setter |
| def cdn_enable(self, value): |
| self.set_attribute("cdn_enable", value) |
| |
| @property |
| def users(self): |
| return self.get_attribute("users", self.default_attributes["users"]) |
| |
| @users.setter |
| def users(self, value): |
| self.set_attribute("users", value) |
| |
| def find_user(self, uid): |
| uid = int(uid) |
| for user in self.users: |
| if user["id"] == uid: |
| return user |
| return None |
| |
| def update_user(self, uid, **kwargs): |
| # kwargs may be "level" or "mac" |
| # Setting one of these to None will cause None to be stored in the db |
| uid = int(uid) |
| users = self.users |
| for user in users: |
| if user["id"] == uid: |
| for arg in kwargs.keys(): |
| user[arg] = kwargs[arg] |
| self.users = users |
| return user |
| raise ValueError("User %d not found" % uid) |
| |
| def create_user(self, **kwargs): |
| if "name" not in kwargs: |
| raise XOSMissingField("The name field is required") |
| |
| for user in self.users: |
| if kwargs["name"] == user["name"]: |
| raise XOSDuplicateKey("User %s already exists" % kwargs["name"]) |
| |
| uids = [x["id"] for x in self.users] |
| if uids: |
| uid = max(uids)+1 |
| else: |
| uid = 0 |
| newuser = kwargs.copy() |
| newuser["id"] = uid |
| |
| users = self.users |
| users.append(newuser) |
| self.users = users |
| |
| return newuser |
| |
| def delete_user(self, uid): |
| uid = int(uid) |
| users = self.users |
| for user in users: |
| if user["id"]==uid: |
| users.remove(user) |
| self.users = users |
| return |
| |
| raise ValueError("Users %d not found" % uid) |
| |
| @property |
| def services(self): |
| return {"cdn": self.cdn_enable, |
| "url_filter": self.url_filter_enable, |
| "firewall": self.firewall_enable} |
| |
| @services.setter |
| def services(self, value): |
| pass |
| |
| def save(self, *args, **kwargs): |
| if (not hasattr(self, 'caller') or not self.caller.is_admin): |
| if (self.has_field_changed("service_specific_id")): |
| raise XOSPermissionDenied("You do not have permission to change service_specific_id") |
| super(CordSubscriberRoot, self).save(*args, **kwargs) |
| if (self.volt) and (self.volt.vcpe): # and (self._initial_url_filter_enabled != self.url_filter_enable): |
| # 1) trigger manage_bbs_account to run |
| # 2) trigger vcpe observer to wake up |
| self.volt.vcpe.save() |
| |
| @property |
| def is_demo_user(self): |
| return self.get_attribute("is_demo_user", self.default_attributes["is_demo_user"]) |
| |
| @is_demo_user.setter |
| def is_demo_user(self, value): |
| self.set_attribute("is_demo_user", value) |
| |
| # ------------------------------------------- |
| # VOLT |
| # ------------------------------------------- |
| |
| class VOLTService(Service): |
| KIND = VOLT_KIND |
| |
| class Meta: |
| app_label = "cord" |
| verbose_name = "vOLT Service" |
| proxy = True |
| |
| class VOLTTenant(Tenant): |
| class Meta: |
| proxy = True |
| |
| KIND = VOLT_KIND |
| |
| default_attributes = {"vlan_id": None, } |
| def __init__(self, *args, **kwargs): |
| volt_services = VOLTService.get_service_objects().all() |
| if volt_services: |
| self._meta.get_field("provider_service").default = volt_services[0].id |
| super(VOLTTenant, self).__init__(*args, **kwargs) |
| self.cached_vcpe = None |
| |
| @property |
| def vlan_id(self): |
| return self.get_attribute("vlan_id", self.default_attributes["vlan_id"]) |
| |
| @vlan_id.setter |
| def vlan_id(self, value): |
| self.set_attribute("vlan_id", value) |
| |
| @property |
| def vcpe(self): |
| vcpe = self.get_newest_subscribed_tenant(VCPETenant) |
| if not vcpe: |
| return None |
| |
| # always return the same object when possible |
| if (self.cached_vcpe) and (self.cached_vcpe.id == vcpe.id): |
| return self.cached_vcpe |
| |
| vcpe.caller = self.creator |
| self.cached_vcpe = vcpe |
| return vcpe |
| |
| @vcpe.setter |
| def vcpe(self, value): |
| raise XOSConfigurationError("vOLT.vCPE cannot be set this way -- create a new vCPE object and set its subscriber_tenant instead") |
| |
| @property |
| def subscriber(self): |
| if not self.subscriber_root: |
| return None |
| subs = CordSubscriberRoot.objects.filter(id=self.subscriber_root.id) |
| if not subs: |
| return None |
| return subs[0] |
| |
| @property |
| def creator(self): |
| if getattr(self, "cached_creator", None): |
| return self.cached_creator |
| creator_id=self.get_attribute("creator_id") |
| if not creator_id: |
| return None |
| users=User.objects.filter(id=creator_id) |
| if not users: |
| return None |
| user=users[0] |
| self.cached_creator = users[0] |
| return user |
| |
| @creator.setter |
| def creator(self, value): |
| if value: |
| value = value.id |
| if (value != self.get_attribute("creator_id", None)): |
| self.cached_creator=None |
| self.set_attribute("creator_id", value) |
| |
| def manage_vcpe(self): |
| # Each VOLT object owns exactly one VCPE object |
| |
| if self.deleted: |
| return |
| |
| if self.vcpe is None: |
| vcpeServices = VCPEService.get_service_objects().all() |
| if not vcpeServices: |
| raise XOSConfigurationError("No VCPE Services available") |
| |
| vcpe = VCPETenant(provider_service = vcpeServices[0], |
| subscriber_tenant = self) |
| vcpe.caller = self.creator |
| # vcpe.use_cobm = True # XXX XXX XXX remove before checking XXX XXX XXX |
| vcpe.save() |
| |
| def manage_subscriber(self): |
| if (self.subscriber_root is None): |
| # The vOLT is not connected to a Subscriber, so either find an |
| # existing subscriber with the same SSID, or autogenerate a new |
| # subscriber. |
| # |
| # TODO: This probably goes away when we rethink the ONOS-to-XOS |
| # vOLT API. |
| |
| subs = CordSubscriberRoot.get_tenant_objects().filter(service_specific_id = self.service_specific_id) |
| if subs: |
| sub = subs[0] |
| else: |
| sub = CordSubscriberRoot(service_specific_id = self.service_specific_id, |
| name = "autogenerated-for-vOLT-%s" % self.id) |
| sub.save() |
| self.subscriber_root = sub |
| self.save() |
| |
| def cleanup_vcpe(self): |
| if self.vcpe: |
| # print "XXX cleanup vcpe", self.vcpe |
| self.vcpe.delete() |
| |
| def cleanup_orphans(self): |
| # ensure vOLT only has one vCPE |
| cur_vcpe = self.vcpe |
| for vcpe in list(self.get_subscribed_tenants(VCPETenant)): |
| if (not cur_vcpe) or (vcpe.id != cur_vcpe.id): |
| # print "XXX clean up orphaned vcpe", vcpe |
| vcpe.delete() |
| |
| def save(self, *args, **kwargs): |
| self.validate_unique_service_specific_id() |
| |
| if (self.subscriber_root is not None): |
| subs = self.subscriber_root.get_subscribed_tenants(VOLTTenant) |
| if (subs) and (self not in subs): |
| raise XOSDuplicateKey("Subscriber should only be linked to one vOLT") |
| |
| if not self.creator: |
| if not getattr(self, "caller", None): |
| # caller must be set when creating a vCPE since it creates a slice |
| raise XOSProgrammingError("VOLTTenant's self.caller was not set") |
| self.creator = self.caller |
| if not self.creator: |
| raise XOSProgrammingError("VOLTTenant's self.creator was not set") |
| |
| super(VOLTTenant, self).save(*args, **kwargs) |
| model_policy_volt(self.pk) |
| #self.manage_vcpe() |
| #self.manage_subscriber() |
| #self.cleanup_orphans() |
| |
| def delete(self, *args, **kwargs): |
| self.cleanup_vcpe() |
| super(VOLTTenant, self).delete(*args, **kwargs) |
| |
| def model_policy_volt(pk): |
| # TODO: this should be made in to a real model_policy |
| with transaction.atomic(): |
| volt = VOLTTenant.objects.select_for_update().filter(pk=pk) |
| if not volt: |
| return |
| volt = volt[0] |
| volt.manage_vcpe() |
| volt.manage_subscriber() |
| volt.cleanup_orphans() |
| |
| # ------------------------------------------- |
| # VCPE |
| # ------------------------------------------- |
| |
| class VCPEService(Service): |
| KIND = VCPE_KIND |
| |
| simple_attributes = ( ("bbs_api_hostname", None), |
| ("bbs_api_port", None), |
| ("bbs_server", None), |
| ("backend_network_label", "hpc_client"), ) |
| |
| def __init__(self, *args, **kwargs): |
| super(VCPEService, self).__init__(*args, **kwargs) |
| |
| class Meta: |
| app_label = "cord" |
| verbose_name = "vCPE Service" |
| proxy = True |
| |
| def allocate_bbs_account(self): |
| vcpes = VCPETenant.get_tenant_objects().all() |
| bbs_accounts = [vcpe.bbs_account for vcpe in vcpes] |
| |
| # There's a bit of a race here; some other user could be trying to |
| # allocate a bbs_account at the same time we are. |
| |
| for i in range(2,21): |
| account_name = "bbs%02d@onlab.us" % i |
| if (account_name not in bbs_accounts): |
| return account_name |
| |
| raise XOSConfigurationError("We've run out of available broadbandshield accounts. Delete some vcpe and try again.") |
| |
| @property |
| def bbs_slice(self): |
| bbs_slice_id=self.get_attribute("bbs_slice_id") |
| if not bbs_slice_id: |
| return None |
| bbs_slices=Slice.objects.filter(id=bbs_slice_id) |
| if not bbs_slices: |
| return None |
| return bbs_slices[0] |
| |
| @bbs_slice.setter |
| def bbs_slice(self, value): |
| if value: |
| value = value.id |
| self.set_attribute("bbs_slice_id", value) |
| |
| VCPEService.setup_simple_attributes() |
| |
| |
| class VCPETenant(TenantWithContainer): |
| class Meta: |
| proxy = True |
| |
| KIND = VCPE_KIND |
| |
| sync_attributes = ("nat_ip", "nat_mac", |
| "lan_ip", "lan_mac", |
| "wan_ip", "wan_mac", "wan_container_mac", |
| "private_ip", "private_mac", |
| "hpc_client_ip", "hpc_client_mac") |
| |
| default_attributes = {"instance_id": None, |
| "container_id": None, |
| "users": [], |
| "bbs_account": None, |
| "last_ansible_hash": None} |
| |
| def __init__(self, *args, **kwargs): |
| super(VCPETenant, self).__init__(*args, **kwargs) |
| self.cached_vbng=None |
| |
| @property |
| def vbng(self): |
| vbng = self.get_newest_subscribed_tenant(VBNGTenant) |
| if not vbng: |
| return None |
| |
| # always return the same object when possible |
| if (self.cached_vbng) and (self.cached_vbng.id == vbng.id): |
| return self.cached_vbng |
| |
| vbng.caller = self.creator |
| self.cached_vbng = vbng |
| return vbng |
| |
| @vbng.setter |
| def vbng(self, value): |
| raise XOSConfigurationError("vCPE.vBNG cannot be set this way -- create a new vBNG object and set it's subscriber_tenant instead") |
| |
| @property |
| def volt(self): |
| if not self.subscriber_tenant: |
| return None |
| volts = VOLTTenant.objects.filter(id=self.subscriber_tenant.id) |
| if not volts: |
| return None |
| return volts[0] |
| |
| @property |
| def bbs_account(self): |
| return self.get_attribute("bbs_account", self.default_attributes["bbs_account"]) |
| |
| @bbs_account.setter |
| def bbs_account(self, value): |
| return self.set_attribute("bbs_account", value) |
| |
| @property |
| def last_ansible_hash(self): |
| return self.get_attribute("last_ansible_hash", self.default_attributes["last_ansible_hash"]) |
| |
| @last_ansible_hash.setter |
| def last_ansible_hash(self, value): |
| return self.set_attribute("last_ansible_hash", value) |
| |
| @property |
| def ssh_command(self): |
| if self.instance: |
| return self.instance.get_ssh_command() |
| else: |
| return "no-instance" |
| |
| @ssh_command.setter |
| def ssh_command(self, value): |
| pass |
| |
| @property |
| def addresses(self): |
| if self.instance: |
| ports = self.instance.ports.all() |
| elif self.container: |
| ports = self.container.ports.all() |
| else: |
| return {} |
| |
| addresses = {} |
| for ns in ports: |
| if "lan" in ns.network.name.lower(): |
| addresses["lan"] = (ns.ip, ns.mac) |
| elif "wan" in ns.network.name.lower(): |
| addresses["wan"] = (ns.ip, ns.mac) |
| elif "private" in ns.network.name.lower(): |
| addresses["private"] = (ns.ip, ns.mac) |
| elif "nat" in ns.network.name.lower(): |
| addresses["nat"] = (ns.ip, ns.mac) |
| elif "hpc_client" in ns.network.name.lower(): |
| addresses["hpc_client"] = (ns.ip, ns.mac) |
| return addresses |
| |
| @property |
| def nat_ip(self): |
| return self.addresses.get("nat", (None,None) )[0] |
| |
| @property |
| def nat_mac(self): |
| return self.addresses.get("nat", (None,None) )[1] |
| |
| @property |
| def lan_ip(self): |
| return self.addresses.get("lan", (None, None) )[0] |
| |
| @property |
| def lan_mac(self): |
| return self.addresses.get("lan", (None, None) )[1] |
| |
| @property |
| def wan_ip(self): |
| return self.addresses.get("wan", (None, None) )[0] |
| |
| @property |
| def wan_mac(self): |
| return self.addresses.get("wan", (None, None) )[1] |
| |
| # Generate the MAC for the container interface connected to WAN |
| @property |
| def wan_container_mac(self): |
| (a, b, c, d) = self.wan_ip.split('.') |
| return "02:42:%02x:%02x:%02x:%02x" % (int(a), int(b), int(c), int(d)) |
| |
| @property |
| def private_ip(self): |
| return self.addresses.get("private", (None, None) )[0] |
| |
| @property |
| def private_mac(self): |
| return self.addresses.get("private", (None, None) )[1] |
| |
| @property |
| def hpc_client_ip(self): |
| return self.addresses.get("hpc_client", (None, None) )[0] |
| |
| @property |
| def hpc_client_mac(self): |
| return self.addresses.get("hpc_client", (None, None) )[1] |
| |
| @property |
| def is_synced(self): |
| return (self.enacted is not None) and (self.enacted >= self.updated) |
| |
| @is_synced.setter |
| def is_synced(self, value): |
| pass |
| |
| def manage_vbng(self): |
| # Each vCPE object owns exactly one vBNG object |
| |
| if self.deleted: |
| return |
| |
| if self.vbng is None: |
| vbngServices = VBNGService.get_service_objects().all() |
| if not vbngServices: |
| raise XOSConfigurationError("No VBNG Services available") |
| |
| vbng = VBNGTenant(provider_service = vbngServices[0], |
| subscriber_tenant = self) |
| vbng.caller = self.creator |
| vbng.save() |
| |
| def cleanup_vbng(self): |
| if self.vbng: |
| # print "XXX cleanup vnbg", self.vbng |
| self.vbng.delete() |
| |
| def cleanup_orphans(self): |
| # ensure vCPE only has one vBNG |
| cur_vbng = self.vbng |
| for vbng in list(self.get_subscribed_tenants(VBNGTenant)): |
| if (not cur_vbng) or (vbng.id != cur_vbng.id): |
| # print "XXX clean up orphaned vbng", vbng |
| vbng.delete() |
| |
| if self.orig_instance_id and (self.orig_instance_id != self.get_attribute("instance_id")): |
| instances=Instance.objects.filter(id=self.orig_instance_id) |
| if instances: |
| # print "XXX clean up orphaned instance", instances[0] |
| instances[0].delete() |
| |
| def manage_bbs_account(self): |
| if self.deleted: |
| return |
| |
| if self.volt and self.volt.subscriber and self.volt.subscriber.url_filter_enable: |
| if not self.bbs_account: |
| # make sure we use the proxied VCPEService object, not the generic Service object |
| vcpe_service = VCPEService.objects.get(id=self.provider_service.id) |
| self.bbs_account = vcpe_service.allocate_bbs_account() |
| super(VCPETenant, self).save() |
| else: |
| if self.bbs_account: |
| self.bbs_account = None |
| super(VCPETenant, self).save() |
| |
| def save(self, *args, **kwargs): |
| if not self.creator: |
| if not getattr(self, "caller", None): |
| # caller must be set when creating a vCPE since it creates a slice |
| raise XOSProgrammingError("VCPETenant's self.caller was not set") |
| self.creator = self.caller |
| if not self.creator: |
| raise XOSProgrammingError("VCPETenant's self.creator was not set") |
| |
| super(VCPETenant, self).save(*args, **kwargs) |
| model_policy_vcpe(self.pk) |
| #self.manage_instance() |
| #self.manage_vbng() |
| #self.manage_bbs_account() |
| #self.cleanup_orphans() |
| |
| def delete(self, *args, **kwargs): |
| self.cleanup_vbng() |
| self.cleanup_container() |
| super(VCPETenant, self).delete(*args, **kwargs) |
| |
| def model_policy_vcpe(pk): |
| # TODO: this should be made in to a real model_policy |
| with transaction.atomic(): |
| vcpe = VCPETenant.objects.select_for_update().filter(pk=pk) |
| if not vcpe: |
| return |
| vcpe = vcpe[0] |
| vcpe.manage_container() |
| vcpe.manage_vbng() |
| vcpe.manage_bbs_account() |
| vcpe.cleanup_orphans() |
| |
| #---------------------------------------------------------------------------- |
| # vBNG |
| #---------------------------------------------------------------------------- |
| |
| class VBNGService(Service): |
| KIND = VBNG_KIND |
| |
| simple_attributes = ( ("vbng_url", ""), ) # "http://10.0.3.136:8181/onos/virtualbng/" |
| |
| class Meta: |
| app_label = "cord" |
| verbose_name = "vBNG Service" |
| proxy = True |
| |
| VBNGService.setup_simple_attributes() |
| |
| class VBNGTenant(Tenant): |
| class Meta: |
| proxy = True |
| |
| KIND = VBNG_KIND |
| |
| default_attributes = {"routeable_subnet": "", |
| "mapped_ip": "", |
| "mapped_mac": "", |
| "mapped_hostname": ""} |
| |
| @property |
| def routeable_subnet(self): |
| return self.get_attribute("routeable_subnet", self.default_attributes["routeable_subnet"]) |
| |
| @routeable_subnet.setter |
| def routeable_subnet(self, value): |
| self.set_attribute("routeable_subnet", value) |
| |
| @property |
| def mapped_ip(self): |
| return self.get_attribute("mapped_ip", self.default_attributes["mapped_ip"]) |
| |
| @mapped_ip.setter |
| def mapped_ip(self, value): |
| self.set_attribute("mapped_ip", value) |
| |
| @property |
| def mapped_mac(self): |
| return self.get_attribute("mapped_mac", self.default_attributes["mapped_mac"]) |
| |
| @mapped_mac.setter |
| def mapped_mac(self, value): |
| self.set_attribute("mapped_mac", value) |
| |
| @property |
| def mapped_hostname(self): |
| return self.get_attribute("mapped_hostname", self.default_attributes["mapped_hostname"]) |
| |
| @mapped_hostname.setter |
| def mapped_hostname(self, value): |
| self.set_attribute("mapped_hostname", value) |