nova secgroup-list-default-rules help text is misleading

Bug #1430354 reported by Chris St. Pierre on 2015-03-10
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
python-novaclient
Wishlist
Chris St. Pierre

Bug Description

The help text for the 'nova secgroup-{add,delete,list}-default-rules?' family of commands is misleading. For instance:

    secgroup-add-default-rule Add a rule to the default security group.

In this help text, "the default security group" must be understood as distinct from "the security group named 'default'" or "the security group which is the default for the current tenant"; it is instead a sort of meta-security group that is the default for new projects. That isn't even remotely clear in the help text for this, or for secgroup-delete-default-rule or secgroup-list-default-rules.

Given the length constraints of the help text I'm not sure how to remedy this, but it'd sure be nice to find better help text for these options.

melanie witt (melwitt) on 2015-03-10
Changed in python-novaclient:
importance: Undecided → Wishlist
status: New → Confirmed

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

Changed in python-novaclient:
assignee: nobody → Chris St. Pierre (stpierre)
status: Confirmed → In Progress

Reviewed: https://review.openstack.org/163264
Committed: https://git.openstack.org/cgit/openstack/python-novaclient/commit/?id=b7972478ff656bc6fa1cc909b617b02b0dfb28b7
Submitter: Jenkins
Branch: master

commit b7972478ff656bc6fa1cc909b617b02b0dfb28b7
Author: Chris St. Pierre <email address hidden>
Date: Tue Mar 10 21:27:45 2015 -0500

    Update help messages for default security group commands

    The secgroup-{add,delete,list}-default-rules? family of commands has
    confusing help text that makes it sounds like they actually operate on
    the default security group (that is, the security group named
    'default' which is the default for the current tenant). Instead, the
    operate on a sort of meta-security-group object which is only used to
    populate the 'default' security group in newly-created tenants. This
    is crazy confusing. These commands get fancy new help strings that
    should hopefully make it a little more clear.

    Closes-Bug: 1430354
    Change-Id: I4d9569ba7ea9ad7a20e984df7a137c99240a9748

Changed in python-novaclient:
status: In Progress → Fix Committed
Michael Still (mikal) on 2015-03-17
Changed in python-novaclient:
milestone: none → 2.23.0
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers