trove/doc/source/cli/trove-status.rst
Dariusz Krol f4b5c65dc0 Add upgrade status check - instances with assigned tasks
This check detects Trove instances in state other than Active
(identified by assigned None tasks), as such instances have some
kind of activity running, which requires communication between
the instance and Trove control plane.

Change-Id: I64901fd27dc97de8ee5e3bc693ec966d4f1a3346
Signed-off-by: Dariusz Krol <d.krol@samsung.com>
2019-01-15 19:54:03 +01:00

1.9 KiB

trove-status

Synopsis

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

Description

trove-status is a tool that provides routines for checking the status of a Trove deployment.

Options

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

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

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

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

trove-status upgrade

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

Upgrade

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

11.0.0 (Stein)

  • Checks if any Trove instance with assigned task is running. The assigned tasks may fail during the upgrade process due to transient unavailability of Trove control plane. Upgrade should be postponed until all instances are in the Active state.