Lacking documentation for new projects using oslo.policy

Bug #1766953 reported by Lance Bragstad
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
oslo.policy
Fix Released
Undecided
Lance Bragstad

Bug Description

We've had a couple massive efforts across the community to make our usage of policy more consistent by 1.) registering policies in code [0] and 2.) documenting what APIs those policies protect.

Now that the goal is for the most part complete [1], we could enhance the oslo.policy documentation to describe how people start fresh if they are getting started, or just starting to implement oslo.policy in their projects.

This would be different than the stance we took in the completion criteria for the community goal since that was for the most part a migration. This was mentioned in the -nova channel about the policy situation with the placement service [2], and it seems like a document describing the process for projects in that position would be helpful.

[0] https://governance.openstack.org/tc/goals/queens/policy-in-code.html
[1] https://www.lbragstad.com/policy-burndown/
[2] http://eavesdrop.openstack.org/irclogs/%23openstack-nova/%23openstack-nova.2018-04-25.log.html#t2018-04-25T19:02:20

tags: added: documentation
description: updated
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to oslo.policy (master)

Fix proposed to branch: master
Review: https://review.openstack.org/564340

Changed in oslo.policy:
assignee: nobody → Lance Bragstad (lbragstad)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to oslo.policy (master)

Reviewed: https://review.openstack.org/564340
Committed: https://git.openstack.org/cgit/openstack/oslo.policy/commit/?id=957f3feee8b8b0a828dbf56252c19aa79a51cde9
Submitter: Zuul
Branch: master

commit 957f3feee8b8b0a828dbf56252c19aa79a51cde9
Author: Lance Bragstad <email address hidden>
Date: Wed Apr 25 20:32:10 2018 +0000

    Update documentation to include usage for new projects

    The oslo.policy bits to generate documentation and use the oslo.policy
    CLI scripts is usually copy/pasted from other services that have
    already done that work. This commit attempts to pull that information
    into the usage section of oslo.policy, complete with examples, instead
    of making OpenStack developers hunt through projects to find examples
    they can use. Or wonder why or how this tooling works.

    Change-Id: Ie74888b09bb836c192a88c5beddd86297c8bceda
    Closes-Bug: 1766953

Changed in oslo.policy:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/oslo.policy 1.36.0

This issue was fixed in the openstack/oslo.policy 1.36.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.