starlingx/docs
Code Issues Proposed changes

Update Collect Tool documentation to add new [--timeout] option

Browse Source 
- Added the "--all" option for the collect [--timeout | -t] code block.
- Updated command format.
- Updated the Collect Tool Caveats to add the collect [--timeout | -t] <minutes> option.

Signed-off-by: Elaine Fonaro <elaine.fonaro@windriver.com>
Change-Id: I4b802b2b89955d5cd7d2efae1a42c011e107484b
This commit is contained in:
Elaine Fonaro 2023-03-10 16:01:09 -03:00 committed by Ron Stone
parent 3eadca9791
commit a89624ebd2
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/fault-mgmt/kubernetes/troubleshooting-log-collection.rst
View File

@ -70,6 +70,15 @@ Collect Tool Caveats and Usage
to collect serially. ``--inline`` can be combined with the
``--all`` option.
.. code-block:: none
(keystone_admin)$ collect --all [--timeout | -t] <minutes>
.. note::
For large deployments, the default timeout value (20 minutes) may
need to be increased by using the ``--timeout`` (``-t``) option.
- For subcloud deployments:
.. code-block:: none