Use DocumentedRuleDefault where possible

Bug #1716772 reported by Lance Bragstad on 2017-09-12
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Medium
Pavlo Shchelokovskyy

Bug Description

Ironic moved policy into code during the Newton release. According to the Queens community goal [0], there is an opportunity to document policies in code. Ironic can complete this by using DocumentedRuleDefault instead of RuleDefault where applicable and supplying the needed operations attribute.

This bug report can be used as a tracking document in the community goal.

[0] https://governance.openstack.org/tc/goals/queens/policy-in-code.html

Changed in ironic:
assignee: nobody → Pavlo Shchelokovskyy (pshchelo)
Changed in ironic:
status: New → In Progress
Ruby Loo (rloo) wrote :
Dmitry Tantsur (divius) on 2017-09-25
Changed in ironic:
importance: Undecided → Medium

Reviewed: https://review.openstack.org/502519
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=297ef395e474e610f4b4348859fe23401b19b9cc
Submitter: Jenkins
Branch: master

commit 297ef395e474e610f4b4348859fe23401b19b9cc
Author: Lance Bragstad <email address hidden>
Date: Mon Sep 11 17:32:17 2017 +0000

    Use DocumentedRuleDefault instead of RuleDefault

    The policy-and-docs-in-code Queens goal outlines the work
    required for projects to move policy into code and document the
    operations and defaults.

    This commit replaces occurrences of RuleDefault
    with DocumentedRuleDefault where appropriate,
    which requires additional attributes when used that supply more
    documentation in rendered policy files.
    Using DocumentedRuleDefault produces more descriptive generated policy
    descriptons in 'configuration' section of ironic docs.

    Change-Id: Idc35a5fbe2583e5fd712108a48eb9cec7cbecb76
    Closes-Bug: #1716772

Changed in ironic:
status: In Progress → Fix Released

This issue was fixed in the openstack/ironic 9.2.0 release.

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

Other bug subscribers