# vim: tabstop=4 shiftwidth=4 softtabstop=4 # Copyright 2013 PLUMgrid, Inc. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. # # @author: Edgar Magana, emagana@plumgrid.com, PLUMgrid, Inc. """ Neutron Plug-in for PLUMgrid Virtual Networking Infrastructure (VNI) This plugin will forward authenticated REST API calls to the PLUMgrid Network Management System called Director """ import netaddr from oslo.config import cfg from neutron.api.v2 import attributes from neutron.db import api as db from neutron.db import db_base_plugin_v2 from neutron.db import external_net_db from neutron.db import l3_db from neutron.db import portbindings_db from neutron.db import quota_db # noqa from neutron.extensions import portbindings from neutron.openstack.common import importutils from neutron.openstack.common import log as logging from neutron.plugins.plumgrid.common import exceptions as plum_excep from neutron.plugins.plumgrid.plumgrid_plugin.plugin_ver import VERSION LOG = logging.getLogger(__name__) PLUM_DRIVER = 'neutron.plugins.plumgrid.drivers.plumlib.Plumlib' director_server_opts = [ cfg.StrOpt('director_server', default='localhost', help=_("PLUMgrid Director server to connect to")), cfg.StrOpt('director_server_port', default='8080', help=_("PLUMgrid Director server port to connect to")), cfg.StrOpt('username', default='username', help=_("PLUMgrid Director admin username")), cfg.StrOpt('password', default='password', secret=True, help=_("PLUMgrid Director admin password")), cfg.IntOpt('servertimeout', default=5, help=_("PLUMgrid Director server timeout")), ] cfg.CONF.register_opts(director_server_opts, "plumgriddirector") class NeutronPluginPLUMgridV2(db_base_plugin_v2.NeutronDbPluginV2, portbindings_db.PortBindingMixin, external_net_db.External_net_db_mixin, l3_db.L3_NAT_db_mixin): supported_extension_aliases = ["external-net", "router", "binding", "quotas"] binding_view = "extension:port_binding:view" binding_set = "extension:port_binding:set" def __init__(self): LOG.info(_('Neutron PLUMgrid Director: Starting Plugin')) # Plugin DB initialization db.configure_db() self.plumgrid_init() LOG.debug(_('Neutron PLUMgrid Director: Neutron server with ' 'PLUMgrid Plugin has started')) def plumgrid_init(self): """PLUMgrid initialization.""" director_plumgrid = cfg.CONF.plumgriddirector.director_server director_port = cfg.CONF.plumgriddirector.director_server_port director_admin = cfg.CONF.plumgriddirector.username director_password = cfg.CONF.plumgriddirector.password timeout = cfg.CONF.plumgriddirector.servertimeout # PLUMgrid Director info validation LOG.info(_('Neutron PLUMgrid Director: %s'), director_plumgrid) self._plumlib = importutils.import_object(PLUM_DRIVER) self._plumlib.director_conn(director_plumgrid, director_port, timeout, director_admin, director_password) def create_network(self, context, network): """Create Neutron network. Creates a PLUMgrid-based bridge. """ LOG.debug(_('Neutron PLUMgrid Director: create_network() called')) # Plugin DB - Network Create and validation tenant_id = self._get_tenant_id_for_create(context, network["network"]) self._network_admin_state(network) with context.session.begin(subtransactions=True): net_db = super(NeutronPluginPLUMgridV2, self).create_network(context, network) # Propagate all L3 data into DB self._process_l3_create(context, net_db, network['network']) try: LOG.debug(_('PLUMgrid Library: create_network() called')) self._plumlib.create_network(tenant_id, net_db) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) # Return created network return net_db def update_network(self, context, net_id, network): """Update Neutron network. Updates a PLUMgrid-based bridge. """ LOG.debug(_("Neutron PLUMgrid Director: update_network() called")) self._network_admin_state(network) tenant_id = self._get_tenant_id_for_create(context, network["network"]) with context.session.begin(subtransactions=True): # Plugin DB - Network Update net_db = super( NeutronPluginPLUMgridV2, self).update_network(context, net_id, network) try: LOG.debug(_("PLUMgrid Library: update_network() called")) self._plumlib.update_network(tenant_id, net_id) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) # Return updated network return net_db def delete_network(self, context, net_id): """Delete Neutron network. Deletes a PLUMgrid-based bridge. """ LOG.debug(_("Neutron PLUMgrid Director: delete_network() called")) net_db = super(NeutronPluginPLUMgridV2, self).get_network(context, net_id) with context.session.begin(subtransactions=True): # Plugin DB - Network Delete super(NeutronPluginPLUMgridV2, self).delete_network(context, net_id) try: LOG.debug(_("PLUMgrid Library: update_network() called")) self._plumlib.delete_network(net_db, net_id) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) def create_port(self, context, port): """Create Neutron port. Creates a PLUMgrid-based port on the specific Virtual Network Function (VNF). """ LOG.debug(_("Neutron PLUMgrid Director: create_port() called")) # Port operations on PLUMgrid Director is an automatic operation # from the VIF driver operations in Nova. # It requires admin_state_up to be True port["port"]["admin_state_up"] = True with context.session.begin(subtransactions=True): # Plugin DB - Port Create and Return port port_db = super(NeutronPluginPLUMgridV2, self).create_port(context, port) device_id = port_db["device_id"] if port_db["device_owner"] == "network:router_gateway": router_db = self._get_router(context, device_id) else: router_db = None try: LOG.debug(_("PLUMgrid Library: create_port() called")) self._plumlib.create_port(port_db, router_db) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) # Plugin DB - Port Create and Return port return self._port_viftype_binding(context, port_db) def update_port(self, context, port_id, port): """Update Neutron port. Updates a PLUMgrid-based port on the specific Virtual Network Function (VNF). """ LOG.debug(_("Neutron PLUMgrid Director: update_port() called")) with context.session.begin(subtransactions=True): # Plugin DB - Port Create and Return port port_db = super(NeutronPluginPLUMgridV2, self).update_port( context, port_id, port) device_id = port_db["device_id"] if port_db["device_owner"] == "network:router_gateway": router_db = self._get_router(context, device_id) else: router_db = None try: LOG.debug(_("PLUMgrid Library: create_port() called")) self._plumlib.update_port(port_db, router_db) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) # Plugin DB - Port Update return self._port_viftype_binding(context, port_db) def delete_port(self, context, port_id, l3_port_check=True): """Delete Neutron port. Deletes a PLUMgrid-based port on the specific Virtual Network Function (VNF). """ LOG.debug(_("Neutron PLUMgrid Director: delete_port() called")) with context.session.begin(subtransactions=True): # Plugin DB - Port Create and Return port port_db = super(NeutronPluginPLUMgridV2, self).get_port(context, port_id) self.disassociate_floatingips(context, port_id) super(NeutronPluginPLUMgridV2, self).delete_port(context, port_id) if port_db["device_owner"] == "network:router_gateway": device_id = port_db["device_id"] router_db = self._get_router(context, device_id) else: router_db = None try: LOG.debug(_("PLUMgrid Library: delete_port() called")) self._plumlib.delete_port(port_db, router_db) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) def get_port(self, context, id, fields=None): with context.session.begin(subtransactions=True): port_db = super(NeutronPluginPLUMgridV2, self).get_port(context, id, fields) self._port_viftype_binding(context, port_db) return self._fields(port_db, fields) def get_ports(self, context, filters=None, fields=None): with context.session.begin(subtransactions=True): ports_db = super(NeutronPluginPLUMgridV2, self).get_ports(context, filters, fields) for port_db in ports_db: self._port_viftype_binding(context, port_db) return [self._fields(port, fields) for port in ports_db] def create_subnet(self, context, subnet): """Create Neutron subnet. Creates a PLUMgrid-based DHCP and NAT Virtual Network Functions (VNFs). """ LOG.debug(_("Neutron PLUMgrid Director: create_subnet() called")) with context.session.begin(subtransactions=True): # Plugin DB - Subnet Create net_db = super(NeutronPluginPLUMgridV2, self).get_network( context, subnet['subnet']['network_id'], fields=None) s = subnet['subnet'] ipnet = netaddr.IPNetwork(s['cidr']) # PLUMgrid Director reserves the last IP address for GW # when is not defined if s['gateway_ip'] is attributes.ATTR_NOT_SPECIFIED: gw_ip = str(netaddr.IPAddress(ipnet.last - 1)) subnet['subnet']['gateway_ip'] = gw_ip # PLUMgrid reserves the first IP if s['allocation_pools'] == attributes.ATTR_NOT_SPECIFIED: allocation_pool = self._allocate_pools_for_subnet(context, s) subnet['subnet']['allocation_pools'] = allocation_pool sub_db = super(NeutronPluginPLUMgridV2, self).create_subnet( context, subnet) try: LOG.debug(_("PLUMgrid Library: create_subnet() called")) self._plumlib.create_subnet(sub_db, net_db, ipnet) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) return sub_db def delete_subnet(self, context, subnet_id): """Delete subnet core Neutron API.""" LOG.debug(_("Neutron PLUMgrid Director: delete_subnet() called")) # Collecting subnet info sub_db = self._get_subnet(context, subnet_id) tenant_id = self._get_tenant_id_for_create(context, subnet_id) net_id = sub_db["network_id"] net_db = self.get_network(context, net_id) with context.session.begin(subtransactions=True): # Plugin DB - Subnet Delete super(NeutronPluginPLUMgridV2, self).delete_subnet( context, subnet_id) try: LOG.debug(_("PLUMgrid Library: delete_subnet() called")) self._plumlib.delete_subnet(tenant_id, net_db, net_id) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) def update_subnet(self, context, subnet_id, subnet): """Update subnet core Neutron API.""" LOG.debug(_("update_subnet() called")) # Collecting subnet info org_sub_db = self._get_subnet(context, subnet_id) with context.session.begin(subtransactions=True): # Plugin DB - Subnet Update new_sub_db = super(NeutronPluginPLUMgridV2, self).update_subnet(context, subnet_id, subnet) ipnet = netaddr.IPNetwork(new_sub_db['cidr']) try: # PLUMgrid Server does not support updating resources yet LOG.debug(_("PLUMgrid Library: update_network() called")) self._plumlib.update_subnet(org_sub_db, new_sub_db, ipnet) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) return new_sub_db def create_router(self, context, router): """ Create router extension Neutron API """ LOG.debug(_("Neutron PLUMgrid Director: create_router() called")) tenant_id = self._get_tenant_id_for_create(context, router["router"]) with context.session.begin(subtransactions=True): # Create router in DB router_db = super(NeutronPluginPLUMgridV2, self).create_router(context, router) # Create router on the network controller try: # Add Router to VND LOG.debug(_("PLUMgrid Library: create_router() called")) self._plumlib.create_router(tenant_id, router_db) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) # Return created router return router_db def update_router(self, context, router_id, router): LOG.debug(_("Neutron PLUMgrid Director: update_router() called")) with context.session.begin(subtransactions=True): router_db = super(NeutronPluginPLUMgridV2, self).update_router(context, router_id, router) try: LOG.debug(_("PLUMgrid Library: update_router() called")) self._plumlib.update_router(router_db, router_id) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) # Return updated router return router_db def delete_router(self, context, router_id): LOG.debug(_("Neutron PLUMgrid Director: delete_router() called")) with context.session.begin(subtransactions=True): orig_router = self._get_router(context, router_id) tenant_id = orig_router["tenant_id"] super(NeutronPluginPLUMgridV2, self).delete_router(context, router_id) try: LOG.debug(_("PLUMgrid Library: delete_router() called")) self._plumlib.delete_router(tenant_id, router_id) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) def add_router_interface(self, context, router_id, interface_info): LOG.debug(_("Neutron PLUMgrid Director: " "add_router_interface() called")) with context.session.begin(subtransactions=True): # Validate args router_db = self._get_router(context, router_id) tenant_id = router_db['tenant_id'] # Create interface in DB int_router = super(NeutronPluginPLUMgridV2, self).add_router_interface(context, router_id, interface_info) port_db = self._get_port(context, int_router['port_id']) subnet_id = port_db["fixed_ips"][0]["subnet_id"] subnet_db = super(NeutronPluginPLUMgridV2, self)._get_subnet(context, subnet_id) ipnet = netaddr.IPNetwork(subnet_db['cidr']) # Create interface on the network controller try: LOG.debug(_("PLUMgrid Library: add_router_interface() called")) self._plumlib.add_router_interface(tenant_id, router_id, port_db, ipnet) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) return int_router def remove_router_interface(self, context, router_id, int_info): LOG.debug(_("Neutron PLUMgrid Director: " "remove_router_interface() called")) with context.session.begin(subtransactions=True): # Validate args router_db = self._get_router(context, router_id) tenant_id = router_db['tenant_id'] if 'port_id' in int_info: port = self._get_port(context, int_info['port_id']) net_id = port['network_id'] elif 'subnet_id' in int_info: subnet_id = int_info['subnet_id'] subnet = self._get_subnet(context, subnet_id) net_id = subnet['network_id'] # Remove router in DB del_int_router = super(NeutronPluginPLUMgridV2, self).remove_router_interface(context, router_id, int_info) try: LOG.debug(_("PLUMgrid Library: " "remove_router_interface() called")) self._plumlib.remove_router_interface(tenant_id, net_id, router_id) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) return del_int_router def create_floatingip(self, context, floatingip): LOG.debug(_("Neutron PLUMgrid Director: create_floatingip() called")) with context.session.begin(subtransactions=True): floating_ip = super(NeutronPluginPLUMgridV2, self).create_floatingip(context, floatingip) net_id = floating_ip['floating_network_id'] net_db = super(NeutronPluginPLUMgridV2, self).get_network(context, net_id) try: LOG.debug(_("PLUMgrid Library: create_floatingip() called")) self._plumlib.create_floatingip(net_db, floating_ip) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) return floating_ip def update_floatingip(self, context, id, floatingip): LOG.debug(_("Neutron PLUMgrid Director: update_floatingip() called")) with context.session.begin(subtransactions=True): floating_ip = super(NeutronPluginPLUMgridV2, self).update_floatingip(context, id, floatingip) net_id = floating_ip['floating_network_id'] net_db = super(NeutronPluginPLUMgridV2, self).get_network(context, net_id) try: LOG.debug(_("PLUMgrid Library: update_floatingip() called")) self._plumlib.update_floatingip(net_db, floating_ip, id) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) return floating_ip def delete_floatingip(self, context, id): LOG.debug(_("Neutron PLUMgrid Director: delete_floatingip() called")) with context.session.begin(subtransactions=True): floating_ip_org = super(NeutronPluginPLUMgridV2, self).get_floatingip(context, id) net_id = floating_ip_org['floating_network_id'] net_db = super(NeutronPluginPLUMgridV2, self).get_network(context, net_id) super(NeutronPluginPLUMgridV2, self).delete_floatingip(context, id) try: LOG.debug(_("PLUMgrid Library: delete_floatingip() called")) self._plumlib.delete_floatingip(net_db, floating_ip_org, id) except Exception as err_message: raise plum_excep.PLUMgridException(err_msg=err_message) """ Internal PLUMgrid Fuctions """ def _get_plugin_version(self): return VERSION def _port_viftype_binding(self, context, port): port[portbindings.VIF_TYPE] = portbindings.VIF_TYPE_IOVISOR port[portbindings.CAPABILITIES] = { portbindings.CAP_PORT_FILTER: 'security-group' in self.supported_extension_aliases} return port def _network_admin_state(self, network): try: if network["network"].get("admin_state_up"): network_name = network["network"]["name"] if network["network"]["admin_state_up"] is False: LOG.warning(_("Network with admin_state_up=False are not " "supported yet by this plugin. Ignoring " "setting for network %s"), network_name) except Exception: err_message = _("Network Admin State Validation Failed: ") raise plum_excep.PLUMgridException(err_msg=err_message) return network def _allocate_pools_for_subnet(self, context, subnet): """Create IP allocation pools for a given subnet Pools are defined by the 'allocation_pools' attribute, a list of dict objects with 'start' and 'end' keys for defining the pool range. Modified from Neutron DB based class """ pools = [] # Auto allocate the pool around gateway_ip net = netaddr.IPNetwork(subnet['cidr']) first_ip = net.first + 2 last_ip = net.last - 1 gw_ip = int(netaddr.IPAddress(subnet['gateway_ip'] or net.last)) # Use the gw_ip to find a point for splitting allocation pools # for this subnet split_ip = min(max(gw_ip, net.first), net.last) if split_ip > first_ip: pools.append({'start': str(netaddr.IPAddress(first_ip)), 'end': str(netaddr.IPAddress(split_ip - 1))}) if split_ip < last_ip: pools.append({'start': str(netaddr.IPAddress(split_ip + 1)), 'end': str(netaddr.IPAddress(last_ip))}) # return auto-generated pools # no need to check for their validity return pools