325001045c
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
13 lines
619 B
YAML
13 lines
619 B
YAML
---
|
|
deprecations:
|
|
- |
|
|
Use of JSON formatted policy files was deprecated by the ``oslo.policy``
|
|
library during the Victoria development cycle. As a result, this
|
|
deprecation is being noted in the Wallaby cycle with an anticipated future
|
|
removal of JSON formatted file support by ``oslo.policy``. As such
|
|
operators will need to convert to YAML policy files.
|
|
Use the `oslopolicy-convert-json-to-yaml
|
|
<https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html>`_
|
|
tool to convert the existing JSON formatted policy file to YAML in a backward
|
|
compatible way.
|