Jelajahi Sumber

add job management

bradford.condon 6 tahun lalu
induk
melakukan
f27cd2dfac
1 mengubah file dengan 37 tambahan dan 1 penghapusan
  1. 37 1
      docs/user_guide/job_management.rst

+ 37 - 1
docs/user_guide/job_management.rst

@@ -1,4 +1,40 @@
 Job Management
 ===============
 
-Lorem ipsum
+This module is meant to provide a simple means of creating a robust command-line-driven, fully bootstrapped PHP Daemon. It uses the PHP-Daemon (https://github.com/shaneharter/PHP-Daemon) Library to create the Daemon (via the Libraries API) in order to not re-invent the wheel ;-).
+
+Features
+~~~~~~~~~
+
+* Provides a Drush interface to start/stop your Daemon.
+* Your daemon starts in the background and is detached from the current terminal.
+* Daemon will run all Tripal Jobs submitted within 20 seconds.
+* A log including the number of jobs executed, their identifiers and results.
+* Lock Files, Automatic restart (8hrs default) and Built-in Signal Handling & Event Logging are only a few of the features provided by the Daemon API making this a fully featured & robust Daemon.
+
+
+Requirements
+~~~~~~~~~~~~~
+
+* Libraries API (https://www.drupal.org/project/libraries)
+* PHP-Daemon Library version 2.0 (https://github.com/shaneharter/PHP-Daemon)
+    * Download the PHP-Daemon Library and extract it in your ``sites/all/libraries`` directory. The folder must be named "PHP-Daemon".
+* Drush 5.x (https://github.com/drush-ops/drush)
+* Drush Daemon API (https://www.drupal.org/project/drushd)
+
+Tripal Daemon Usage
+~~~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: shell
+
+  #Start Daemon drush
+  trpjob-daemon start
+  #Stop Daemon
+  drush trpjob-daemon stop
+  #Check the Status
+  drush trpjob-daemon status
+  #Show the Log
+  #List the last 10 lines of the log file:
+  drush trpjob-daemon show-log
+  #List the last N lines of the log file:
+  drush trpjob-daemon show-log --num_lines=N