planetstack/core/models/network.py

   1 import os
   2 import socket
   3 from django.db import models
   4 from core.models import PlCoreBase, Site, Slice, Sliver, Deployment
   5 from core.models import DeploymentLinkManager,DeploymentLinkDeletionManager
   6 from django.contrib.contenttypes.models import ContentType
   7 from django.contrib.contenttypes import generic
   8 from django.core.exceptions import ValidationError
   9
  10 # If true, then IP addresses will be allocated by the model. If false, then
  11 # we will assume the observer handles it.
  12 NO_OBSERVER=False
  13
  14 def ParseNatList(ports):
  15     """ Support a list of ports in the format "protocol:port, protocol:port, ..."
  16         examples:
  17             tcp 123
  18             tcp 123:133
  19             tcp 123, tcp 124, tcp 125, udp 201, udp 202
  20
  21         User can put either a "/" or a " " between protocol and ports
  22         Port ranges can be specified with "-" or ":"
  23     """
  24     nats = []
  25     if ports:
  26         parts = ports.split(",")
  27         for part in parts:
  28             part = part.strip()
  29             if "/" in part:
  30                 (protocol, ports) = part.split("/",1)
  31             elif " " in part:
  32                 (protocol, ports) = part.split(None,1)
  33             else:
  34                 raise TypeError('malformed port specifier %s, format example: "tcp 123, tcp 201:206, udp 333"' % part)
  35
  36             protocol = protocol.strip()
  37             ports = ports.strip()
  38
  39             if not (protocol in ["udp", "tcp"]):
  40                 raise ValueError('unknown protocol %s' % protocol)
  41
  42             if "-" in ports:
  43                 (first, last) = ports.split("-")
  44                 first = int(first.strip())
  45                 last = int(last.strip())
  46                 portStr = "%d:%d" % (first, last)
  47             elif ":" in ports:
  48                 (first, last) = ports.split(":")
  49                 first = int(first.strip())
  50                 last = int(last.strip())
  51                 portStr = "%d:%d" % (first, last)
  52             else:
  53                 portStr = "%d" % int(ports)
  54
  55             nats.append( {"l4_protocol": protocol, "l4_port": portStr} )
  56
  57     return nats
  58
  59 def ValidateNatList(ports):
  60     try:
  61         ParseNatList(ports)
  62     except Exception,e:
  63         raise ValidationError(str(e))
  64
  65 class NetworkTemplate(PlCoreBase):
  66     VISIBILITY_CHOICES = (('public', 'public'), ('private', 'private'))
  67     TRANSLATION_CHOICES = (('none', 'none'), ('NAT', 'NAT'))
  68     TOPOLOGY_CHOICES = (('bigswitch', 'BigSwitch'), ('physical', 'Physical'), ('custom', 'Custom'))
  69     CONTROLLER_CHOICES = ((None, 'None'), ('onos', 'ONOS'), ('custom', 'Custom'))
  70
  71     name = models.CharField(max_length=32)
  72     description = models.CharField(max_length=1024, blank=True, null=True)
  73     guaranteedBandwidth = models.IntegerField(default=0)
  74     visibility = models.CharField(max_length=30, choices=VISIBILITY_CHOICES, default="private")
  75     translation = models.CharField(max_length=30, choices=TRANSLATION_CHOICES, default="none")
  76     sharedNetworkName = models.CharField(max_length=30, blank=True, null=True)
  77     sharedNetworkId = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum network")
  78     topologyKind = models.CharField(null=False, blank=False, max_length=30, choices=TOPOLOGY_CHOICES, default="BigSwitch")
  79     controllerKind = models.CharField(null=True, blank=True, max_length=30, choices=CONTROLLER_CHOICES, default=None)
  80
  81     def __unicode__(self):  return u'%s' % (self.name)
  82
  83 class Network(PlCoreBase):
  84     name = models.CharField(max_length=32)
  85     template = models.ForeignKey(NetworkTemplate)
  86     subnet = models.CharField(max_length=32, blank=True)
  87     ports = models.CharField(max_length=1024, blank=True, null=True, validators=[ValidateNatList])
  88     labels = models.CharField(max_length=1024, blank=True, null=True)
  89     owner = models.ForeignKey(Slice, related_name="ownedNetworks", help_text="Slice that owns control of this Network")
  90
  91     guaranteedBandwidth = models.IntegerField(default=0)
  92     permitAllSlices = models.BooleanField(default=False)
  93     permittedSlices = models.ManyToManyField(Slice, blank=True, related_name="availableNetworks")
  94     slices = models.ManyToManyField(Slice, blank=True, related_name="networks", through="NetworkSlice")
  95     slivers = models.ManyToManyField(Sliver, blank=True, related_name="networks", through="NetworkSliver")
  96
  97     topologyParameters = models.TextField(null=True, blank=True)
  98     controllerUrl = models.CharField(null=True, blank=True, max_length=1024)
  99     controllerParameters = models.TextField(null=True, blank=True)
 100
 101     # for observer/manager
 102     network_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum network")
 103     router_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum router id")
 104     subnet_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum subnet id")
 105
 106     def __unicode__(self):  return u'%s' % (self.name)
 107
 108     def save(self, *args, **kwds):
 109         if (not self.subnet) and (NO_OBSERVER):
 110             from util.network_subnet_allocator import find_unused_subnet
 111             self.subnet = find_unused_subnet(existing_subnets=[x.subnet for x in Network.objects.all()])
 112         super(Network, self).save(*args, **kwds)
 113
 114     def can_update(self, user):
 115         return self.owner.can_update(user)
 116
 117     @property
 118     def nat_list(self):
 119         return ParseNatList(self.ports)
 120
 121     @staticmethod
 122     def select_by_user(user):
 123         if user.is_admin:
 124             qs = Network.objects.all()
 125         else:
 126             slices = Slice.select_by_user(user)
 127             #slice_ids = [s.id for s in Slice.select_by_user(user)]
 128             qs = Network.objects.filter(owner__in=slices)
 129         return qs
 130
 131 class NetworkDeployments(PlCoreBase):
 132     objects = DeploymentLinkManager()
 133     deleted_objects = DeploymentLinkDeletionManager()
 134
 135     # Stores the openstack ids at various deployments
 136     network = models.ForeignKey(Network, related_name='networkdeployments')
 137     deployment = models.ForeignKey(Deployment, related_name='networkdeployments')
 138     net_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum network")
 139     router_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum router id")
 140     subnet_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum subnet id")
 141     subnet = models.CharField(max_length=32, blank=True)
 142
 143     def can_update(self, user):
 144         return user.is_admin
 145
 146     @staticmethod
 147     def select_by_user(user):
 148         if user.is_admin:
 149             qs = NetworkDeployments.objects.all()
 150         else:
 151             slices = Slice.select_by_user(user)
 152             networks = Network.objects.filter(owner__in=slices)
 153             qs = NetworkDeployments.objects.filter(network__in=networks)
 154         return qs
 155
 156 class NetworkSlice(PlCoreBase):
 157     # This object exists solely so we can implement the permission check when
 158     # adding slices to networks. It adds no additional fields to the relation.
 159
 160     network = models.ForeignKey(Network,related_name='networkslices')
 161     slice = models.ForeignKey(Slice,related_name='networkslices')
 162
 163     def save(self, *args, **kwds):
 164         slice = self.slice
 165         if (slice not in self.network.permittedSlices.all()) and (slice != self.network.owner) and (not self.network.permitAllSlices):
 166             # to add a sliver to the network, then one of the following must be true:
 167             #   1) sliver's slice is in network's permittedSlices list,
 168             #   2) sliver's slice is network's owner, or
 169             #   3) network's permitAllSlices is true
 170             raise ValueError("Slice %s is not allowed to connect to network %s" % (str(slice), str(self.network)))
 171
 172         super(NetworkSlice, self).save(*args, **kwds)
 173
 174     def __unicode__(self):  return u'%s-%s' % (self.network.name, self.slice.name)
 175
 176     def can_update(self, user):
 177         return self.slice.can_update(user)
 178
 179     @staticmethod
 180     def select_by_user(user):
 181         if user.is_admin:
 182             qs = NetworkSlice.objects.all()
 183         else:
 184             slice_ids = [s.id for s in Slice.select_by_user(user)]
 185             qs = NetworkSlice.objects.filter(id__in=slice_ids)
 186         return qs
 187
 188 class NetworkSliver(PlCoreBase):
 189     network = models.ForeignKey(Network,related_name='networkslivers')
 190     sliver = models.ForeignKey(Sliver,related_name='networkslivers')
 191     ip = models.GenericIPAddressField(help_text="Sliver ip address", blank=True, null=True)
 192     port_id = models.CharField(null=True, blank=True, max_length=256, help_text="Quantum port id")
 193
 194     def save(self, *args, **kwds):
 195         slice = self.sliver.slice
 196         if (slice not in self.network.permittedSlices.all()) and (slice != self.network.owner) and (not self.network.permitAllSlices):
 197             # to add a sliver to the network, then one of the following must be true:
 198             #   1) sliver's slice is in network's permittedSlices list,
 199             #   2) sliver's slice is network's owner, or
 200             #   3) network's permitAllSlices is true
 201             raise ValueError("Slice %s is not allowed to connect to network %s" % (str(slice), str(self.network)))
 202
 203         if (not self.ip) and (NO_OBSERVER):
 204             from util.network_subnet_allocator import find_unused_address
 205             self.ip = find_unused_address(self.network.subnet,
 206                                           [x.ip for x in self.network.networksliver_set.all()])
 207         super(NetworkSliver, self).save(*args, **kwds)
 208
 209     def __unicode__(self):  return u'%s-%s' % (self.network.name, self.sliver.instance_name)
 210
 211     def can_update(self, user):
 212         return self.sliver.can_update(user)
 213
 214     @staticmethod
 215     def select_by_user(user):
 216         if user.is_admin:
 217             qs = NetworkSliver.objects.all()
 218         else:
 219             sliver_ids = [s.id for s in NetworkSliver.select_by_user(user)]
 220             qs = NetworkSliver.objects.filter(id__in=sliver_ids)
 221         return qs
 222
 223 class Router(PlCoreBase):
 224     name = models.CharField(max_length=32)
 225     owner = models.ForeignKey(Slice, related_name="routers")
 226     permittedNetworks = models.ManyToManyField(Network, blank=True, related_name="availableRouters")
 227     networks = models.ManyToManyField(Network, blank=True, related_name="routers")
 228
 229     def __unicode__(self):  return u'%s' % (self.name)
 230
 231 class NetworkParameterType(PlCoreBase):
 232     name = models.SlugField(help_text="The name of this parameter", max_length=128)
 233     description = models.CharField(max_length=1024)
 234
 235     def __unicode__(self):  return u'%s' % (self.name)
 236
 237 class NetworkParameter(PlCoreBase):
 238     parameter = models.ForeignKey(NetworkParameterType, related_name="networkparameters", help_text="The type of the parameter")
 239     value = models.CharField(help_text="The value of this parameter", max_length=1024)
 240
 241     # The required fields to do a ObjectType lookup, and object_id assignment
 242     content_type = models.ForeignKey(ContentType)
 243     object_id = models.PositiveIntegerField()
 244     content_object = generic.GenericForeignKey('content_type', 'object_id')
 245
 246     def __unicode__(self):
 247         return self.parameter.name
 248
 249