157f358057
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
27 lines
1.1 KiB
ReStructuredText
27 lines
1.1 KiB
ReStructuredText
==================
|
|
Heat Sample Policy
|
|
==================
|
|
|
|
.. warning::
|
|
|
|
JSON formatted policy file is deprecated since Heat 17.0.0 (Xena).
|
|
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 heat policy file that has been auto-generated
|
|
from default policy values in code. If you're using the default policies, then
|
|
the maintenance of this file is not necessary, and it should not be copied into
|
|
a deployment. Doing so will result in duplicate policy definitions. It is here
|
|
to help explain which policy operations protect specific heat APIs, but it
|
|
is not suggested to copy and paste into a deployment unless you're planning on
|
|
providing a different policy for an operation that is not the default.
|
|
|
|
If you wish build a policy file, you can also use ``tox -e genpolicy`` to
|
|
generate it.
|
|
|
|
The sample policy file can also be downloaded in `file form <../_static/heat.policy.yaml.sample>`_.
|
|
|
|
.. literalinclude:: ../_static/heat.policy.yaml.sample
|