0526718fee
oslo.policy emits a deprecation warning for every single rule that we have deprecated at least once when a request comes in, and possibly subsequent times if keystone is running in multiple processes, and even more after keystone is reloaded. It's not useful to repeat nearly identical multi-line messages for each policy every time: logs aren't meant to justify our reasoning, they're just meant to be informative. The relevant information and rationalization can be found in the release notes. Repeating these identical multi-line messages starts to use up space quickly and makes the logs unreadable. This patch reduces the DEPRECATED_REASON for each policy to one brief line, which should help make the logs more readable in general and especially when run in a multiprocess environment, reduce the disk footprint of the logs, and help with log indexing. Change-Id: I98a0c06586b18dbd2f6681a24a5af1ea2de70951 Partial-bug: #1836568
212 lines
8.9 KiB
Python
212 lines
8.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 oslo_log import versionutils
|
|
from oslo_policy import policy
|
|
|
|
from keystone.common.policies import base
|
|
|
|
deprecated_list_endpoint_groups = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'list_endpoint_groups',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_get_endpoint_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'get_endpoint_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_list_projects_associated_with_endpoint_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'list_projects_associated_with_endpoint_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_list_endpoints_associated_with_endpoint_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'list_endpoints_associated_with_endpoint_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_get_endpoint_group_in_project = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'get_endpoint_group_in_project',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_list_endpoint_groups_for_project = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'list_endpoint_groups_for_project',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_create_endpoint_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'create_endpoint_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_update_endpoint_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'update_endpoint_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_delete_endpoint_group = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'delete_endpoint_group',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_add_endpoint_group_to_project = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'add_endpoint_group_to_project',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
deprecated_remove_endpoint_group_from_project = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'remove_endpoint_group_from_project',
|
|
check_str=base.RULE_ADMIN_REQUIRED,
|
|
)
|
|
|
|
|
|
DEPRECATED_REASON = (
|
|
"The endpoint groups API is now aware of system scope and default roles."
|
|
)
|
|
|
|
|
|
group_endpoint_policies = [
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'create_endpoint_group',
|
|
check_str=base.SYSTEM_ADMIN,
|
|
scope_types=['system'],
|
|
description='Create endpoint group.',
|
|
operations=[{'path': '/v3/OS-EP-FILTER/endpoint_groups',
|
|
'method': 'POST'}],
|
|
deprecated_rule=deprecated_create_endpoint_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'list_endpoint_groups',
|
|
check_str=base.SYSTEM_READER,
|
|
scope_types=['system'],
|
|
description='List endpoint groups.',
|
|
operations=[{'path': '/v3/OS-EP-FILTER/endpoint_groups',
|
|
'method': 'GET'}],
|
|
deprecated_rule=deprecated_list_endpoint_groups,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'get_endpoint_group',
|
|
check_str=base.SYSTEM_READER,
|
|
scope_types=['system'],
|
|
description='Get endpoint group.',
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}'),
|
|
'method': 'GET'},
|
|
{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}'),
|
|
'method': 'HEAD'}],
|
|
deprecated_rule=deprecated_get_endpoint_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'update_endpoint_group',
|
|
check_str=base.SYSTEM_ADMIN,
|
|
scope_types=['system'],
|
|
description='Update endpoint group.',
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}'),
|
|
'method': 'PATCH'}],
|
|
deprecated_rule=deprecated_update_endpoint_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'delete_endpoint_group',
|
|
check_str=base.SYSTEM_ADMIN,
|
|
scope_types=['system'],
|
|
description='Delete endpoint group.',
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}'),
|
|
'method': 'DELETE'}],
|
|
deprecated_rule=deprecated_delete_endpoint_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'list_projects_associated_with_endpoint_group',
|
|
check_str=base.SYSTEM_READER,
|
|
scope_types=['system'],
|
|
description=('List all projects associated with a specific endpoint '
|
|
'group.'),
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}/projects'),
|
|
'method': 'GET'}],
|
|
deprecated_rule=deprecated_list_projects_associated_with_endpoint_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'list_endpoints_associated_with_endpoint_group',
|
|
check_str=base.SYSTEM_READER,
|
|
scope_types=['system'],
|
|
description='List all endpoints associated with an endpoint group.',
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}/endpoints'),
|
|
'method': 'GET'}],
|
|
deprecated_rule=deprecated_list_endpoints_associated_with_endpoint_group,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'get_endpoint_group_in_project',
|
|
check_str=base.SYSTEM_READER,
|
|
scope_types=['system'],
|
|
description=('Check if an endpoint group is associated with a '
|
|
'project.'),
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}/projects/{project_id}'),
|
|
'method': 'GET'},
|
|
{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}/projects/{project_id}'),
|
|
'method': 'HEAD'}],
|
|
deprecated_rule=deprecated_get_endpoint_group_in_project,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'list_endpoint_groups_for_project',
|
|
check_str=base.SYSTEM_READER,
|
|
scope_types=['system'],
|
|
description='List endpoint groups associated with a specific project.',
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/projects/{project_id}/'
|
|
'endpoint_groups'),
|
|
'method': 'GET'}],
|
|
deprecated_rule=deprecated_list_endpoint_groups_for_project,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'add_endpoint_group_to_project',
|
|
check_str=base.SYSTEM_ADMIN,
|
|
scope_types=['system'],
|
|
description='Allow a project to access an endpoint group.',
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}/projects/{project_id}'),
|
|
'method': 'PUT'}],
|
|
deprecated_rule=deprecated_add_endpoint_group_to_project,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'remove_endpoint_group_from_project',
|
|
check_str=base.SYSTEM_ADMIN,
|
|
scope_types=['system'],
|
|
description='Remove endpoint group from project.',
|
|
operations=[{'path': ('/v3/OS-EP-FILTER/endpoint_groups/'
|
|
'{endpoint_group_id}/projects/{project_id}'),
|
|
'method': 'DELETE'}],
|
|
deprecated_rule=deprecated_remove_endpoint_group_from_project,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.TRAIN)
|
|
]
|
|
|
|
|
|
def list_rules():
|
|
return group_endpoint_policies
|