diff options
| author | Ghanshyam Mann <gmann@ghanshyammann.com> | 2020-12-13 12:36:17 -0600 |
|---|---|---|
| committer | ricolin <ricolin@ricolky.com> | 2021-06-17 01:35:45 +0800 |
| commit | 157f358057c3e12158ee4ba354566c2ad5a9ecb5 (patch) | |
| tree | a2e855b16101a8a8fa29471036455e88fcd3f745 /releasenotes | |
| parent | f341395a4672ac913dc73d084a6f78cc0394e288 (diff) | |
| download | heat-157f358057c3e12158ee4ba354566c2ad5a9ecb5.tar.gz | |
[goal] Deprecate the JSON formatted policy file
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 code.
[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html
Change-Id: I1aa12bcd2638390f25d57ce8abeeec248121dc02
Diffstat (limited to 'releasenotes')
| -rw-r--r-- | releasenotes/notes/deprecate-json-formatted-policy-file-ac2f98b31ece0baf.yaml | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/releasenotes/notes/deprecate-json-formatted-policy-file-ac2f98b31ece0baf.yaml b/releasenotes/notes/deprecate-json-formatted-policy-file-ac2f98b31ece0baf.yaml new file mode 100644 index 000000000..00519ae7b --- /dev/null +++ b/releasenotes/notes/deprecate-json-formatted-policy-file-ac2f98b31ece0baf.yaml @@ -0,0 +1,20 @@ +--- +upgrade: + - | + The default value of ``[oslo_policy] policy_file`` config option has + been changed from ``policy.json`` to ``policy.yaml``. + Operators who are utilizing customized or previously generated + static policy JSON files (which are not needed by default), should + generate new policy files or convert them in YAML format. Use the + `oslopolicy-convert-json-to-yaml + <https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html>`_ + tool to convert a JSON to YAML formatted policy file in + backward compatible way. +deprecations: + - | + Use of JSON policy files was deprecated by the ``oslo.policy`` library + during the Victoria development cycle. As a result, this deprecation is + being noted in the Xena cycle with an anticipated future removal of support + by ``oslo.policy``. As such operators will need to convert to YAML policy + files. Please see the upgrade notes for details on migration of any + custom policy files. |