From 2a5382a97ab857d251eff635e466abfa530466f6 Mon Sep 17 00:00:00 2001
From: Manuel Giffels <giffels@gmail.com>
Date: Wed, 26 Jun 2019 21:08:59 +0200
Subject: [PATCH] Add doucmentation for executors

---
 docs/source/executors/executors.rst | 42 +++++++++++++++++++++++++++++
 docs/source/index.rst               |  1 +
 2 files changed, 43 insertions(+)
 create mode 100644 docs/source/executors/executors.rst

diff --git a/docs/source/executors/executors.rst b/docs/source/executors/executors.rst
new file mode 100644
index 00000000..d634e467
--- /dev/null
+++ b/docs/source/executors/executors.rst
@@ -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
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 92c34cf8..5266d0d9 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -12,6 +12,7 @@ Welcome to the TARDIS documentation!
 
    adapters/batchsystem
    adapters/site
+   executors/executors
    plugins/plugins
    contribute/contribute
    Module Index <api/modules>