diff options
Diffstat (limited to 'nova/compute/provider_config.py')
| -rw-r--r-- | nova/compute/provider_config.py | 278 |
1 files changed, 278 insertions, 0 deletions
diff --git a/nova/compute/provider_config.py b/nova/compute/provider_config.py new file mode 100644 index 0000000000..e6fd7fbe5c --- /dev/null +++ b/nova/compute/provider_config.py @@ -0,0 +1,278 @@ +# 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 jsonschema +import logging +import microversion_parse +import yaml + +from nova import exception as nova_exc +from nova.i18n import _ + +LOG = logging.getLogger(__name__) + +# A dictionary with keys for all supported major versions with lists of +# corresponding minor versions as values. +SUPPORTED_SCHEMA_VERSIONS = { + 1: {0} +} + +# Supported provider config file schema +SCHEMA_V1 = { + # This defintion uses JSON Schema Draft 7. + # https://json-schema.org/draft-07/json-schema-release-notes.html + 'type': 'object', + 'properties': { + # This property is used to track where the provider.yaml file + # originated. It is reserved for internal use and should never be + # set in a provider.yaml file supplied by an end user. + '__source_file': {'not': {}}, + 'meta': { + 'type': 'object', + 'properties': { + # Version ($Major, $minor) of the schema must successfully + # parse documents conforming to ($Major, 0..N). + # Any breaking schema change (e.g. removing fields, adding + # new required fields, imposing a stricter pattern on a value, + # etc.) must bump $Major. + 'schema_version': { + 'type': 'string', + 'pattern': '^1.([0-9]|[1-9][0-9]+)$' + } + }, + 'required': ['schema_version'], + 'additionalProperties': True + }, + 'providers': { + 'type': 'array', + 'items': { + 'type': 'object', + 'properties': { + 'identification': { + '$ref': '#/$defs/providerIdentification' + }, + 'inventories': { + '$ref': '#/$defs/providerInventories' + }, + 'traits': { + '$ref': '#/$defs/providerTraits' + } + }, + 'required': ['identification'], + 'additionalProperties': True + } + } + }, + 'required': ['meta'], + 'additionalProperties': True, + '$defs': { + 'providerIdentification': { + # Identify a single provider to configure. + # Exactly one identification method should be used. Currently + # `uuid` or `name` are supported, but future versions may + # support others. The uuid can be set to the sentinel value + # `$COMPUTE_NODE` which will cause the consuming compute service to + # apply the configuration to all compute node root providers + # it manages that are not otherwise specified using a uuid or name. + 'type': 'object', + 'properties': { + 'uuid': { + 'oneOf': [ + { + # TODO(sean-k-mooney): replace this with type uuid + # when we can depend on a version of the jsonschema + # lib that implements draft 8 or later of the + # jsonschema spec. + 'type': 'string', + 'pattern': + '^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-' + '[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-' + '[0-9A-Fa-f]{12}$' + }, + { + 'type': 'string', + 'const': '$COMPUTE_NODE' + } + ] + }, + 'name': { + 'type': 'string', + 'minLength': 1, + 'maxLength': 200 + } + }, + # This introduces the possibility of an unsupported key name being + # used to get by schema validation, but is necessary to support + # forward compatibility with new identification methods. + # This should be checked after schema validation. + 'minProperties': 1, + 'maxProperties': 1, + 'additionalProperties': False + }, + 'providerInventories': { + # Allows the admin to specify various adjectives to create and + # manage providers' inventories. This list of adjectives can be + # extended in the future as the schema evolves to meet new use + # cases. As of v1.0, only one adjective, `additional`, is + # supported. + 'type': 'object', + 'properties': { + 'additional': { + 'type': 'array', + 'items': { + 'patternProperties': { + # Allows any key name matching the resource class + # pattern, check to prevent conflicts with virt + # driver owned resouces classes will be done after + # schema validation. + '^[A-Z0-9_]{1,255}$': { + 'type': 'object', + 'properties': { + # Any optional properties not populated + # will be given a default value by + # placement. If overriding a pre-existing + # provider values will not be preserved + # from the existing inventory. + 'total': { + 'type': 'integer' + }, + 'reserved': { + 'type': 'integer' + }, + 'min_unit': { + 'type': 'integer' + }, + 'max_unit': { + 'type': 'integer' + }, + 'step_size': { + 'type': 'integer' + }, + 'allocation_ratio': { + 'type': 'number' + } + }, + 'required': ['total'], + # The defined properties reflect the current + # placement data model. While defining those + # in the schema and not allowing additional + # properties means we will need to bump the + # schema version if they change, that is likely + # to be part of a large change that may have + # other impacts anyway. The benefit of stricter + # validation of property names outweighs the + # (small) chance of having to bump the schema + # version as described above. + 'additionalProperties': False + } + }, + # This ensures only keys matching the pattern + # above are allowed. + 'additionalProperties': False + } + } + }, + 'additionalProperties': True + }, + 'providerTraits': { + # Allows the admin to specify various adjectives to create and + # manage providers' traits. This list of adjectives can be extended + # in the future as the schema evolves to meet new use cases. + # As of v1.0, only one adjective, `additional`, is supported. + 'type': 'object', + 'properties': { + 'additional': { + 'type': 'array', + 'items': { + # Allows any value matching the trait pattern here, + # additional validation will be done after schema + # validation. + 'type': 'string', + 'pattern': '^[A-Z0-9_]{1,255}$' + } + } + }, + 'additionalProperties': True + } + } +} + + +def _load_yaml_file(path): + """Loads and parses a provider.yaml config file into a dict. + + :param path: Path to the yaml file to load. + :return: Dict representing the yaml file requested. + :raise: ProviderConfigException if the path provided cannot be read + or the file is not valid yaml. + """ + try: + with open(path) as open_file: + try: + return yaml.safe_load(open_file) + except yaml.YAMLError as ex: + message = _("Unable to load yaml file: %s ") % ex + if hasattr(ex, 'problem_mark'): + pos = ex.problem_mark + message += _("File: %s ") % open_file.name + message += _("Error position: (%s:%s)") % ( + pos.line + 1, pos.column + 1) + raise nova_exc.ProviderConfigException(error=message) + except OSError: + message = _("Unable to read yaml config file: %s") % path + raise nova_exc.ProviderConfigException(error=message) + + +def _parse_provider_yaml(path): + """Loads schema, parses a provider.yaml file and validates the content. + + :param path: File system path to the file to parse. + :return: dict representing the contents of the file. + :raise ProviderConfigException: If the specified file does + not validate against the schema, the schema version is not supported, + or if unable to read configuration or schema files. + """ + yaml_file = _load_yaml_file(path) + + try: + schema_version = microversion_parse.parse_version_string( + yaml_file['meta']['schema_version']) + except (KeyError, TypeError): + message = _("Unable to detect schema version: %s") % yaml_file + raise nova_exc.ProviderConfigException(error=message) + + if schema_version.major not in SUPPORTED_SCHEMA_VERSIONS: + message = _( + "Unsupported schema major version: %d") % schema_version.major + raise nova_exc.ProviderConfigException(error=message) + + if schema_version.minor not in \ + SUPPORTED_SCHEMA_VERSIONS[schema_version.major]: + # TODO(sean-k-mooney): We should try to provide a better + # message that identifies which fields may be ignored + # and the max minor version supported by this version of nova. + message = ( + "Provider config file [%(path)s] is at schema version " + "%(schema_version)s. Nova supports the major version, " + "but not the minor. Some fields may be ignored." + % {"path": path, "schema_version": schema_version}) + LOG.warning(message) + + try: + jsonschema.validate(yaml_file, SCHEMA_V1) + except jsonschema.exceptions.ValidationError as e: + message = _( + "The provider config file %(path)s did not pass validation " + "for schema version %(schema_version)s: %(reason)s") % { + "path": path, "schema_version": schema_version, "reason": e} + raise nova_exc.ProviderConfigException(error=message) + return yaml_file |