openstack/nova
Code Issues Proposed changes

docs: Update resize doc

Browse Source 
- Remove references to configuration options (which end-users will not
  be able to set)
- Switch from the '--confirm' and '--revert' flags to the top-level
  commands
- You can't revert a failed resize so don't suggest otherwise
- Fix some wrapping

Change-Id: I934e7ca327ff4c9bb9b00d1df3323df05da956d9
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Depends-On: I733796d3bda6c3755a3d3548bbe695abb474a6a0
This commit is contained in:
Stephen Finucane 2019-06-14 15:48:07 +01:00 committed by Stephen Finucane
parent 775d89ed0f
commit 70a4054f86
1 changed files with 24 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
doc/source/user/resize.rst
View File

@ -5,7 +5,14 @@ Resize an instance
You can change the size of an instance by changing its flavor. This rebuilds You can change the size of an instance by changing its flavor. This rebuilds
the instance and therefore results in a restart. the instance and therefore results in a restart.
To resize an instance, use the :command:`openstack server resize` command: To list the VMs you want to resize, run:
.. code-block:: console
$ openstack server list
Once you have the name or UUID of the server you wish to resize, resize it
using the :command:`openstack server resize` command:
.. code-block:: console .. code-block:: console
@ -13,25 +20,17 @@ To resize an instance, use the :command:`openstack server resize` command:
.. note:: .. note::
By default, the :command:`openstack server resize` command gives By default, the :command:`openstack server resize` command gives the guest
the guest operating operating system a chance to perform a controlled shutdown before the
system a chance to perform a controlled shutdown before the instance instance is powered off and the instance is resized. This behavior can be
is powered off and the instance is resized. configured by the administrator but it can also be overridden on a per image
The shutdown behavior is configured by the basis using the ``os_shutdown_timeout`` image metadata setting. This allows
:oslo.config:option:`shutdown_timeout` parameter that can be set in the different types of operating systems to specify how much time they need to
``nova.conf`` file. Its value stands for the overall shut down cleanly. See :glance-doc:`Useful image properties
period (in seconds) a guest operating system is allowed <admin/useful-image-properties>` for details.
to complete the shutdown. The default timeout is 60 seconds.
The timeout value can be overridden on a per image basis Resizing can take some time. During this time, the instance status will be
by means of ``os_shutdown_timeout`` that is an image metadata ``RESIZE``:
setting allowing different types of operating systems to specify
how much time they need to shut down cleanly. See
:glance-doc:`Useful image properties <admin/useful-image-properties>`
for details.
Resizing can take some time.
During this time, the instance status will be ``RESIZE``:
.. code-block:: console .. code-block:: console
@ -47,17 +46,16 @@ You can now confirm the resize to change the status to ``ACTIVE``:
.. code-block:: console .. code-block:: console
$ openstack server resize --confirm SERVER $ openstack server resize confirm SERVER
.. note:: .. note::
The resized server may be automatically confirmed based on The resized server may be automatically confirmed based on the
the administrator's configuration of the deployment. administrator's configuration of the deployment.
If the resize fails or does not work as expected, you can revert the resize. If the resize does not work as expected, you can revert the resize. This will
This will revert the instance to the old flavor and change the status to revert the instance to the old flavor and change the status to ``ACTIVE``:
``ACTIVE``:
.. code-block:: console .. code-block:: console
$ openstack server resize --revert SERVER $ openstack server resize revert SERVER