change default quota command example is incorrect

Bug #1834057 reported by Nick Adams
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Low
Stephen Finucane
Pike
Confirmed
Medium
Unassigned
Queens
Fix Committed
Medium
Stephen Finucane
Rocky
Fix Committed
Medium
Stephen Finucane
Stein
Fix Committed
Medium
Stephen Finucane

Bug Description

- [x] This doc is inaccurate in this way: should have --class in the change default quota command example

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: http://ask.openstack.org
 - The mailing list: http://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: on 2018-02-06 10:47:25
SHA: f696660bf38693e492eec3e7a10bf80661ca6e60
Source: https://opendev.org/openstack/nova/src/doc/source/admin/quotas.rst
URL: https://docs.openstack.org/nova/latest/admin/quotas.html

Tags: doc quotas
Revision history for this message
Matt Riedemann (mriedem) wrote :

Goes back to pike:

https://review.opendev.org/#/c/490952/4/doc/source/admin/quotas.rst@89

And since the command usage was changed during the doc import, it likely means the whole page needs to be validated for accuracy at this point.

Changed in nova:
status: New → Triaged
importance: Undecided → High
importance: High → Medium
Revision history for this message
Matt Riedemann (mriedem) wrote :

This part is also wrong:

"$ openstack quota set --QUOTA_NAME QUOTA_VALUE PROJECT_OR_CLASS"

Because PROJECT_OR_CLASS will need to have the --class option if it's a class and not a project.

Revision history for this message
Matt Riedemann (mriedem) wrote :

In general, the nova CLI distinguishes quota classes from quotas set on projects, but openstack CLI does not - the latter uses the --class option and is not very well documented about what the --class is, that there is only one (default), and what it means relative to a project's quota which is explained here:

https://docs.openstack.org/nova/latest/user/quotas.html#checking-quota

tags: added: quotas
Changed in nova:
importance: Medium → Low
assignee: nobody → Stephen Finucane (stephenfinucane)
status: Triaged → Confirmed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.opendev.org/667164

Changed in nova:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (stable/stein)

Fix proposed to branch: stable/stein
Review: https://review.opendev.org/670096

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (stable/rocky)

Fix proposed to branch: stable/rocky
Review: https://review.opendev.org/670097

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (stable/queens)

Fix proposed to branch: stable/queens
Review: https://review.opendev.org/670100

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.opendev.org/667164
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=426790237e75eb184191bee1de50ee493252a717
Submitter: Zuul
Branch: master

commit 426790237e75eb184191bee1de50ee493252a717
Author: Stephen Finucane <email address hidden>
Date: Mon Jun 24 17:09:32 2019 +0100

    docs: Correct issues with 'openstack quota set' commands

    Change Ic857918b15496049b5ccacde9515f130cc0bd7e9 against
    openstack-manuals updated the quotas document to use openstackclient
    commands in place of novaclient commands. It missed the fact that you
    need to pass the '--class' parameter if you wish to set a quota for a
    class rather than a project. Correct this.

    Change-Id: I5dc65924fee65f6340d1495a9b1b992001c30731
    Signed-off-by: Stephen Finucane <email address hidden>
    Closes-Bug: #1834057

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (stable/stein)

Reviewed: https://review.opendev.org/670096
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=75a3ae933759fb89abd7ee9847fb6685c22a862c
Submitter: Zuul
Branch: stable/stein

commit 75a3ae933759fb89abd7ee9847fb6685c22a862c
Author: Stephen Finucane <email address hidden>
Date: Mon Jun 24 17:09:32 2019 +0100

    docs: Correct issues with 'openstack quota set' commands

    Change Ic857918b15496049b5ccacde9515f130cc0bd7e9 against
    openstack-manuals updated the quotas document to use openstackclient
    commands in place of novaclient commands. It missed the fact that you
    need to pass the '--class' parameter if you wish to set a quota for a
    class rather than a project. Correct this.

    Change-Id: I5dc65924fee65f6340d1495a9b1b992001c30731
    Signed-off-by: Stephen Finucane <email address hidden>
    Closes-Bug: #1834057
    (cherry picked from commit 426790237e75eb184191bee1de50ee493252a717)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (stable/rocky)

Reviewed: https://review.opendev.org/670097
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=5982c92fa883e40cf01faf58b84e5f93fd7ebdbb
Submitter: Zuul
Branch: stable/rocky

commit 5982c92fa883e40cf01faf58b84e5f93fd7ebdbb
Author: Stephen Finucane <email address hidden>
Date: Mon Jun 24 17:09:32 2019 +0100

    docs: Correct issues with 'openstack quota set' commands

    Change Ic857918b15496049b5ccacde9515f130cc0bd7e9 against
    openstack-manuals updated the quotas document to use openstackclient
    commands in place of novaclient commands. It missed the fact that you
    need to pass the '--class' parameter if you wish to set a quota for a
    class rather than a project. Correct this.

    Change-Id: I5dc65924fee65f6340d1495a9b1b992001c30731
    Signed-off-by: Stephen Finucane <email address hidden>
    Closes-Bug: #1834057
    (cherry picked from commit 426790237e75eb184191bee1de50ee493252a717)
    (cherry picked from commit 75a3ae933759fb89abd7ee9847fb6685c22a862c)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (stable/queens)

Reviewed: https://review.opendev.org/670100
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=92ecfaab5e66b151d831f524850755ff16a34a37
Submitter: Zuul
Branch: stable/queens

commit 92ecfaab5e66b151d831f524850755ff16a34a37
Author: Stephen Finucane <email address hidden>
Date: Mon Jun 24 17:09:32 2019 +0100

    docs: Correct issues with 'openstack quota set' commands

    Change Ic857918b15496049b5ccacde9515f130cc0bd7e9 against
    openstack-manuals updated the quotas document to use openstackclient
    commands in place of novaclient commands. It missed the fact that you
    need to pass the '--class' parameter if you wish to set a quota for a
    class rather than a project. Correct this.

    Change-Id: I5dc65924fee65f6340d1495a9b1b992001c30731
    Signed-off-by: Stephen Finucane <email address hidden>
    Closes-Bug: #1834057
    (cherry picked from commit 426790237e75eb184191bee1de50ee493252a717)
    (cherry picked from commit 75a3ae933759fb89abd7ee9847fb6685c22a862c)
    (cherry picked from commit 5982c92fa883e40cf01faf58b84e5f93fd7ebdbb)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 19.0.2

This issue was fixed in the openstack/nova 19.0.2 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 18.2.2

This issue was fixed in the openstack/nova 18.2.2 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 17.0.12

This issue was fixed in the openstack/nova 17.0.12 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 20.0.0.0rc1

This issue was fixed in the openstack/nova 20.0.0.0rc1 release candidate.

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.