================
Process Manager
================

Pysiphae also includes a process manager daemon for execution of processes in
command line. The process manager daemon was developed to manage the execution
of command line scripts (Sqoop, Spark, HiveQL) on Hadoop client node.

A process manager UI is included in Pysiphae dashboard for executing the jobs

.. warning::

   The process management server does not have authentication. ONLY run it in a
   secure environment.


Starting Process Manager Server
================================

.. code-block:: bash

   ./bin/pysiphae_processmgr

By default the Process Manager server will run on http://localhost:8888. 

Enabling Process Manager View
=============================

Process Manager module depends on Authentication to be configured in your
Pysiphae installation. Refer to Authentication section for steps to enable
authentication.

Additionally, you will need to also grant ``pysiphae.processmgr.View`` ACL to
your users. Add this into ``development.ini``

.. code-block:: ini
   
   pysiphae.acl =
         Allow,group:LoggedIn,pysiphae.processmgr.View

   
Registering Process Payload
============================

.. code-block:: python

   from pysiphae.processmgr.payload import factory

   p1 = factory(
       name='uname payload',
       description='Get uname of the process management server',
       executor='shell',
       files=None,
       options=None
   )

Parameters:

* ``name`` - name of payload

* ``description`` - short description of payload

* ``executor`` - executor to use from the server side

* ``files`` - asset spefication pointing to files to upload to server

* ``options`` - additional options to pass to executor

* ``environ`` - dictionary containing environment variables to pass to 
  executor

* ``permission`` - permission to use this executor, default no permission
  required