yahoo-eng-team team mailing list archive

[Matt Riedemann <mriedem.os@xxxxxxxxx>]

Public bug reported:

- [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

** Affects: nova
     Importance: Medium
         Status: Triaged


** Tags: api-guide docs low-hanging-fruit resize

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1816859

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

Status in OpenStack Compute (nova):
  Triaged

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

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1816859/+subscriptions