fe413fe01d
As per the community goal of migrating the policy file the format from JSON to YAML[1], we need to do two things: 1. Change the default value of '[oslo_policy] policy_file'' config option from 'policy.json' to 'policy.yaml' with upgrade checks. 2. Deprecate the JSON formatted policy file on the project side via warning in doc and releasenotes. Also replace policy.json to policy.yaml ref from doc and tests. [1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html Change-Id: I0dbb8484e749e645627756e88ec79c1b26a6414a
29 lines
778 B
ReStructuredText
29 lines
778 B
ReStructuredText
================
|
|
Policy Reference
|
|
================
|
|
|
|
.. warning::
|
|
|
|
JSON formatted policy file is deprecated since Neutron 18.0.0 (Wallaby).
|
|
This `oslopolicy-convert-json-to-yaml`__ tool will migrate your existing
|
|
JSON-formatted policy file to YAML in a backward-compatible way.
|
|
|
|
.. __: https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html
|
|
|
|
Neutron, like most OpenStack projects, uses a policy language to restrict
|
|
permissions on REST API actions.
|
|
|
|
The following is an overview of all available policies in neutron.
|
|
|
|
.. only:: html
|
|
|
|
For a sample policy file, refer to :doc:`/configuration/policy-sample`.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
policy-sample
|
|
|
|
.. show-policy::
|
|
:config-file: etc/oslo-policy-generator/policy.conf
|