Skip to content

Commit

Permalink
Add doucmentation for executors
Browse files Browse the repository at this point in the history
  • Loading branch information
giffels committed Jun 26, 2019
1 parent 8467d8d commit bf43a26
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/source/executors/executors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.. _ref_executors:
=========
Executors
=========

All executors can be loaded using YAML tags using the (`!Tag`) syntax. More details are available in the
`PyYAML documentation`_

.. _PyYAML documentation: https://pyyaml.org/wiki/PyYAMLDocumentation

Shell Executor
--------------

The shell executor is used to execute shell commands asynchronously.

Example configuration
~~~~~~~~~~~~~~~~~~~~~

.. code-block:: yaml
!ShellExecutor
SSH Executor
------------

The ssh executor is used to asynchronously execute shell commands remotely via ssh. All parameters specified in the
configuration are directly passed as keyword arguments to `asyncssh` `connect` call. You can find all available
parameters in the `asyncssh documentation`_

.. _asyncssh documentation: https://asyncssh.readthedocs.io/en/latest/api.html#connect

Example configuration
~~~~~~~~~~~~~~~~~~~~~

.. code-block:: yaml
!SSHExecutor
host: login.dorie.somewherein.de
username: clown
client_keys:
- /opt/tardis/ssh/tardis
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Welcome to the TARDIS documentation!

adapters/batchsystem
adapters/site
executors/executors
plugins/plugins
contribute/contribute
Module Index <api/modules>
Expand Down

0 comments on commit bf43a26

Please sign in to comment.