class BGPVPN(neutron.NeutronResource):
"""A resource for BGPVPN service in neutron.
"""
required_service_extension = 'bgpvpn'
PROPERTIES = (NAME, TYPE, DESCRIPTION, ROUTE_DISTINGUISHERS,
IMPORT_TARGETS, EXPORT_TARGETS, ROUTE_TARGETS, TENANT_ID,
LOCAL_PREF) = ('name', 'type', 'description',
'route_distinguishers', 'import_targets',
'export_targets', 'route_targets',
'tenant_id', 'local_pref')
ATTRIBUTES = (SHOW, STATUS) = ('show', 'status')
properties_schema = {
NAME:
properties.Schema(
properties.Schema.STRING,
_('Name for the bgpvpn.'),
),
TYPE:
properties.Schema(
properties.Schema.STRING,
_('BGP VPN type selection between L3VPN (l3) and '
'EVPN (l2), default:l3'),
required=False,
default='l3',
constraints=[constraints.AllowedValues(['l2', 'l3'])]),
DESCRIPTION:
properties.Schema(
properties.Schema.STRING,
_('Description for the bgpvpn.'),
required=False,
),
TENANT_ID:
properties.Schema(
properties.Schema.STRING,
_('Tenant this bgpvpn belongs to (name or id).'),
required=False,
constraints=[constraints.CustomConstraint('keystone.project')]),
ROUTE_DISTINGUISHERS:
properties.Schema(
properties.Schema.LIST,
_('List of RDs that will be used to advertize BGPVPN routes.'),
required=False,
# TODO(tmorin): add a pattern constraint
),
IMPORT_TARGETS:
properties.Schema(
properties.Schema.LIST,
_('List of additional Route Targets to import from.'),
required=False,
# TODO(tmorin): add a pattern constraint
),
EXPORT_TARGETS:
properties.Schema(
properties.Schema.LIST,
_('List of additional Route Targets to export to.'),
required=False,
# TODO(tmorin): add a pattern constraint
),
ROUTE_TARGETS:
properties.Schema(
properties.Schema.LIST,
_('Route Targets list to import/export for this BGPVPN.'),
required=False,
# TODO(tmorin): add a pattern constraint
),
LOCAL_PREF:
properties.Schema(
properties.Schema.INTEGER,
description=_('Default value of the BGP LOCAL_PREF for the '
'route advertisement to this BGPVPN.'),
constraints=[
constraints.Range(0, 2**32 - 1),
],
)
}
attributes_schema = {
STATUS: attributes.Schema(_('Status of bgpvpn.'), ),
SHOW: attributes.Schema(_('All attributes.')),
}
def validate(self):
super(BGPVPN, self).validate()
def handle_create(self):
props = self.prepare_properties(self.properties,
self.physical_resource_name())
# remove local-pref if unset, to let Neutron set a default
if (self.LOCAL_PREF in props and props[self.LOCAL_PREF] is None):
del props[self.LOCAL_PREF]
if 'tenant_id' in props:
tenant_id = self.client_plugin('keystone').get_project_id(
props['tenant_id'])
props['tenant_id'] = tenant_id
bgpvpn = self.neutron().create_bgpvpn({'bgpvpn': props})
self.resource_id_set(bgpvpn['bgpvpn']['id'])
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
raise NotImplementedError()
def handle_delete(self):
try:
self.neutron().delete_bgpvpn(self.resource_id)
except Exception as ex:
self.client_plugin().ignore_not_found(ex)
else:
return True
def _confirm_delete(self):
while True:
try:
yield self._show_resource()
except exception.NotFound:
return
def _show_resource(self):
return self.neutron().show_bgpvpn(self.resource_id)
class BGPVPNPortAssoc(neutron.NeutronResource):
"""A resource for BGPVPNPortAssoc in neutron.
"""
required_service_extension = 'bgpvpn-routes-control'
PROPERTIES = (
BGPVPN_ID,
PORT_ID,
ADVERTISE_FIXED_IPS,
ROUTES,
) = (
'bgpvpn_id',
'port_id',
'advertise_fixed_ips',
'routes',
)
ATTRIBUTES = (SHOW, STATUS) = ('show', 'status')
_ROUTE_DICT_KEYS = (
TYPE,
PREFIX,
FROM_BGPVPN,
LOCAL_PREF,
) = ('type', 'prefix', 'bgpvpn_id', 'local_pref')
_ROUTE_TYPE_VALUES = (PREFIX, BGPVPN) = (PREFIX, 'bgpvpn')
properties_schema = {
BGPVPN_ID:
properties.Schema(
properties.Schema.STRING,
_('name or ID of the BGPVPN.'),
required=True,
constraints=[constraints.CustomConstraint('neutron.bgpvpn')],
),
PORT_ID:
properties.Schema(
properties.Schema.STRING,
_('Port which shall be associated with the BGPVPN.'),
required=True,
constraints=[constraints.CustomConstraint('neutron.port')]),
ADVERTISE_FIXED_IPS:
properties.Schema(
properties.Schema.BOOLEAN,
_('whether or not the fixed IPs of he port will be advertised '
'into the BGPVPN.'),
),
ROUTES:
properties.Schema(
properties.Schema.LIST,
_('Defines routes to advertise into the BGPVPN, and for which '
'this port will be the nexthop'),
schema=properties.Schema(
properties.Schema.MAP,
schema={
TYPE:
properties.Schema(
properties.Schema.STRING,
description=_('Type of the route.'),
constraints=[
constraints.AllowedValues(_ROUTE_TYPE_VALUES)
],
required=True),
PREFIX:
properties.Schema(
properties.Schema.STRING,
description=_('Prefix to readvertise.'),
constraints=[constraints.CustomConstraint('net_cidr')
]),
FROM_BGPVPN:
properties.Schema(
properties.Schema.STRING,
description=_(
'BGPVPN from which to readvertise routes'
'(any route carrying an RT among '
'route_targets or import_targets '
'of this BGPVPN, will be readvertised).'),
constraints=[
constraints.CustomConstraint('neutron.bgpvpn')
]),
LOCAL_PREF:
properties.Schema(
properties.Schema.INTEGER,
description=_('Value of the BGP LOCAL_PREF for the '
'routes.'),
constraints=[
constraints.Range(0, 2**32 - 1),
],
)
}))
}
attributes_schema = {
STATUS: attributes.Schema(_('Status of bgpvpn.'), ),
SHOW: attributes.Schema(_('All attributes.')),
}
def validate(self):
super(BGPVPNPortAssoc, self).validate()
def handle_create(self):
self.props = self.prepare_properties(self.properties,
self.physical_resource_name())
# clean-up/preparethe routes
for route in self.props.get('routes', []):
# remove local-pref if unset, to let Neutron set a default
if (self.LOCAL_PREF in route and route[self.LOCAL_PREF] is None):
del route[self.LOCAL_PREF]
if route[self.TYPE] == self.PREFIX:
# routes of type 'prefix' should not have a bgpvpn_id attribute
del route[self.FROM_BGPVPN]
elif route[self.TYPE] == self.BGPVPN:
# routes of type 'bgpvpn' should not have a 'prefix' attribute
del route[self.PREFIX]
# need to lookup the BGPVPN by name or id
route[self.FROM_BGPVPN] = (
self.client_plugin().find_resourceid_by_name_or_id(
'bgpvpn', route[self.FROM_BGPVPN]))
body = self.props.copy()
body.pop('bgpvpn_id')
bgpvpn_id = self.client_plugin().find_resourceid_by_name_or_id(
'bgpvpn', self.props['bgpvpn_id'])
port_assoc = self.neutron().create_bgpvpn_port_assoc(
bgpvpn_id, {'port_association': body})
self.resource_id_set(port_assoc['port_association']['id'])
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
raise NotImplementedError()
def handle_delete(self):
try:
self.neutron().delete_bgpvpn_port_assoc(
self.properties['bgpvpn_id'], self.resource_id)
except Exception as ex:
self.client_plugin().ignore_not_found(ex)
else:
return True
def _confirm_delete(self):
while True:
try:
self._show_resource()
except exception.NotFound:
return
def _show_resource(self):
return self.neutron().show_port_association(
self.resource_id, self.properties['bgpvpn_id'])
class BGPVPNRouterAssoc(neutron.NeutronResource):
"""A resource for BGPVPNRouterAssoc in neutron.
"""
required_service_extension = 'bgpvpn'
PROPERTIES = (BGPVPN_ID, ROUTER_ID) = ('bgpvpn_id', 'router_id')
ATTRIBUTES = (SHOW, STATUS) = ('show', 'status')
properties_schema = {
BGPVPN_ID:
properties.Schema(
properties.Schema.STRING,
_('name or ID of the BGPVPN.'),
required=True,
constraints=[constraints.CustomConstraint('neutron.bgpvpn')]),
ROUTER_ID:
properties.Schema(
properties.Schema.STRING,
_('Router which shall be associated with the BGPVPN.'),
required=True,
constraints=[constraints.CustomConstraint('neutron.router')])
}
attributes_schema = {
STATUS: attributes.Schema(_('Status of bgpvpn.'), ),
SHOW: attributes.Schema(_('All attributes.')),
}
def validate(self):
super(BGPVPNRouterAssoc, self).validate()
def handle_create(self):
self.props = self.prepare_properties(self.properties,
self.physical_resource_name())
body = self.props.copy()
body.pop('bgpvpn_id')
bgpvpn_id = self.client_plugin().find_resourceid_by_name_or_id(
'bgpvpn', self.props['bgpvpn_id'])
router_assoc = self.neutron().create_bgpvpn_router_assoc(
bgpvpn_id, {'router_association': body})
self.resource_id_set(router_assoc['router_association']['id'])
def handle_update(self, json_snippet, tmpl_diff, prop_diff):
raise NotImplementedError()
def handle_delete(self):
try:
self.neutron().delete_bgpvpn_router_assoc(
self.properties['bgpvpn_id'], self.resource_id)
except Exception as ex:
self.client_plugin().ignore_not_found(ex)
else:
return True
def _confirm_delete(self):
while True:
try:
self._show_resource()
except exception.NotFound:
return
def _show_resource(self):
return self.neutron().show_bgpvpn_router_assoc(
self.properties['bgpvpn_id'], self.resource_id)