cloudkitty/doc/source/admin/cli/cloudkitty-status.rst
Luka Peschke b0487b6390 Support upgrade checks
This adds the ``cloudkitty-status upgrade check`` command to CloudKitty.
For now, this tool checks the storage version and raises a warning in case
v1 is used.

Depends-On: https://review.openstack.org/#/c/615928/
Change-Id: I39dc98fb716392a22765f169e2da0d389b33b941
Story: 2003657
Task: 26124
2019-02-04 08:42:21 +00:00

2.1 KiB

Cloudkitty Status CLI

This chapter documents cloudkitty-status.

For help on a specific cloudkitty-status command, enter:

$ cloudkitty-status COMMAND --help

cloudkitty-status

cloudkitty-status is a tool that provides routines for checking the status of a Cloudkitty deployment.

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

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

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

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

cloudkitty-status upgrade

The following sections describe the available categories and arguments for cloudkitty-status.

cloudkitty-status upgrade

cloudkitty-status upgrade check

cloudkitty-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.

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

9.0.0 (Stein)

  • Checks that the storage interface version is 2 (which is default).