openstack/placement
Code Issues Proposed changes
8d60e4af2d
placement/doc/source/configuration/index.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

1.3 KiB
Raw Blame History

Configuration Guide

The static configuration for Placement lives in two main files: placement.conf and policy.yaml. These are described below.

Configuration

  • Config Reference <config>: A complete reference of all configuration options available in the placement.conf file.
  • Sample Config File <sample-config>: A sample config file with inline documentation.

Policy

Placement, like most OpenStack projects, uses a policy language to restrict permissions on REST API actions.

  • Policy Reference <policy>: A complete reference of all policy points in placement and what they impact.
  • Sample Policy File <sample-policy>: A sample placement policy file with inline documentation.

policy sample-policy config sample-config