x/timmy
Code Issues Proposed changes

added: some docs

Browse Source
This commit is contained in:
adobdin 2016-04-14 13:27:56 +00:00
parent f572fc2e2c
commit 8ac2a8ad23
3 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md Symbolic link
View File

@ -0,0 +1 @@
doc/source/specification.rst

6
doc/source/configuration.rst
View File

@ -3,7 +3,7 @@ Configuration
============= =============
There is default configuration file ``config.yaml``, which is used by the scripts by default. There is default configuration file ``config.yaml``, which is used by the scripts by default.
If you wish to keep several configuration files, that is possible - just copy it and explicitly provide the name of it once you launch a script (``--config`` option) (not yet implemented in ``getlogs.py``). If you wish to keep several configuration files, that is possible - just copy it and explicitly provide the name of it once you launch a script (``--config`` option).
Here is the description of available parameters in configuration file: Here is the description of available parameters in configuration file:
@ -14,11 +14,7 @@ Here is the description of available parameters in configuration file:
* **fuelip** the IP address of the master node in the environment * **fuelip** the IP address of the master node in the environment
* **rqdir** the path of *rqdir*, the directory containing info about commands to execute and logs to gather * **rqdir** the path of *rqdir*, the directory containing info about commands to execute and logs to gather
* **logdir** the path of directory for storing logs
* **out-dir** directory to store output data * **out-dir** directory to store output data
* **timeout** timeout for SSH commands in seconds * **timeout** timeout for SSH commands in seconds
* **find** parameters of *find*
* **template** template of parameters to pass to *find* when searching for logs
Once you are done with the configuration, you might want to familiarize yourself with :doc:`Usage </usage>`. Once you are done with the configuration, you might want to familiarize yourself with :doc:`Usage </usage>`.

13
doc/source/specification.rst Normal file
View File

@ -0,0 +1,13 @@
=======
Specification
=======
* This tool is based on https://etherpad.openstack.org/p/openstack-diagnostics
* Should work fine on the following environments that were tested: 4.x, 5.x, 6.x, 7.0, 8.0
* Operates non-destructively. Completely safe.
* Can be launched not only on the master node, if the master node's IP is specified.
* Parallel launch, only on the nodes that are 'online'.
* Commands (from ./cmds directory) are separated by roles (detected automatically) by the symlinks. So the command list may depend on release, roles and OS, there also can be commands that run everywhere. Also there are commands that are executed *only on one node* by its *role*, first encountered.
* Human-readable format output of 'fuel node list'
* Modular: possible to create a special package that contains only some required commands.
* some archives are being created - *general* and *logs-**