neutron/doc/source/cli/neutron-status.rst
Adrian Chiris a8b5afa41e Add upgrade check for NIC Switch agent
This commit adds an upgrade check for NIC switch agent
alerting operators to ensure relevant hosts have kernel >= 3.13.

This check is introduced due to recent cleanup in NIC switch
agent code.

As of U release, Supported CentOS major was updated to 8 so it
is not expected that any deployment will have hosts running
kernel < 3.13. This check is added as an extra precaution.

This check should be removed in 1-2 cycles. A TODO was added to
reflect that.

Change-Id: I34003b3c2f0ac23185d036c9e47dc1c8662d6ce7
Related-bug: #1841067
2019-12-01 11:58:16 +02:00

70 lines
1.8 KiB
ReStructuredText

.. This file is manually generated, unlike many of the other chapters.
==============
neutron-status
==============
The :command:`neutron-status` provides routines for checking the status of
Neutron deployment.
.. _neutron-status_usage:
neutron-status usage
~~~~~~~~~~~~~~~~~~~~
.. code-block:: console
usage: neutron-status [-h] [--config-dir DIR] [--config-file PATH]
<category> <command>
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::
neutron-status upgrade
These sections describe the available categories and arguments for
:command:`neutron-status`.
Command details
---------------
``neutron-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**
.. 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**
**21.0.0 (Ussuri)**
* A Check was added for NIC Switch agents to ensure nodes are running with
kernel 3.13 or newer. This check serves as a notification for operators
to ensure this requirement is fullfiled on relevant nodes.