keystone/doc/source/cli/keystone-status.rst
ZhongShengping 5f90447b40 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: I7cd39dacaa1f2cdc2d74da39ae3971246e922907
2019-04-24 11:51:00 +08:00

115 lines
2.9 KiB
ReStructuredText

keystone-status
~~~~~~~~~~~~~~~
-----------------------
Keystone Status Utility
-----------------------
:Author: openstack@lists.openstack.org
:Date: 2018-10-15
:Copyright: OpenStack Foundation
:Version: 15.0.0
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
.. code-block:: console
keystone-status [options]
DESCRIPTION
===========
``keystone-status`` is a command line tool that helps operators upgrade their
deployment.
USAGE
=====
.. code-block:: console
keystone-status [options] action [additional args]
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::
keystone-status upgrade
These sections describe the available categories and arguments for
:command:`keystone-status`.
Categories and commands
-----------------------
``keystone-status upgrade check``
Performs a release-specific readiness check before restarting services with
new code, or upgrading. This command expects to have complete configuration
and access to the database.
**Return Codes**
.. list-table::
:widths: 20 80
:header-rows: 1
* - 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**
**15.0.0 (Stein)**
* Placeholder to be filled in with checks as they are added in Stein.
OPTIONS
=======
.. code-block:: console
-h, --help show this help message and exit
--config-dir DIR Path to a config directory to pull \*.conf files from.
This file set is sorted, so as to provide a
predictable parse order if individual options are
over-ridden. The set is parsed after the file(s)
specified via previous --config-file, arguments hence
over-ridden options in the directory take precedence.
--config-file PATH Path to a config file to use. Multiple config files
can be specified, with values in later files taking
precedence. Defaults to None.
FILES
=====
None
SEE ALSO
========
* `OpenStack Keystone <https://docs.openstack.org/keystone/latest>`__
SOURCE
======
* Keystone is sourced on `opendev.org <https://opendev.org/openstack/keystone>`__
* Keystone bugs are managed at Launchpad `Keystone <https://bugs.launchpad.net/keystone>`__