zaqar/doc/source/cli/zaqar-status.rst
whoami-rajat 37fc134d11 Add zaqar-status upgrade check command framework
This adds basic framework for zaqar-status upgrade
check commands. For now it has only "check_placeholder"
check implemented.
Real checks can be added to this tool in the future.

Change-Id: I855b4b72284df308c3bb250fd3a3f0fc643b4abf
Story: 2003657
Task: 26165
2018-12-12 06:08:06 +00:00

1.7 KiB

zaqar-status

Synopsis

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

Description

zaqar-status is a tool that provides routines for checking the status of a Zaqar deployment.

Options

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

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

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

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

zaqar-status upgrade

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

Upgrade

zaqar-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

8.0.0 (Stein)

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