cinder/doc/source/cli/cinder-status.rst
Sean McGinnis 8c6355f3cc
Add upgrade check for presence of policy.json file
Correct file is policy.yaml and only needed if overriding defaults. This
only warns if the file is present in case it was left by a previous
version and not actually needed or used.

Also checks for the policy_file being overridden in config, and if so,
warns if the specified file does not exist.

Change-Id: Ia46e843ad245cf8263b97b773fac9bc6c6fe6647
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-04-04 13:59:13 -05:00

2.4 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> <command> [<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)

  • Check added to ensure the backup_driver setting is using the full driver class path and not just the module path.
  • Checks for the presence of a policy.json file have been added to warn if policy changes should be present in a policy.yaml file.

See Also

Bugs