diff --git a/goals/proposed/migrate-policy-format-from-json-to-yaml.rst b/goals/proposed/migrate-policy-format-from-json-to-yaml.rst index 02ead0be1..8e0c9e449 100644 --- a/goals/proposed/migrate-policy-format-from-json-to-yaml.rst +++ b/goals/proposed/migrate-policy-format-from-json-to-yaml.rst @@ -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 + `_ + tool. Use the `oslopolicy-convert-json-to-yaml + `_ + 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 (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: