openstack/oslo.policy
Code Issues Proposed changes

Update docs on policy sample generator

Browse Source 
The docs for the policy sample generator were inconsistent with how it
is typically used in practice, with just one namespace. This led to
questions about using one namespace when in reality that's what happens.
This patch brings the example more in line with reality.

Change-Id: Id3c21459eff09aaf6e31c6f3aa4f8d829f87c513
This commit is contained in:
Andrew Laski 2016-09-21 11:06:43 -04:00
parent 6a4e90f46e
commit 47d8960af8
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]
oslo.policy.policies =
nova.api = nova.api.opts:list_policies
nova.compute.api = nova.compute.api.opts:list_policies
nova = nova.policy:list_policies
where list_policies is a method that returns a list of policy.RuleDefault
objects.
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::
@ -108,8 +107,7 @@ where policy-generator.conf looks like::
[DEFAULT]
output_file = policy-sample.yaml
namespace = nova.api
namespace = nova.compute.api
namespace = nova
If output_file is ommitted the sample file will be sent to stdout.