akhiljain23 3a83fc8b9d Add framework for vitrage-status upgrade check

This commit adds the functionality of vitrage-status CLI for performing
upgrade checks as part of the Stein cycle upgrade-checkers goal.
It only includes a sample check which must be replaced by real checks in
future.

Change-Id: Ib0c880b15a2f99a4db75654b5c41c6f10d9261af
Story: 2003657
Task: 26163

2018-12-05 16:35:23 -05:00

1.9 KiB

Raw Blame History

vitrage-status

CLI interface for Vitrage status commands

Synopsis

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

Description

vitrage-status is a tool that provides routines for checking the status of a Vitrage deployment.

Options

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

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

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

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

vitrage-status upgrade

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

Upgrade

vitrage-status upgrade check

Performs a release-specific readiness check before restarting services with new code. For example, missing or changed configuration options, incompatible object states, or other conditions that could lead to failures while upgrading.

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

4.0.0 (Stein)

Sample check to be filled in with checks as they are added in Stein.

1.9 KiB Raw Blame History