kuryr/doc/source/cli/kuryr-status.rst
whoami-rajat d75eaff065 Add kuryr-status upgrade check command framework
This adds basic framework for kuryr-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: I8af38f087672a390ec8b2b78916315b5a646fcbb
Story: 2003657
Task: 26137
2018-10-23 16:51:51 +05:30

1.7 KiB

kuryr-status

Synopsis

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

Description

kuryr-status is a tool that provides routines for checking the status of a Kuryr deployment.

Options

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

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

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

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

kuryr-status upgrade

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

Upgrade

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

0.9.0 (Stein)

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