From 70a4054f868c2300fa1ed239380f7a68f0d774ee Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Fri, 14 Jun 2019 15:48:07 +0100 Subject: [PATCH] docs: Update resize doc - 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 Depends-On: I733796d3bda6c3755a3d3548bbe695abb474a6a0 --- doc/source/user/resize.rst | 50 ++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/doc/source/user/resize.rst b/doc/source/user/resize.rst index 37c17a049fd6..53b4a133b496 100644 --- a/doc/source/user/resize.rst +++ b/doc/source/user/resize.rst @@ -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 + ` 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 ` - 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