-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters