diff --git a/doc/source/cli/nova-status.rst b/doc/source/cli/nova-status.rst index f60db499cf59..6ca9bb2a425f 100644 --- a/doc/source/cli/nova-status.rst +++ b/doc/source/cli/nova-status.rst @@ -52,6 +52,8 @@ These sections describe the available categories and arguments for Upgrade ~~~~~~~ +.. _nova-status-checks: + ``nova-status upgrade check`` Performs a release-specific readiness check before restarting services with new code. This command expects to have complete configuration and access diff --git a/doc/source/user/upgrade.rst b/doc/source/user/upgrade.rst index 5a98a801f686..4cb77c9b7ec5 100644 --- a/doc/source/user/upgrade.rst +++ b/doc/source/user/upgrade.rst @@ -89,6 +89,11 @@ same time. * For maximum safety (no failed API operations), gracefully shutdown all the services (i.e. SIG_TERM) except nova-compute. + * Before restarting services with new code, perform the release-specific + readiness check with ``nova-status upgrade check``. See the + :ref:`nova-status upgrade check ` for more details + on status check. + * Start all services on the new code, with ``[upgrade_levels]compute=auto`` in nova.conf. It is safest to start nova-conductor first and nova-api last. Note that you may