fa95ef8772
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
45 lines
1.3 KiB
ReStructuredText
45 lines
1.3 KiB
ReStructuredText
===================
|
|
Configuration Guide
|
|
===================
|
|
|
|
The static configuration for Placement lives in two main files: ``placement.conf`` and
|
|
``policy.yaml``. These are described below.
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
* :doc:`Config Reference <config>`: A complete reference of all
|
|
configuration options available in the ``placement.conf`` file.
|
|
|
|
* :doc:`Sample Config File <sample-config>`: A sample config
|
|
file with inline documentation.
|
|
|
|
.. TODO(efried):: Get this working
|
|
* :nova-doc:`Configuration Guide </admin/configuration/index>`: Detailed
|
|
configuration guides for various parts of you Nova system. Helpful reference
|
|
for setting up specific hypervisor backends.
|
|
|
|
Policy
|
|
------
|
|
|
|
Placement, like most OpenStack projects, uses a policy language to restrict
|
|
permissions on REST API actions.
|
|
|
|
* :doc:`Policy Reference <policy>`: A complete
|
|
reference of all policy points in placement and what they impact.
|
|
|
|
* :doc:`Sample Policy File <sample-policy>`: A sample
|
|
placement policy file with inline documentation.
|
|
|
|
|
|
.. # NOTE(mriedem): This is the section where we hide things that we don't
|
|
# actually want in the table of contents but sphinx build would fail if
|
|
# they aren't in the toctree somewhere.
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
policy
|
|
sample-policy
|
|
config
|
|
sample-config
|