Server concepts in nova - automatic resize confirm is wrong in docs

Bug #1816859 reported by Matt Riedemann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Medium
Takashi Natsume

Bug Description

- [x] This doc is inaccurate in this way:

The section on resize:

https://developer.openstack.org/api-guide/compute/server_concepts.html#server-actions

says:

"All resizes are automatically confirmed after 24 hours if you do not confirm or revert them."

This is not true because the automatic confirm is based on the "resize_confirm_window" configuration option which by default is disabled:

https://docs.openstack.org/nova/latest/configuration/config.html#DEFAULT.resize_confirm_window

Since the guide already mentions this configuration option it's probably best to just remove the sentence about it.

While we're fixing this, we should probably also avoid calling out the config option specifically since it's up to the operator / cloud and not the end user about whether or not the resized server is automatically confirmed and how long the window is. So we could just say, "The resized server may be automatically confirmed based on the administrator's configuration of the deployment".

The place to mention automatically confirming a resized server should live in the admin docs:

https://docs.openstack.org/nova/latest/admin/configuration/resize.html

-----------------------------------
Release: 18.1.0.dev1308 on 2019-02-20 16:34:47.409737
SHA: af78b13c24d4abf393d17ac57e9135204ef12b73
Source: https://git.openstack.org/cgit/openstack/nova/tree/api-guide/source/server_concepts.rst
URL: https://developer.openstack.org/api-guide/compute/server_concepts.html

Changed in nova:
assignee: nobody → Takashi NATSUME (natsume-takashi)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

Changed in nova:
assignee: Takashi NATSUME (natsume-takashi) → Matt Riedemann (mriedem)
Matt Riedemann (mriedem)
Changed in nova:
assignee: Matt Riedemann (mriedem) → Takashi NATSUME (natsume-takashi)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/638357
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=5fdcb2ca4913f9813b50162131188a7520b41bd6
Submitter: Zuul
Branch: master

commit 5fdcb2ca4913f9813b50162131188a7520b41bd6
Author: Takashi NATSUME <email address hidden>
Date: Thu Feb 21 15:45:34 2019 +0900

    Remove wrong description for auto resize confirm

    Remove wrong description for auto resize confirm
    in the API guide.
    Move a description of a configuration option
    'resize_confirm_window' from the API guide
    to the admin configuration guide.
    Add a description of automatic resize confirm
    in the user guide.

    Change-Id: If739877422d5743e221c57be53ed877475db0647
    Closes-Bug: #1816859

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 19.0.0.0rc1

This issue was fixed in the openstack/nova 19.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.