295 lines
14 KiB
Python
295 lines
14 KiB
Python
# Copyright (c) 2012 OpenStack Foundation.
|
|
# 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.
|
|
|
|
from neutron_lib.api import converters as lib_converters
|
|
from neutron_lib import constants
|
|
from neutron_lib.db import constants as db_const
|
|
|
|
|
|
# Defining a constant to avoid repeating string literal in several modules
|
|
SHARED = 'shared'
|
|
|
|
# Define constants for base resource name
|
|
NETWORK = 'network'
|
|
NETWORKS = '%ss' % NETWORK
|
|
PORT = 'port'
|
|
PORTS = '%ss' % PORT
|
|
SUBNET = 'subnet'
|
|
SUBNETS = '%ss' % SUBNET
|
|
SUBNETPOOL = 'subnetpool'
|
|
SUBNETPOOLS = '%ss' % SUBNETPOOL
|
|
CORE_RESOURCES = {'network': 'networks',
|
|
'subnet': 'subnets',
|
|
'subnetpool': 'subnetpools',
|
|
'port': 'ports'}
|
|
# Note: a default of ATTR_NOT_SPECIFIED indicates that an
|
|
# attribute is not required, but will be generated by the plugin
|
|
# if it is not specified. Particularly, a value of ATTR_NOT_SPECIFIED
|
|
# is different from an attribute that has been specified with a value of
|
|
# None. For example, if 'gateway_ip' is omitted in a request to
|
|
# create a subnet, the plugin will receive ATTR_NOT_SPECIFIED
|
|
# and the default gateway_ip will be generated.
|
|
# However, if gateway_ip is specified as None, this means that
|
|
# the subnet does not have a gateway IP.
|
|
# The following is a short reference for understanding attribute info:
|
|
# default: default value of the attribute (if missing, the attribute
|
|
# becomes mandatory.
|
|
# allow_post: the attribute can be used on POST requests.
|
|
# allow_put: the attribute can be used on PUT requests.
|
|
# validate: specifies rules for validating data in the attribute.
|
|
# convert_to: transformation to apply to the value before it is returned
|
|
# is_visible: the attribute is returned in GET responses.
|
|
# required_by_policy: the attribute is required by the policy engine and
|
|
# should therefore be filled by the API layer even if not present in
|
|
# request body.
|
|
# enforce_policy: the attribute is actively part of the policy enforcing
|
|
# mechanism, ie: there might be rules which refer to this attribute.
|
|
|
|
RESOURCE_ATTRIBUTE_MAP = {
|
|
NETWORKS: {
|
|
'id': {'allow_post': False, 'allow_put': False,
|
|
'validate': {'type:uuid': None},
|
|
'is_visible': True,
|
|
'primary_key': True},
|
|
'name': {'allow_post': True, 'allow_put': True,
|
|
'validate': {'type:string': db_const.NAME_FIELD_SIZE},
|
|
'default': '', 'is_visible': True},
|
|
'subnets': {'allow_post': False, 'allow_put': False,
|
|
'default': [],
|
|
'is_visible': True},
|
|
'admin_state_up': {'allow_post': True, 'allow_put': True,
|
|
'default': True,
|
|
'convert_to': lib_converters.convert_to_boolean,
|
|
'is_visible': True},
|
|
'status': {'allow_post': False, 'allow_put': False,
|
|
'is_visible': True},
|
|
'tenant_id': {'allow_post': True, 'allow_put': False,
|
|
'validate': {
|
|
'type:string': db_const.PROJECT_ID_FIELD_SIZE},
|
|
'required_by_policy': True,
|
|
'is_visible': True},
|
|
SHARED: {'allow_post': True,
|
|
'allow_put': True,
|
|
'default': False,
|
|
'convert_to': lib_converters.convert_to_boolean,
|
|
'is_visible': True,
|
|
'required_by_policy': True,
|
|
'enforce_policy': True},
|
|
},
|
|
PORTS: {
|
|
'id': {'allow_post': False, 'allow_put': False,
|
|
'validate': {'type:uuid': None},
|
|
'is_visible': True,
|
|
'primary_key': True},
|
|
'name': {'allow_post': True, 'allow_put': True, 'default': '',
|
|
'validate': {'type:string': db_const.NAME_FIELD_SIZE},
|
|
'is_visible': True},
|
|
'network_id': {'allow_post': True, 'allow_put': False,
|
|
'required_by_policy': True,
|
|
'validate': {'type:uuid': None},
|
|
'is_visible': True},
|
|
'admin_state_up': {'allow_post': True, 'allow_put': True,
|
|
'default': True,
|
|
'convert_to': lib_converters.convert_to_boolean,
|
|
'is_visible': True},
|
|
'mac_address': {'allow_post': True, 'allow_put': True,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:mac_address': None},
|
|
'enforce_policy': True,
|
|
'is_visible': True},
|
|
'fixed_ips': {'allow_post': True, 'allow_put': True,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'convert_list_to':
|
|
lib_converters.convert_kvp_list_to_dict,
|
|
'validate': {'type:fixed_ips': None},
|
|
'enforce_policy': True,
|
|
'is_visible': True},
|
|
'device_id': {'allow_post': True, 'allow_put': True,
|
|
'validate': {
|
|
'type:string': db_const.DEVICE_ID_FIELD_SIZE},
|
|
'default': '',
|
|
'is_visible': True},
|
|
'device_owner': {'allow_post': True, 'allow_put': True,
|
|
'validate': {
|
|
'type:string': db_const.DEVICE_OWNER_FIELD_SIZE},
|
|
'default': '', 'enforce_policy': True,
|
|
'is_visible': True},
|
|
'tenant_id': {'allow_post': True, 'allow_put': False,
|
|
'validate': {
|
|
'type:string': db_const.PROJECT_ID_FIELD_SIZE},
|
|
'required_by_policy': True,
|
|
'is_visible': True},
|
|
'status': {'allow_post': False, 'allow_put': False,
|
|
'is_visible': True},
|
|
},
|
|
SUBNETS: {
|
|
'id': {'allow_post': False, 'allow_put': False,
|
|
'validate': {'type:uuid': None},
|
|
'is_visible': True,
|
|
'primary_key': True},
|
|
'name': {'allow_post': True, 'allow_put': True, 'default': '',
|
|
'validate': {'type:string': db_const.NAME_FIELD_SIZE},
|
|
'is_visible': True},
|
|
'ip_version': {'allow_post': True, 'allow_put': False,
|
|
'convert_to': lib_converters.convert_to_int,
|
|
'validate': {'type:values': [4, 6]},
|
|
'is_visible': True},
|
|
'network_id': {'allow_post': True, 'allow_put': False,
|
|
'required_by_policy': True,
|
|
'validate': {'type:uuid': None},
|
|
'is_visible': True},
|
|
'subnetpool_id': {'allow_post': True,
|
|
'allow_put': False,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'required_by_policy': False,
|
|
'validate': {'type:subnetpool_id_or_none': None},
|
|
'is_visible': True},
|
|
'prefixlen': {'allow_post': True,
|
|
'allow_put': False,
|
|
'validate': {'type:non_negative': None},
|
|
'convert_to': lib_converters.convert_to_int,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'required_by_policy': False,
|
|
'is_visible': False},
|
|
'cidr': {'allow_post': True,
|
|
'allow_put': False,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:subnet_or_none': None},
|
|
'required_by_policy': False,
|
|
'is_visible': True},
|
|
'gateway_ip': {'allow_post': True, 'allow_put': True,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:ip_address_or_none': None},
|
|
'is_visible': True},
|
|
'allocation_pools': {'allow_post': True, 'allow_put': True,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:ip_pools': None},
|
|
'is_visible': True},
|
|
'dns_nameservers': {'allow_post': True, 'allow_put': True,
|
|
'convert_to':
|
|
lib_converters.convert_none_to_empty_list,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:nameservers': None},
|
|
'is_visible': True},
|
|
'host_routes': {'allow_post': True, 'allow_put': True,
|
|
'convert_to':
|
|
lib_converters.convert_none_to_empty_list,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:hostroutes': None},
|
|
'is_visible': True},
|
|
'tenant_id': {'allow_post': True, 'allow_put': False,
|
|
'validate': {
|
|
'type:string': db_const.PROJECT_ID_FIELD_SIZE},
|
|
'required_by_policy': True,
|
|
'is_visible': True},
|
|
'enable_dhcp': {'allow_post': True, 'allow_put': True,
|
|
'default': True,
|
|
'convert_to': lib_converters.convert_to_boolean,
|
|
'is_visible': True},
|
|
'ipv6_ra_mode': {'allow_post': True, 'allow_put': False,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:values': constants.IPV6_MODES},
|
|
'is_visible': True},
|
|
'ipv6_address_mode': {'allow_post': True, 'allow_put': False,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:values':
|
|
constants.IPV6_MODES},
|
|
'is_visible': True},
|
|
SHARED: {'allow_post': False,
|
|
'allow_put': False,
|
|
'default': False,
|
|
'convert_to': lib_converters.convert_to_boolean,
|
|
'is_visible': False,
|
|
'required_by_policy': True,
|
|
'enforce_policy': True},
|
|
},
|
|
SUBNETPOOLS: {
|
|
'id': {'allow_post': False,
|
|
'allow_put': False,
|
|
'validate': {'type:uuid': None},
|
|
'is_visible': True,
|
|
'primary_key': True},
|
|
'name': {'allow_post': True,
|
|
'allow_put': True,
|
|
'validate': {'type:not_empty_string': None},
|
|
'is_visible': True},
|
|
'tenant_id': {'allow_post': True,
|
|
'allow_put': False,
|
|
'validate': {
|
|
'type:string': db_const.PROJECT_ID_FIELD_SIZE},
|
|
'required_by_policy': True,
|
|
'is_visible': True},
|
|
'prefixes': {'allow_post': True,
|
|
'allow_put': True,
|
|
'validate': {'type:subnet_list': None},
|
|
'is_visible': True},
|
|
'default_quota': {'allow_post': True,
|
|
'allow_put': True,
|
|
'validate': {'type:non_negative': None},
|
|
'convert_to': lib_converters.convert_to_int,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'is_visible': True},
|
|
'ip_version': {'allow_post': False,
|
|
'allow_put': False,
|
|
'is_visible': True},
|
|
'default_prefixlen': {'allow_post': True,
|
|
'allow_put': True,
|
|
'validate': {'type:non_negative': None},
|
|
'convert_to': lib_converters.convert_to_int,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'is_visible': True},
|
|
'min_prefixlen': {'allow_post': True,
|
|
'allow_put': True,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:non_negative': None},
|
|
'convert_to': lib_converters.convert_to_int,
|
|
'is_visible': True},
|
|
'max_prefixlen': {'allow_post': True,
|
|
'allow_put': True,
|
|
'default': constants.ATTR_NOT_SPECIFIED,
|
|
'validate': {'type:non_negative': None},
|
|
'convert_to': lib_converters.convert_to_int,
|
|
'is_visible': True},
|
|
'is_default': {'allow_post': True,
|
|
'allow_put': True,
|
|
'default': False,
|
|
'convert_to': lib_converters.convert_to_boolean,
|
|
'is_visible': True,
|
|
'required_by_policy': True,
|
|
'enforce_policy': True},
|
|
SHARED: {'allow_post': True,
|
|
'allow_put': False,
|
|
'default': False,
|
|
'convert_to': lib_converters.convert_to_boolean,
|
|
'is_visible': True,
|
|
'required_by_policy': True,
|
|
'enforce_policy': True},
|
|
}
|
|
}
|
|
|
|
# Identify the attribute used by a resource to reference another resource
|
|
|
|
RESOURCE_FOREIGN_KEYS = {
|
|
NETWORKS: 'network_id'
|
|
}
|
|
|
|
|
|
def get_collection_info(collection):
|
|
"""Helper function to retrieve attribute info.
|
|
|
|
:param collection: Collection or plural name of the resource
|
|
"""
|
|
return RESOURCE_ATTRIBUTE_MAP.get(collection)
|