diff options
| author | Ghanshyam Mann <gmann@ghanshyammann.com> | 2020-08-26 08:37:02 -0500 |
|---|---|---|
| committer | Ghanshyam Mann <gmann@ghanshyammann.com> | 2020-08-27 21:42:16 +0000 |
| commit | d8ca7c2789b510532be27f6dff32756454ed59f1 (patch) | |
| tree | f198b6f9092f3dbb5f5936005b92edd69ff59f08 /releasenotes | |
| parent | e40632bb4b1783599aecc01ddcba363930811790 (diff) | |
| download | oslo-policy-d8ca7c2789b510532be27f6dff32756454ed59f1.tar.gz | |
Deprecate the JSON support for policy_file
JSON support for policy_file has been problematic
since projects started policy-in-code. For example,
generating a sample policy file in JSON results in
all the policy-in-code rules being overridden because
it is not possible to comment out the default rules in JSON.
Asd part of migration of JSON format to YAML, this commit
deprecates the:
1. Deprecate JSON support in oslo.policy.
2. Deprecate JSON output in policy CLI tools including '--format'
option.
Partial implement blueprint policy-json-to-yaml
Change-Id: I5432a8cf80903620f48936cbbfb92ea6b6ff30fa
Diffstat (limited to 'releasenotes')
| -rw-r--r-- | releasenotes/notes/deprecate-policy-file-json-format-e1921f15b5d00287.yaml | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/releasenotes/notes/deprecate-policy-file-json-format-e1921f15b5d00287.yaml b/releasenotes/notes/deprecate-policy-file-json-format-e1921f15b5d00287.yaml new file mode 100644 index 0000000..b02a9d8 --- /dev/null +++ b/releasenotes/notes/deprecate-policy-file-json-format-e1921f15b5d00287.yaml @@ -0,0 +1,12 @@ +--- +deprecations: + - | + ``policy_file`` support for JSON formatted file is deprecated. Use + YAML formatted file which will be default in future. + Use `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 to YAML formatted policy file in + backward compatible way. + + JSON format support and ``--format`` option in ``oslopolicy-sample-generator`` + and ``oslopolicy-policy-upgrade`` tools are also deprecated. In future + release, ``--format`` option will be removed. |