tacker/doc/source/configuration/sample_policy.rst
Ghanshyam Mann 40a48bde6b [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 tests.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: I6fc6f7d95e4efde6ea3bd0f1e4134aa54ce3889a
2021-01-22 04:18:31 +00:00

25 lines
828 B
ReStructuredText

=========================
Sample Tacker Policy File
=========================
.. warning::
JSON formatted policy file is deprecated since Tacker 5.0.0 (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
The following is a sample tacker policy file for adaptation and use.
The sample policy can also be viewed in :download:`file form
</_static/tacker.policy.yaml.sample>`.
.. important::
The sample policy file is auto-generated from tacker when this documentation
is built. You must ensure your version of tacker matches the version of this
documentation.
.. literalinclude:: /_static/tacker.policy.yaml.sample