fix: docs

doc/source/conf.py

@@ -269,8 +269,8 @@ man_pages = [
 #  dir menu entry, description, category)
 texinfo_documents = [
   (master_doc, 'timmy', u'timmy Documentation',
-   author, 'timmy', 'One line description of project.',
-   'Miscellaneous'),
+   author, 'timmy', 'Small tool for MOS',
+   ''),
 ]
 
 # Documents to append as an appendix to all manuals.

doc/source/configuration.rst

@@ -2,7 +2,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 can be used by the scripts.
 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:
@@ -16,5 +16,16 @@ Here is the description of available parameters in configuration file:
 * **rqdir** the path of *rqdir*, the directory containing info about commands to execute and logs to gather
 * **out-dir** directory to store output data
 * **timeout** timeout for SSH commands in seconds
+* **archives** directory to store the generated archives
+* **log_files** path and filters for log files
+
+Nodes which are stored in fuel database can be filtered by the following parameters:
+ * roles,
+ * online
+ * status the list of statuses ex. ['ready', 'discover']
+ * **node_ids** the list of ids, ex. [0,5,6]
+
+* **hard_filter** hard filter for nodes
+* **soft_filter** soft filters for nodes
 
 Once you are done with the configuration, you might want to familiarize yourself with :doc:`Usage </usage>`.

doc/source/index.rst

@@ -11,6 +11,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   specification
    configuration
    usage
 
@@ -21,5 +22,4 @@ Indices and tables
 ..
   * :ref:`genindex`
   * :ref:`modindex`
-* :ref:`search`
-
+  * :ref:`search`

doc/source/specification.rst

@@ -10,4 +10,7 @@ Specification
 * 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-**
+* some archives are being created - *general.tar.bz2* and *logs-***
+
+Back to :doc:`Index </index>`.
+

doc/source/usage.rst

@@ -2,27 +2,20 @@
 Usage
 =====
 
-The easiest way to launch timmy would be running the ``launch.sh`` script.
+The easiest way to launch timmy would be running the ``timmy.py`` script.
 However, you need to :doc:`configure </configuration>` it first.
 
-Basically, the ``launch.sh`` is a simple wrapper that launches ``cmds.py`` and ``getlogs.py``.
-The first script launches commands on remote hosts and records outputs, and the second one gathers some logs.
+Basically, the ``timmy.py`` is a simple wrapper that launches ``cli.py``.
 
-The ``cmds.py`` script accepts the following parameters:
+The script accepts the following parameters:
 
 * ``--config`` the configuration file location, default is *config.yaml*
-* ``-o``, ``--dest-file`` the location for output archives, default is */tmp*
+* ``-o``, ``--dest-file`` the location for output archives, default is */tmp/archives/general.tar.bz2*
 * ``-e``, ``--extended`` execute commands once by roles
 * ``-c``, ``--cluster`` ability to provide the cluster ID
 * ``-d``, ``--debug`` debugging mode, return more debugging info
 * ``-v``, ``--verbose`` verbose mode
-
-The ``getlogs.py`` script accepts the following parameters:
-
-* ``-a``, ``--dest-file`` the location for output archives, default is */tmp*
-* ``-l``, ``--log-dir`` directory for storing logs, default is *./logs/*
-* ``-c``, ``--cluster`` ability to provide the cluster ID
-* ``-d``, ``--debug`` debugging mode, return more debugging info
-* ``-v``, ``--verbose`` verbose mode
+* ``--only-logs`` collect only logs from nodes (without commands)
+* ``-l``, ``--logs`` collect log files from nodes
 
 Back to :doc:`Index </index>`.

setup.py

@@ -13,7 +13,7 @@ setup(name='timmy',
       author_email = 'dobdin@gmail.com',
       license = 'Apache2',
       url = 'https://github.com/adobdin/timmy',
-      #  long_description=read('README'),
+      long_description=read('README.md'),
       packages = ["timmy"],
       data_files = rqfiles,
       include_package_data = True,

sphinx-build.sh

@@ -18,3 +18,4 @@
 
 sphinx-build -b html doc/source/ doc/build/
 rm -f "./*.pyc"
+rm -f "./timmy/*.pyc"