whoami-rajat ba4e54589d Add heat-status upgrade check command framework

This adds basic framework for heat-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: I83629184b49a6cf91928df702db23156433d99f6
Story: 2003657
Task: 26131

2018-10-22 14:19:36 +00:00

1.7 KiB

Raw Blame History

heat-status

Synopsis

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

Description

heat-status is a tool that provides routines for checking the status of a Heat deployment.

Options

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

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

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

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

heat-status upgrade

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

Upgrade

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

12.0.0 (Stein)

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

1.7 KiB Raw Blame History