From 47d8960af8b32c5696c5848052f94504ed38f077 Mon Sep 17 00:00:00 2001 From: Andrew Laski Date: Wed, 21 Sep 2016 11:06:43 -0400 Subject: [PATCH] Update docs on policy sample generator 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 --- doc/source/usage.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 3f90ee4a..144c0c56 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -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.