openstack
/
governance
Code Issues Proposed changes

Adding reno and warnings example for JSON->YAML goal doc 

Change-Id: I6d56870b4e3afe8691051a7e6acb250be3652ba0
This commit is contained in:
Ghanshyam Mann 2020-11-02 10:37:07 -06:00
parent fe7e4a908d
commit 533b6542d6
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
goals/proposed/migrate-policy-format-from-json-to-yaml.rst
View File

@ -65,6 +65,32 @@ What projects need to do:
Once all project finish this, we will be able to deprecate it in Oslo policy
also which allow policy deprecation without causing pain to OpenStack deployers.
Release notes sample::
---
deprecations:
- |
The default value of the ``[oslo_policy] policy_file`` config option has been
changed from ``policy.json``
to ``policy.yaml``. The current default value of the ``[oslo_policy] policy_file``
config option (``policy.json``) does not work for deprecated policy rules
when ``policy.json`` is generated by the
`oslopolicy-sample-generator
<https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-sample-generator.html>`_
tool. 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.
Doc warning sample::
.. warning::
JSON formatted policy file is deprecated since <project version>(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
Example: