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
128 lines
4.8 KiB
Python
128 lines
4.8 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_get_sp = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'get_service_provider',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_list_sp = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'list_service_providers',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_update_sp = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'update_service_provider',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_create_sp = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'create_service_provider',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
deprecated_delete_sp = policy.DeprecatedRule(
|
|
name=base.IDENTITY % 'delete_service_provider',
|
|
check_str=base.RULE_ADMIN_REQUIRED
|
|
)
|
|
|
|
DEPRECATED_REASON = (
|
|
"The service provider API is now aware of system scope and default roles."
|
|
)
|
|
|
|
service_provider_policies = [
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'create_service_provider',
|
|
check_str=base.SYSTEM_ADMIN,
|
|
# FIXME(lbragstad): Today, keystone doesn't support federation without
|
|
# modifying configuration files. It makes sense to require system scope
|
|
# for these operations until keystone supports a way to add federated
|
|
# identity and service providers strictly over the API. At that point,
|
|
# it will make sense to include `project` in the list of `scope_types`
|
|
# for service provider policies.
|
|
scope_types=['system'],
|
|
description='Create federated service provider.',
|
|
operations=[{'path': ('/v3/OS-FEDERATION/service_providers/'
|
|
'{service_provider_id}'),
|
|
'method': 'PUT'}],
|
|
deprecated_rule=deprecated_create_sp,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'list_service_providers',
|
|
check_str=base.SYSTEM_READER,
|
|
scope_types=['system'],
|
|
description='List federated service providers.',
|
|
operations=[
|
|
{
|
|
'path': '/v3/OS-FEDERATION/service_providers',
|
|
'method': 'GET'
|
|
},
|
|
{
|
|
'path': '/v3/OS-FEDERATION/service_providers',
|
|
'method': 'HEAD'
|
|
}
|
|
],
|
|
deprecated_rule=deprecated_list_sp,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'get_service_provider',
|
|
check_str=base.SYSTEM_READER,
|
|
scope_types=['system'],
|
|
description='Get federated service provider.',
|
|
operations=[
|
|
{
|
|
'path': ('/v3/OS-FEDERATION/service_providers/'
|
|
'{service_provider_id}'),
|
|
'method': 'GET'
|
|
},
|
|
{
|
|
'path': ('/v3/OS-FEDERATION/service_providers/'
|
|
'{service_provider_id}'),
|
|
'method': 'HEAD'
|
|
}
|
|
],
|
|
deprecated_rule=deprecated_get_sp,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'update_service_provider',
|
|
check_str=base.SYSTEM_ADMIN,
|
|
scope_types=['system'],
|
|
description='Update federated service provider.',
|
|
operations=[{'path': ('/v3/OS-FEDERATION/service_providers/'
|
|
'{service_provider_id}'),
|
|
'method': 'PATCH'}],
|
|
deprecated_rule=deprecated_update_sp,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN),
|
|
policy.DocumentedRuleDefault(
|
|
name=base.IDENTITY % 'delete_service_provider',
|
|
check_str=base.SYSTEM_ADMIN,
|
|
scope_types=['system'],
|
|
description='Delete federated service provider.',
|
|
operations=[{'path': ('/v3/OS-FEDERATION/service_providers/'
|
|
'{service_provider_id}'),
|
|
'method': 'DELETE'}],
|
|
deprecated_rule=deprecated_delete_sp,
|
|
deprecated_reason=DEPRECATED_REASON,
|
|
deprecated_since=versionutils.deprecated.STEIN)
|
|
]
|
|
|
|
|
|
def list_rules():
|
|
return service_provider_policies
|