9ece3d35ab
The [placement]/policy_file option was necessary when placement was in nova since nova uses the standard [oslo_policy]/policy_file option for defining custom policy rules. Now that placement is extracted (+1 release) we can deprecate the placement-specific option and use the standard [oslo_policy]/policy_file option as well. The tricky thing with this is both options define a default value but those values are different, and neither need to exist or can exist but be empty and we'll use policy defaults from code. So some logic is necessary for detecting which option we should pass to the oslo.policy Enforcer object. We prefer to use [oslo_policy]/policy_file if it exists but will fallback to use [placement]/policy_file for backward compatibility. We also check for a couple of edge cases to try and detect misconfiguration and usage of the deprecated option. The config generation docs are updated to include the [oslo_policy] options as well as registering the options from that library for runtime code. Change-Id: Ifb14d2c14b17fc5bcdf7d124744ac2e1b58fd063 Story: #2005171 Task: #29913
99 lines
3.9 KiB
Python
99 lines
3.9 KiB
Python
# 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 __future__ import absolute_import
|
|
|
|
from oslo_config import cfg
|
|
|
|
|
|
DEFAULT_CONSUMER_MISSING_ID = '00000000-0000-0000-0000-000000000000'
|
|
|
|
placement_group = cfg.OptGroup(
|
|
'placement',
|
|
title='Placement Service Options',
|
|
help="Configuration options for connecting to the placement API service")
|
|
|
|
placement_opts = [
|
|
cfg.BoolOpt(
|
|
'randomize_allocation_candidates',
|
|
default=False,
|
|
help="""
|
|
If True, when limiting allocation candidate results, the results will be
|
|
a random sampling of the full result set. If False, allocation candidates
|
|
are returned in a deterministic but undefined order. That is, all things
|
|
being equal, two requests for allocation candidates will return the same
|
|
results in the same order; but no guarantees are made as to how that order
|
|
is determined.
|
|
"""),
|
|
# TODO(mriedem): When placement is split out of nova, this should be
|
|
# deprecated since then [oslo_policy]/policy_file can be used.
|
|
cfg.StrOpt(
|
|
'policy_file',
|
|
# This default matches what is in
|
|
# etc/nova/policy-generator.conf
|
|
default='policy.yaml',
|
|
deprecated_for_removal=True,
|
|
deprecated_since='2.0.0',
|
|
deprecated_reason="""
|
|
This option was necessary when placement was part of nova but can now be
|
|
replaced with the more standard usage of ``[oslo_policy]/policy_file`` which
|
|
has the same semantics but a different default value. If you have a custom
|
|
policy.yaml file and were not setting this option but just relying on the
|
|
default value, you need to configure placement to use
|
|
``[oslo_policy]/policy_file`` with policy.yaml specifically since otherwise
|
|
that option defaults to policy.json.
|
|
""",
|
|
help='The file that defines placement policies. This can be an '
|
|
'absolute path or relative to the configuration file.'),
|
|
cfg.StrOpt(
|
|
'incomplete_consumer_project_id',
|
|
default=DEFAULT_CONSUMER_MISSING_ID,
|
|
help="""
|
|
Early API microversions (<1.8) allowed creating allocations and not specifying
|
|
a project or user identifier for the consumer. In cleaning up the data
|
|
modeling, we no longer allow missing project and user information. If an older
|
|
client makes an allocation, we'll use this in place of the information it
|
|
doesn't provide.
|
|
"""),
|
|
cfg.StrOpt(
|
|
'incomplete_consumer_user_id',
|
|
default=DEFAULT_CONSUMER_MISSING_ID,
|
|
help="""
|
|
Early API microversions (<1.8) allowed creating allocations and not specifying
|
|
a project or user identifier for the consumer. In cleaning up the data
|
|
modeling, we no longer allow missing project and user information. If an older
|
|
client makes an allocation, we'll use this in place of the information it
|
|
doesn't provide.
|
|
"""),
|
|
]
|
|
|
|
|
|
# Duplicate log_options from oslo_service so that we don't have to import
|
|
# that package into placement.
|
|
# NOTE(cdent): Doing so ends up requiring eventlet and other unnecessary
|
|
# packages for just this one setting.
|
|
service_opts = [
|
|
cfg.BoolOpt('log_options',
|
|
default=True,
|
|
help='Enables or disables logging values of all registered '
|
|
'options when starting a service (at DEBUG level).'),
|
|
]
|
|
|
|
|
|
def register_opts(conf):
|
|
conf.register_group(placement_group)
|
|
conf.register_opts(placement_opts, group=placement_group)
|
|
conf.register_opts(service_opts)
|
|
|
|
|
|
def list_opts():
|
|
return {placement_group.name: placement_opts}
|