Files
nova/doc/source/man/nova-status.rst
Matt Riedemann a1f3a5946a Add nova-status upgrade check command framework
This adds the basic framework for the nova-status
upgrade check commands. Follow up patches will flesh
this out to perform cells v2 and placement API related
upgrade status checks.

A man page is added for the new CLI and as part of that
the man page index is sorted.

Part of blueprint cells-scheduling-interaction
Part of blueprint resource-providers-scheduler-db-filters

Change-Id: I687dd7317703a1bb76c197ebba849ca368c0872e
2016-12-19 16:40:50 -05:00

2.6 KiB

nova-status

CLI interface for nova status commands

Author

openstack@lists.openstack.org

Date

2016-12-16

Copyright

OpenStack Foundation

Version

15.0.0

Manual section

1

Manual group

cloud computing

SYNOPSIS

nova-status <category> <action> [<args>]

DESCRIPTION

The nova-status command provides routines for checking the status of a Nova deployment.

OPTIONS

The standard pattern for executing a nova-status command is:

nova-status <category> <command> [<args>]

Run without arguments to see a list of available command categories:

nova-status

Categories are:

  • upgrade

Detailed descriptions are below.

You can also run with a category argument such as "upgrade" to see a list of all commands in that category:

nova-status upgrade

These sections describe the available categories and arguments for nova-status.

Upgrade

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 to databases and services within a cell. For example, this check may query the Nova API database and one or more cell databases. It may also make requests to other services such as the Placement REST API via the Keystone service catalog.

Return Codes

  1. All upgrade readiness checks passed successfully and there is nothing to do.
  2. At least one check encountered an issue and requires further investigation. This is considered a warning but the upgrade may be OK.
  3. There was an upgrade status check failure that needs to be investigated. This should be considered something that stops an upgrade.

History of Checks

15.0.0 (Ocata)

  • Checks are added for cells v2 so nova-status upgrade check should be run after running the nova-manage cell_v2 simple_cell_setup command.
  • Checks are added for the Placement API such that there is an endpoint in the Keystone service catalog, the service is running and the check can make a successful request to the endpoint. The command also checks to see that there are compute node resource providers checking in with the Placement service. More information on the Placement service can be found at: http://docs.openstack.org/developer/nova/placement.html

SEE ALSO

BUGS