[openstack-dev] [oslo][nova] Anyone interested in writing a policy generator sphinx extension?

Matt Riedemann mriedem at linux.vnet.ibm.com
Wed Sep 21 15:10:13 UTC 2016


On 9/21/2016 10:05 AM, Alexander Makarov wrote:
> What if policy will be manageable using RESTful API?
> I'd like to validate the idea to handle policies in keystone or
> affiliated service: https://review.openstack.org/#/c/325326/
>
> On 21.09.2016 17:49, Matt Riedemann wrote:
>> Nova has policy defaults in code now and we can generate the sample
>> using oslopolicy-sample-generator but we'd like to get the default
>> policy sample in the Nova developer documentation also, like we have
>> for nova.conf.sample.
>>
>> I see we use the sphinxconfiggen extension for building the
>> nova.conf.sample in our docs, but I don't see anything like that for
>> generating docs for a sample policy file.
>>
>> Has anyone already started working on that, or is interested in
>> working on that? I've never written a sphinx extension before but I'm
>> guessing it could be borrowed a bit from how sphinxconfiggen was
>> written in oslo.config.
>>
>
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>

I'm not sure how that's related to what I'm asking for here. We have 
policy defaults in code, and we want to generate those defaults into a 
sample policy file and have that in the docs. Sure the policy can be 
changed and customized later, but this isn't about that (or how that is 
done), it's just about documenting the default policy since the 
policy.json that ships in the nova tree now is empty. So we want to 
document the defaults, same as nova.conf.sample.

-- 

Thanks,

Matt Riedemann




More information about the OpenStack-dev mailing list