384 lines
13 KiB
Python
384 lines
13 KiB
Python
# Copyright 2014 NEC Corporation. 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.
|
|
|
|
import copy
|
|
|
|
from nova.api.validation import parameter_types
|
|
from nova.api.validation.parameter_types import multi_params
|
|
|
|
|
|
base_create = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'server': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': parameter_types.name,
|
|
# NOTE(gmann): In case of boot from volume, imageRef was
|
|
# allowed as the empty string also So keeping the same
|
|
# behavior and allow empty string in case of boot from
|
|
# volume only. Python code make sure empty string is
|
|
# not allowed for other cases.
|
|
'imageRef': parameter_types.image_id_or_empty_string,
|
|
'flavorRef': parameter_types.flavor_ref,
|
|
'adminPass': parameter_types.admin_password,
|
|
'metadata': parameter_types.metadata,
|
|
'networks': {
|
|
'type': 'array',
|
|
'items': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'fixed_ip': parameter_types.ip_address,
|
|
'port': {
|
|
'oneOf': [{'type': 'string', 'format': 'uuid'},
|
|
{'type': 'null'}]
|
|
},
|
|
'uuid': {'type': 'string'},
|
|
},
|
|
'additionalProperties': False,
|
|
}
|
|
},
|
|
'OS-DCF:diskConfig': parameter_types.disk_config,
|
|
'accessIPv4': parameter_types.accessIPv4,
|
|
'accessIPv6': parameter_types.accessIPv6,
|
|
'personality': parameter_types.personality,
|
|
},
|
|
'required': ['name', 'flavorRef'],
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
'required': ['server'],
|
|
'additionalProperties': False,
|
|
}
|
|
|
|
|
|
base_create_v20 = copy.deepcopy(base_create)
|
|
base_create_v20['properties']['server'][
|
|
'properties']['name'] = parameter_types.name_with_leading_trailing_spaces
|
|
|
|
|
|
base_create_v219 = copy.deepcopy(base_create)
|
|
base_create_v219['properties']['server'][
|
|
'properties']['description'] = parameter_types.description
|
|
|
|
|
|
base_create_v232 = copy.deepcopy(base_create_v219)
|
|
base_create_v232['properties']['server'][
|
|
'properties']['networks']['items'][
|
|
'properties']['tag'] = parameter_types.tag
|
|
|
|
|
|
# 2.37 builds on 2.32 and makes the following changes:
|
|
# 1. server.networks is required
|
|
# 2. server.networks is now either an enum or a list
|
|
# 3. server.networks.uuid is now required to be a uuid
|
|
base_create_v237 = copy.deepcopy(base_create_v232)
|
|
base_create_v237['properties']['server']['required'].append('networks')
|
|
base_create_v237['properties']['server']['properties']['networks'] = {
|
|
'oneOf': [
|
|
{'type': 'array',
|
|
'items': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'fixed_ip': parameter_types.ip_address,
|
|
'port': {
|
|
'oneOf': [{'type': 'string', 'format': 'uuid'},
|
|
{'type': 'null'}]
|
|
},
|
|
'uuid': {'type': 'string', 'format': 'uuid'},
|
|
},
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
{'type': 'string', 'enum': ['none', 'auto']},
|
|
]}
|
|
|
|
|
|
# 2.42 builds on 2.37 and re-introduces the tag field to the list of network
|
|
# objects.
|
|
base_create_v242 = copy.deepcopy(base_create_v237)
|
|
base_create_v242['properties']['server']['properties']['networks'] = {
|
|
'oneOf': [
|
|
{'type': 'array',
|
|
'items': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'fixed_ip': parameter_types.ip_address,
|
|
'port': {
|
|
'oneOf': [{'type': 'string', 'format': 'uuid'},
|
|
{'type': 'null'}]
|
|
},
|
|
'uuid': {'type': 'string', 'format': 'uuid'},
|
|
'tag': parameter_types.tag,
|
|
},
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
{'type': 'string', 'enum': ['none', 'auto']},
|
|
]}
|
|
|
|
|
|
base_update = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'server': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': parameter_types.name,
|
|
'OS-DCF:diskConfig': parameter_types.disk_config,
|
|
'accessIPv4': parameter_types.accessIPv4,
|
|
'accessIPv6': parameter_types.accessIPv6,
|
|
},
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
'required': ['server'],
|
|
'additionalProperties': False,
|
|
}
|
|
|
|
|
|
base_update_v20 = copy.deepcopy(base_update)
|
|
base_update_v20['properties']['server'][
|
|
'properties']['name'] = parameter_types.name_with_leading_trailing_spaces
|
|
|
|
base_update_v219 = copy.deepcopy(base_update)
|
|
base_update_v219['properties']['server'][
|
|
'properties']['description'] = parameter_types.description
|
|
|
|
base_rebuild = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'rebuild': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': parameter_types.name,
|
|
'imageRef': parameter_types.image_id,
|
|
'adminPass': parameter_types.admin_password,
|
|
'metadata': parameter_types.metadata,
|
|
'preserve_ephemeral': parameter_types.boolean,
|
|
'OS-DCF:diskConfig': parameter_types.disk_config,
|
|
'accessIPv4': parameter_types.accessIPv4,
|
|
'accessIPv6': parameter_types.accessIPv6,
|
|
'personality': parameter_types.personality,
|
|
},
|
|
'required': ['imageRef'],
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
'required': ['rebuild'],
|
|
'additionalProperties': False,
|
|
}
|
|
|
|
|
|
base_rebuild_v20 = copy.deepcopy(base_rebuild)
|
|
base_rebuild_v20['properties']['rebuild'][
|
|
'properties']['name'] = parameter_types.name_with_leading_trailing_spaces
|
|
|
|
base_rebuild_v219 = copy.deepcopy(base_rebuild)
|
|
base_rebuild_v219['properties']['rebuild'][
|
|
'properties']['description'] = parameter_types.description
|
|
|
|
base_resize = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'resize': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'flavorRef': parameter_types.flavor_ref,
|
|
'OS-DCF:diskConfig': parameter_types.disk_config,
|
|
},
|
|
'required': ['flavorRef'],
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
'required': ['resize'],
|
|
'additionalProperties': False,
|
|
}
|
|
|
|
create_image = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'createImage': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': parameter_types.name,
|
|
'metadata': parameter_types.metadata
|
|
},
|
|
'required': ['name'],
|
|
'additionalProperties': False
|
|
}
|
|
},
|
|
'required': ['createImage'],
|
|
'additionalProperties': False
|
|
}
|
|
|
|
|
|
create_image_v20 = copy.deepcopy(create_image)
|
|
create_image_v20['properties']['createImage'][
|
|
'properties']['name'] = parameter_types.name_with_leading_trailing_spaces
|
|
|
|
|
|
reboot = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'reboot': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'type': {
|
|
'enum': ['HARD', 'Hard', 'hard', 'SOFT', 'Soft', 'soft']
|
|
}
|
|
},
|
|
'required': ['type'],
|
|
'additionalProperties': False
|
|
}
|
|
},
|
|
'required': ['reboot'],
|
|
'additionalProperties': False
|
|
}
|
|
|
|
trigger_crash_dump = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'trigger_crash_dump': {
|
|
'type': 'null'
|
|
}
|
|
},
|
|
'required': ['trigger_crash_dump'],
|
|
'additionalProperties': False
|
|
}
|
|
|
|
# NOTE: We don't check actual values of queries on params
|
|
# which are defined as the following common_param.
|
|
common_param = multi_params({'type': 'string'})
|
|
common_regex_param = multi_params({'type': 'string', 'format': 'regex'})
|
|
|
|
JOINED_TABLE_QUERY_PARAMS_SERVERS = {
|
|
'block_device_mapping': common_param,
|
|
'services': common_param,
|
|
'metadata': common_param,
|
|
'system_metadata': common_param,
|
|
'info_cache': common_param,
|
|
'security_groups': common_param,
|
|
'pci_devices': common_param
|
|
}
|
|
|
|
# These fields are valid values for sort_keys before we start
|
|
# using schema validation, but are considered to be bad values
|
|
# and disabled to use. In order to avoid backward incompatibility,
|
|
# they are ignored instead of return HTTP 400.
|
|
SERVER_LIST_IGNORE_SORT_KEY = [
|
|
'architecture', 'cell_name', 'cleaned', 'default_ephemeral_device',
|
|
'default_swap_device', 'deleted', 'deleted_at', 'disable_terminate',
|
|
'ephemeral_gb', 'ephemeral_key_uuid', 'id', 'key_data', 'launched_on',
|
|
'locked', 'memory_mb', 'os_type', 'reservation_id', 'root_gb',
|
|
'shutdown_terminate', 'user_data', 'vcpus', 'vm_mode'
|
|
]
|
|
|
|
|
|
VALID_SORT_KEYS = {
|
|
"type": "string",
|
|
"enum": ['access_ip_v4', 'access_ip_v6', 'auto_disk_config',
|
|
'availability_zone', 'config_drive', 'created_at',
|
|
'display_description', 'display_name', 'host', 'hostname',
|
|
'image_ref', 'instance_type_id', 'kernel_id', 'key_name',
|
|
'launch_index', 'launched_at', 'locked_by', 'node', 'power_state',
|
|
'progress', 'project_id', 'ramdisk_id', 'root_device_name',
|
|
'task_state', 'terminated_at', 'updated_at', 'user_id', 'uuid',
|
|
'vm_state'] +
|
|
SERVER_LIST_IGNORE_SORT_KEY
|
|
}
|
|
|
|
query_params_v21 = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'user_id': common_param,
|
|
'project_id': common_param,
|
|
# The alias of project_id. It should be removed in the
|
|
# future with microversion bump.
|
|
'tenant_id': common_param,
|
|
'launch_index': common_param,
|
|
# The alias of image. It should be removed in the
|
|
# future with microversion bump.
|
|
'image_ref': common_param,
|
|
'image': common_param,
|
|
'kernel_id': common_regex_param,
|
|
'ramdisk_id': common_regex_param,
|
|
'hostname': common_regex_param,
|
|
'key_name': common_regex_param,
|
|
'power_state': common_regex_param,
|
|
'vm_state': common_param,
|
|
'task_state': common_param,
|
|
'host': common_param,
|
|
'node': common_regex_param,
|
|
'flavor': common_regex_param,
|
|
'reservation_id': common_regex_param,
|
|
'launched_at': common_regex_param,
|
|
'terminate_at': common_regex_param,
|
|
'availability_zone': common_regex_param,
|
|
# NOTE(alex_xu): This is pattern matching, it didn't get any benefit
|
|
# from DB index.
|
|
'name': common_regex_param,
|
|
# The alias of name. It should be removed in the future
|
|
# with microversion bump.
|
|
'display_name': common_regex_param,
|
|
'description': common_regex_param,
|
|
# The alias of description. It should be removed in the
|
|
# future with microversion bump.
|
|
'display_description': common_regex_param,
|
|
'locked_by': common_regex_param,
|
|
'uuid': common_param,
|
|
'root_device_name': common_regex_param,
|
|
'config_drive': common_regex_param,
|
|
'accessIPv4': common_regex_param,
|
|
'accessIPv6': common_regex_param,
|
|
'auto_disk_config': common_regex_param,
|
|
'progress': common_regex_param,
|
|
'sort_key': multi_params(VALID_SORT_KEYS),
|
|
'sort_dir': common_param,
|
|
'all_tenants': common_param,
|
|
'deleted': common_param,
|
|
'status': common_param,
|
|
'changes-since': multi_params({'type': 'string',
|
|
'format': 'date-time'}),
|
|
# NOTE(alex_xu): The ip and ip6 are implemented in the python.
|
|
'ip': common_regex_param,
|
|
'ip6': common_regex_param,
|
|
'created_at': common_regex_param,
|
|
},
|
|
# For backward-compatible additionalProperties is set to be True here.
|
|
# And we will either strip the extra params out or raise HTTP 400
|
|
# according to the params' value in the later process.
|
|
'additionalProperties': True,
|
|
# Prevent internal-attributes that are started with underscore from
|
|
# being striped out in schema validation, and raise HTTP 400 in API.
|
|
'patternProperties': {"^_": common_param}
|
|
}
|
|
|
|
# Update the joined-table fields to the list so it will not be
|
|
# stripped in later process, thus can be handled later in api
|
|
# to raise HTTP 400.
|
|
query_params_v21['properties'].update(
|
|
JOINED_TABLE_QUERY_PARAMS_SERVERS)
|
|
|
|
query_params_v21['properties'].update(
|
|
parameter_types.pagination_parameters)
|
|
|
|
query_params_v226 = copy.deepcopy(query_params_v21)
|
|
query_params_v226['properties'].update({
|
|
'tags': common_regex_param,
|
|
'tags-any': common_regex_param,
|
|
'not-tags': common_regex_param,
|
|
'not-tags-any': common_regex_param,
|
|
})
|