cinder/releasenotes
Ghanshyam Mann 325001045c [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
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 project side
via warning in doc and format releasenotes.

1st item if already done by cinder in Stein so this commit
only cover the 2nd item.

Since oslo.policy 3.6.0, by default oslo policy will
fallback to existing policy.json file to give operator some
time to migrate it to new default policy.yaml. But cinder
already changed the default value to policy.yaml long back
since Stein so no need to fallback to default JSON file. To
do that it disable this fallback via flag to oslo.policy.

Also convert the tests/unit/policy.json to policy.yaml file.

Additionally, made some corrections to outdated documentation
when removing references to a "policy.json" file.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Co-Authored-By: Brian Rosmaita <rosmaita.fossdev@gmail.com>

Change-Id: Iaf8a454e60d1e4b66981b61175f89203cc15e439
2020-12-11 18:31:04 -06:00
..
notes [goal] Deprecate the JSON formatted policy file 2020-12-11 18:31:04 -06:00
source Imported Translations from Zanata 2020-12-11 06:17:11 +00:00
README.rst Fix release notes link 2017-07-25 14:24:18 -07:00

Release notes

The release notes for a patch should be included in the patch. The intended audience for release notes include deployers, administrators and end-users.

A release note is required if the patch has upgrade or API impact. It is also required if the patch adds a feature or fixes a long-standing or security bug.

Please see https://docs.openstack.org/cinder/latest/contributor/releasenotes.html for more details.