Skip to content
Snippets Groups Projects
Commit bcebd8fb authored by Jan Mach's avatar Jan Mach
Browse files

Updated PyZenKit to latest version 0.54.

This version comes with improved application command line parameter documentation, some changes were necessary to make everything work again. (Redmine issue: #3387,#3361)
parent 173840bd
No related branches found
No related tags found
No related merge requests found
......@@ -424,6 +424,8 @@ clean-build-debian: FORCE
docs-sync: FORCE
@echo "\n$(GREEN)*** Synchronizing documentation source code from submodules ***$(NC)\n"
@cd ./submodules/pynspect/ && make docs
@cd ./submodules/pyzenkit/ && make docs
@rsync -r --progress --archive --update --delete --force ./submodules/pynspect/doc/_doclib/api_*.rst ./doc/sphinx/_doclib/apidoc/
@rsync -r --progress --archive --update --delete --force ./submodules/pyzenkit/doc/_doclib/apidoc/pyzenkit.*.rst ./doc/sphinx/_doclib/apidoc/
@rsync -r --progress --archive --update --delete --force ./submodules/pyzenkit/doc/_doclib/_inc*.rst ./doc/sphinx/_doclib/
......
......@@ -22,7 +22,7 @@ flask-jsglue==0.3.1
geoip2==2.9.0
rrdtool==0.1.14
pydgets==0.9
pyzenkit==0.52
pyzenkit==0.54
pynspect==0.16
ipranges==0.1.10
typedcols==0.1.13
......
``--help``
Display help and usage description and exit (*flag*).
``--debug``
Run in debug mode (*flag*).
Input various status information to ``stderr``.
*Type:* ``boolean``, *default:* ``False``
``--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``
``--name alternative-name``
Alternative name for application instead of default ``$0``.
This value will be used to generate names for log, runlog, pid, status and
other application files.
*Type:* ``string``, *default:* ``$0``
``--config-file file-name``
Name of the configuration file.
*Type:* ``string``, *default:* autodetected
``--config-file-silent``
Do not complain in case given configuration file does not exist (*flag*).
*Type:* ``boolean``, *default:* ``False``
``--config-dir file-name``
Name of the configuration directory.
*Type:* ``string``, *default:* autodetected
``--config-file-silent``
Do not complain in case given configuration directory does not exist (*flag*).
*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``
``--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``
``--runlog-interval interval``
Application runlog dump interval in seconds.
*Type:* ``integer``, *default:* ``300``
``--paralel``
Run in paralel mode (*flag*).
*Type:* ``boolean``, *default:* ``False``
``--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
......@@ -28,7 +28,7 @@ Common application options
Following configuration options are available for all applications based on
:py:mod:`pyzenkit.baseapp`:
.. include:: _inc_bin.cfg-app.rst
.. include:: _inc_bin.cfg_cli_app.rst
Common daemon options
````````````````````````````````````````````````````````````````````````````````
......@@ -36,7 +36,7 @@ Common daemon options
Following configuration options are available on top of common application options
for all applications based on :py:mod:`pyzenkit.zendaemon`:
.. include:: _inc_bin.cfg-daemon.rst
.. include:: _inc_bin.cfg_cli_daemon.rst
Common piper daemon options
````````````````````````````````````````````````````````````````````````````````
......@@ -44,7 +44,7 @@ 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
.. include:: _inc_bin.cfg_cli_piper.rst
Configuration files and directories
......
......@@ -28,7 +28,7 @@ Common application options
Following configuration options are available for all applications based on
:py:mod:`pyzenkit.baseapp`:
.. include:: _inc_bin.cfg-app.rst
.. include:: _inc_bin.cfg_cli_app.rst
Common script options
````````````````````````````````````````````````````````````````````````````````
......@@ -36,7 +36,7 @@ Common script options
Following configuration options are available on top of common application options
for all applications based on :py:mod:`pyzenkit.zenscript`:
.. include:: _inc_bin.cfg-script.rst
.. include:: _inc_bin.cfg_cli_script.rst
Common fetcher script options
````````````````````````````````````````````````````````````````````````````````
......@@ -44,7 +44,7 @@ Common fetcher script options
Following configuration options are available on top of common script options
for all applications based on :py:mod:`mentat.script.fetcher`:
.. include:: _inc_bin.cfg-fetcher.rst
.. include:: _inc_bin.cfg_cli_fetcher.rst
Configuration files and directories
......
......@@ -28,7 +28,7 @@ Common application options
Following configuration options are available for all applications based on
:py:mod:`pyzenkit.baseapp`:
.. include:: _inc_bin.cfg-app.rst
.. include:: _inc_bin.cfg_cli_app.rst
Common script options
````````````````````````````````````````````````````````````````````````````````
......@@ -36,14 +36,14 @@ 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.cfg-script.rst
.. include:: _inc_bin.cfg_cli_script.rst
Configuration files and directories
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Configuration can be passed down to application using a combination of configuration
file or configuration directory. The configuration file
file or configuration directory.
The available configuration keys are very similar to command line options and the
names differ only in the use of ``_`` character instead of ``-``. However there is
......
......@@ -69,5 +69,5 @@ Following is a list of all currently available user interfaces.
.. toctree::
:maxdepth: 1
bin_mentat-hawat
bin_hawat-cli
hawat
.. _section-bin-hawat-cli:
hawat-cli
================================================================================
Subproject commit de6d0fff7e6fd5b7b8785ca2c77c5a35ded8fd74
Subproject commit 0822cbca7e37426fe90e37107f91a5e59696d822
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment