whoami-rajat d3280f18f3 Add barbican-status upgrade check command framework

This adds basic framework for barbican-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: I40bfcc0c8755e814c1b63fdf323c32fda967968e
Story: 2003657
Task: 26120

2019-01-15 06:16:53 +00:00

1.7 KiB

Raw Permalink Blame History

barbican-status

Synopsis

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

Description

barbican-status is a tool that provides routines for checking the status of a Barbican deployment.

Options

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

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

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

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

barbican-status upgrade

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

Upgrade

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

1.7 KiB Raw Permalink Blame History