openstack/cinder
Code Issues Proposed changes
cinder/doc/source/cli/cinder-status.rst
Brian Rosmaita b0279f2080 Introduce config to supplement periodic_interval 
Because the periodic_interval config option is used in several
places, it is difficult to tune its value.  This patch restricts
the use of periodic_interval to its original purpose and introduces
four new config options that may be tuned independently:
* backup_driver_init_check_interval
* backup_driver_status_check_interval
* scheduler_driver_init_wait_time
* backend_stats_polling_interval

Includes release note and upgrade check.

Change-Id: I498484b06cd379ad65f6f0d18aaaeb85214d4b1e
Closes-bug: #1823748
2019-04-10 11:27:47 -04:00

2.6 KiB
Raw Blame History

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.

15.0.0 (Train)

  • Check added to make operators aware of new finer-grained configuration options affecting the periodicity of various Cinder tasks. Triggered when the the periodic_interval option is not set to its default value.

See Also

Bugs