diff --git a/.gitignore b/.gitignore index bc65c083738dd578e7baf75c05c61454d7dc9475..ee6b97f319a7fb6a31e97191c21ef223d1161149 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,6 @@ parsetab.py # Ignore submodule documentation. /doc/sphinx/_doclib/api_pyzenkit*.rst /doc/sphinx/_doclib/api_pynspect*.rst +/doc/sphinx/_doclib/_inc_bin.cfg-app.rst +/doc/sphinx/_doclib/_inc_bin.cfg-daemon.rst +/doc/sphinx/_doclib/_inc_bin.cfg-script.rst diff --git a/doc/sphinx/_doclib/_inc.bin.app-opt.rst b/doc/sphinx/_doclib/_inc.bin.app-opt.rst deleted file mode 100644 index da4228a13bc9a5c481383c8f6f77ea3c4849ba5a..0000000000000000000000000000000000000000 --- a/doc/sphinx/_doclib/_inc.bin.app-opt.rst +++ /dev/null @@ -1,75 +0,0 @@ -``--help`` - Display help and usage description and exit (*flag*) - -``--name alternative-name`` - Alternative name for application instead of default ``$0``, using which names - for log, runlog, pid, status and other files will be generated. - - *Type:* ``string``, *default:* ``$0`` - -``--quiet`` - Run in quiet mode (*flag*). - - Do not write anything to ``stdout`` or ``stderr``. - - *Type:* ``boolean``, *default:* ``False`` - -``--verbose`` - Increase application output verbosity (*flag*, *repeatable*). - - *Type:* ``boolean``, *default:* ``False`` - -``--log-file file-name`` - Name of the log file. - - *Type:* ``string``, *default:* autodetected - -``--log-level level`` - Logging level [``debug``, ``info``, ``warning``, ``error``, ``critical``]. - - *Type:* ``string``, *default:* ``info`` - -``--runlog-dir dir-name`` - Name of the runlog directory. - - *Type:* ``string``, *default:* autodetected - -``--runlog-dump`` - Dump runlog to stdout when done processing (*flag*). - - *Type:* ``boolean``, *default:* ``False`` - -``--runlog_log`` - Write runlog to logging service when done processing (*flag*) - - *Type:* ``boolean``, *default:* ``False`` - -``--pstate_file file-name`` - Name of the persistent state file. - - *Type:* ``string``, *default:* autodetected - -``--pstate_dump`` - Dump persistent state to stdout when done processing (*flag*). - - *Type:* ``boolean``, *default:* ``False`` - -``--pstate_log`` - Write persistent state to logging service when done processing (*flag*). - - *Type:* ``boolean``, *default:* ``False`` - -``--action action`` - Execute given quick action and exit. List of available actions can be displayed with ``--help`` option. - - *Type:* ``string``, *default:* ``None`` - -``--user name-or-id`` - Name/gid of the system user for process permissions. - - *Type:* ``string``, *default:* ``None`` - -``--group name-or-id`` - Name/gid of the system group for process permissions. - - *Type:* ``string``, *default:* ``None`` diff --git a/doc/sphinx/_doclib/_inc.bin.daemon-opt.rst b/doc/sphinx/_doclib/_inc.bin.daemon-opt.rst deleted file mode 100644 index cad8aa9230cd3aaf8ab74c6c9c0e51c517e034c0..0000000000000000000000000000000000000000 --- a/doc/sphinx/_doclib/_inc.bin.daemon-opt.rst +++ /dev/null @@ -1,39 +0,0 @@ -``--no-daemon`` - Do not daemonize and stay in foreground (*flag*). - - *Type:* ``boolean``, *default:* ``False`` - -``--chroot-dir dir-name`` - Name of the chroot directory. - - *Type:* ``string``, *default:* ``None`` - -``--work_dir dir-name`` - Name of the process work directory. - - *Type:* ``string``, *default:* ``/`` - -``--pid_file file-name`` - Name of the pid file. - - *Type:* ``string``, *default:* autodetected - -``--state_file file-name`` - Name of the state file. - - *Type:* ``string``, *default:* autodetected - -``--umask mask`` - Default file umask. - - *Type:* ``string``, *default:* ``0o002`` - -``--stats_interval interval`` - Processing statistics display interval in seconds. - - *Type:* ``integer``, *default:* ``300`` - -``--paralel`` - Run in paralel mode (*flag*). - - *Type:* ``boolean``, *default:* ``False`` diff --git a/doc/sphinx/_doclib/_inc.bin.script-opt.rst b/doc/sphinx/_doclib/_inc.bin.script-opt.rst deleted file mode 100644 index 257384f3d2ac8795b3093ab06e4329d4a7f48df0..0000000000000000000000000000000000000000 --- a/doc/sphinx/_doclib/_inc.bin.script-opt.rst +++ /dev/null @@ -1,29 +0,0 @@ -``--regular`` - Operational mode: regular script execution (*flag*). Conflicts with ``--shell`` option. - - *Type:* ``boolean``, *default:* ``False`` - -``--shell`` - Operational mode: manual script execution from shell (*flag*). Conflicts with ``--regular`` option. - - *Type:* ``boolean``, *default:* ``False`` - -``--command name`` - Name of the script command to be executed. - - *Type:* ``string``, *default:* autodetected - -``--interval interval`` - Execution interval. This value should correspond with related cron script. - - *Type:* ``string``, *default:* ``daily`` - -``--adjust_thresholds`` - Round-up time interval threshols to interval size (*flag*). - - *Type:* ``boolean``, *default:* ``False`` - -``--time_high time`` - Upper time interval threshold. - - *Type:* ``float``, *default:* time.time diff --git a/doc/sphinx/_doclib/_inc_bin.help.daemon.rst b/doc/sphinx/_doclib/_inc_bin.help.daemon.rst index 663633219ea997c4ea1d0cf9b946b40e1c8c998f..b655ebc81c8774fdda8adc9de35a39f431886ab0 100644 --- a/doc/sphinx/_doclib/_inc_bin.help.daemon.rst +++ b/doc/sphinx/_doclib/_inc_bin.help.daemon.rst @@ -28,15 +28,23 @@ Common application options Following configuration options are available for all applications based on :py:mod:`pyzenkit.baseapp`: -.. include:: _inc.bin.app-opt.rst +.. include:: _inc_bin.cfg-app.rst Common daemon options ```````````````````````````````````````````````````````````````````````````````` -Following configuration options are available on top of common applicationsoptions -for all applications based on :py:mod:`pyzenkit.zenscript`: +Following configuration options are available on top of common application options +for all applications based on :py:mod:`pyzenkit.zendaemon`: -.. include:: _inc.bin.daemon-opt.rst +.. include:: _inc_bin.cfg-daemon.rst + +Common piper daemon options +```````````````````````````````````````````````````````````````````````````````` + +Following configuration options are available on top of common daemon options +for all applications based on :py:mod:`mentat.daemon.piper`: + +.. include:: _inc_bin.cfg-piper.rst Configuration files and directories diff --git a/doc/sphinx/_doclib/_inc_bin.help.script.rst b/doc/sphinx/_doclib/_inc_bin.help.script.rst index aed5df587bf1d64106abd7284756a1191305e437..f44265581013d5547858361ede5d87e29b2d3597 100644 --- a/doc/sphinx/_doclib/_inc_bin.help.script.rst +++ b/doc/sphinx/_doclib/_inc_bin.help.script.rst @@ -28,7 +28,7 @@ Common application options Following configuration options are available for all applications based on :py:mod:`pyzenkit.baseapp`: -.. include:: _inc.bin.app-opt.rst +.. include:: _inc_bin.cfg-app.rst Common script options ```````````````````````````````````````````````````````````````````````````````` @@ -36,7 +36,7 @@ Common script options Following configuration options are available on top of common applicationsoptions for all applications based on :py:mod:`pyzenkit.zenscript`: -.. include:: _inc.bin.script-opt.rst +.. include:: _inc_bin.cfg-script.rst Configuration files and directories diff --git a/doc/sphinx/_doclib/api.rst b/doc/sphinx/_doclib/api.rst index b5423c3c98fa2946640e02aae105b0b44dad0017..63c992f81e54c52f5d7b0dcf3f0319d6996165df 100644 --- a/doc/sphinx/_doclib/api.rst +++ b/doc/sphinx/_doclib/api.rst @@ -28,16 +28,36 @@ Python submodules api_mentat.datatype.internal api_mentat.datatype.mongodb + api_mentat.const + api_mentat.dirq + api_mentat.geoip + api_mentat.storage + api_mentat.whois + api_mentat.stats.idea api_mentat.stats.rrd + api_mentat.plugin.app.storage + api_mentat.plugin.enricher.geoip + api_mentat.plugin.enricher.logger api_mentat.plugin.enricher.whois - api_mentat.daemon.component.inspector + api_mentat.daemon.component.commiter api_mentat.daemon.component.enricher + api_mentat.daemon.component.filer + api_mentat.daemon.component.filter + api_mentat.daemon.component.inspector + api_mentat.daemon.component.mailer + api_mentat.daemon.component.parser + api_mentat.daemon.component.printer + api_mentat.daemon.component.sampler api_mentat.daemon.component.storage + api_mentat.script.fetcher + + api_mentat.daemon.piper + api_mentat.module.backup api_mentat.module.cleanup api_mentat.module.controller diff --git a/doc/sphinx/_doclib/api_mentat.daemon.piper.rst b/doc/sphinx/_doclib/api_mentat.daemon.piper.rst index b95147ebb2c12ed5ef1a2d78a2eebed173e41740..4ae98616ae5b8e9275c378d0a7a012c5ab6ab111 100644 --- a/doc/sphinx/_doclib/api_mentat.daemon.piper.rst +++ b/doc/sphinx/_doclib/api_mentat.daemon.piper.rst @@ -1,3 +1,5 @@ +.. _section-api-mentat-daemon-piper: + mentat.daemon.piper ================================================================================