openstack/oslo.policy
Code Issues Proposed changes

Merge "Update docs on policy sample generator"

Browse Source
This commit is contained in:
Jenkins 2016-09-28 23:07:22 +00:00 committed by Gerrit Code Review
commit a3fe9b2d8b
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/usage.rst
View File

@ -90,15 +90,14 @@ In setup.cfg of a project using oslo.policy::
[entry_points] [entry_points]
oslo.policy.policies = oslo.policy.policies =
nova.api = nova.api.opts:list_policies nova = nova.policy:list_policies
nova.compute.api = nova.compute.api.opts:list_policies
where list_policies is a method that returns a list of policy.RuleDefault where list_policies is a method that returns a list of policy.RuleDefault
objects. objects.
Run the oslopolicy-sample-generator script with some configuration options:: Run the oslopolicy-sample-generator script with some configuration options::
oslopolicy-sample-generator --namespace nova.api --namespace nova.compute.api --output-file policy-sample.yaml oslopolicy-sample-generator --namespace nova --output-file policy-sample.yaml
or:: or::
@ -108,8 +107,7 @@ where policy-generator.conf looks like::
[DEFAULT] [DEFAULT]
output_file = policy-sample.yaml output_file = policy-sample.yaml
namespace = nova.api namespace = nova
namespace = nova.compute.api
If output_file is ommitted the sample file will be sent to stdout. If output_file is ommitted the sample file will be sent to stdout.