placement/doc/source/configuration/policy.rst
Ghanshyam Mann fa95ef8772 [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: Ia7365cc3ae09e2ff916ab9f9ff0ba4fef0dc446b
2021-01-15 20:34:51 +00:00

19 lines
607 B
ReStructuredText

==================
Placement Policies
==================
.. warning::
JSON formatted policy file is deprecated since Placement 5.0.0 (Wallaby).
The `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 an overview of all available policies in Placement.
For a sample configuration file, refer to
:doc:`/configuration/sample-policy`.
.. show-policy::
:config-file: etc/placement/policy-generator.conf