Masahito Muroi 3c3f943b2f Move blazar-status docs to admin section

The blazar-status CLI is a tool for a cloud admin. Its documentation
is listed in CLI section mixed with user's CLI documentation.

This patch moves the blazar-status CLI's documentation to the admin
documentation section.

Change-Id: I63a1f7800e3950ef8676970c96b0986a5292988b

2018-11-06 17:01:46 +09:00

1.7 KiB

Raw Blame History

blazar-status

Synopsis

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

Description

blazar-status is a tool that provides routines for checking the status of a Blazar deployment.

Options

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

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

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

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

blazar-status upgrade

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

Upgrade

blazar-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 databases and services.

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

3.0.0 (Stein)

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

1.7 KiB Raw Blame History