Files
cinder/doc/source/cli/cinder-status.rst
Sean McGinnis 1729c889c2 Base framework for cinder-status upgrade check
This adds the cinder-status CLI for performing upgrade checks as part of
the Stein cycle upgrade-checkers goal. It only includes a placeholder
for actual checks. Follow up patches will need to be added for anything
we identify as needing specific checking.

Story: 2003657
Task: 26123
Change-Id: I2e532d313d12e60848b17e869882e52ec456929b
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2018-10-17 11:51:04 -04:00

2.2 KiB

cinder-status

CLI interface for cinder status commands

Author

openstack@lists.openstack.org

Copyright

OpenStack Foundation

Manual section

1

Manual group

cloud computing

Synopsis

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

Description

cinder-status is a tool that provides routines for checking the status of a Cinder deployment.

Options

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

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

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

cinder-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:

cinder-status upgrade

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

Upgrade

cinder-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 the database. It may also make requests to other services' REST API via the Keystone service catalog.

Return Codes

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

History of Checks

14.0.0 (Stein)

  • Placeholder to be filled in with checks as they are added in Stein.

See Also

Bugs