68c1f067bf
This patch added the document for new policy of cyborg inculding: * cyborg policy concepts * configuration guide * all policies in code Change-Id: I79472317c5c1b4aa2660e1c2d5cc61737299975a Story: 2007024 Task: 40934
28 lines
1.2 KiB
ReStructuredText
28 lines
1.2 KiB
ReStructuredText
====================
|
|
Cyborg Sample Policy
|
|
====================
|
|
|
|
.. warning::
|
|
|
|
JSON formatted policy file is deprecated since Cyborg 5.0.0(Victoria).
|
|
Use YAML formatted file. Use `oslopolicy-convert-json-to-yaml`__ tool
|
|
to convert the existing JSON to YAML formatted policy file in backward
|
|
compatible way.
|
|
|
|
.. __: https://docs.openstack.org/oslo.policy/latest/cli/oslopolicy-convert-json-to-yaml.html
|
|
|
|
The following is a sample cyborg 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 cyborg 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/cyborg.policy.yaml.sample>`_.
|
|
|
|
.. literalinclude:: /_static/cyborg.policy.yaml.sample
|