openstack/nova
Code Issues Proposed changes

Merge "docs: Update resize doc"

Browse Source
This commit is contained in:
Zuul 2019-10-03 19:44:57 +00:00 committed by Gerrit Code Review
commit 5ee7a7d5da
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
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
@ -13,25 +20,17 @@ To resize an instance, use the :command:`openstack server resize` command:
.. note::
By default, the :command:`openstack server resize` command gives
the guest operating
system a chance to perform a controlled shutdown before the instance
is powered off and the instance is resized.
The shutdown behavior is configured by the
:oslo.config:option:`shutdown_timeout` parameter that can be set in the
``nova.conf`` file. Its value stands for the overall
period (in seconds) a guest operating system is allowed
to complete the shutdown. The default timeout is 60 seconds.
By default, the :command:`openstack server resize` command gives the guest
operating system a chance to perform a controlled shutdown before the
instance is powered off and the instance is resized. This behavior can be
configured by the administrator but it can also be overridden on a per image
basis using the ``os_shutdown_timeout`` image metadata setting. This allows
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.
The timeout value can be overridden on a per image basis
by means of ``os_shutdown_timeout`` that is an image metadata
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``:
Resizing can take some time. During this time, the instance status will be
``RESIZE``:
.. code-block:: console
@ -47,17 +46,16 @@ You can now confirm the resize to change the status to ``ACTIVE``:
.. code-block:: console
$ openstack server resize --confirm SERVER
$ openstack server resize confirm SERVER
.. note::
The resized server may be automatically confirmed based on
the administrator's configuration of the deployment.
The resized server may be automatically confirmed based on the
administrator's configuration of the deployment.
If the resize fails or does not work as expected, you can revert the resize.
This will revert the instance to the old flavor and change the status to
``ACTIVE``:
If the resize does not work as expected, you can revert the resize. This will
revert the instance to the old flavor and change the status to ``ACTIVE``:
.. code-block:: console
$ openstack server resize --revert SERVER
$ openstack server resize revert SERVER