akhil e7c13b8ae0 Add framework for congress-status upgrade check

This commit adds the functionality of congress-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: I27204c1c2dce2443eaa18a85144cbc892d61b551
Story: 2003657
Task: 26125

2018-10-19 13:31:25 +00:00

1.9 KiB

Raw Blame History

congress-status

CLI interface for congress status commands

Synopsis

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

Description

congress-status is a tool that provides routines for checking the status of a Congress deployment.

Options

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

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

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

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

congress-status upgrade

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

Upgrade

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

9.0.0 (Stein)

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

1.9 KiB Raw Blame History