sloth-ci.ext.ssh_exec 1.1.0

SSH executor for Sloth CI

Run actions on remote machines over SSH.

By default, Sloth CI apps run actions in a subprocess on the same machine they're running on. This extension overrides this and makes the app execute actions on remote machines over SSH.

You can authenticate with login and password or by providing key files.


Installation
------------

.. code-block:: bash

$ pip install sloth-ci.ext.ssh_exec


Usage
-----

.. code-block:: yaml
:caption: ssh_exec.yml

extensions:
run_over_ssh:
# Use the sloth_ci.ext.ssh_exec module.
module: ssh_exec

# Hosts, comma-delimited. Optional port number can be provided after ':' (if not specified, 22 is used).
hosts:
- ssh.example.com
- myserver.com:23

# Username to use for authentication.
username: admin

# Password to use for authentication or to unlock a private key.
# password: foobar

# Additional private key files. If not specified, only the keys from the default location are loaded (i.e. ~/.ssh).
# keys:
# - ~/my_ssh_keys/key_rsa
# - somekey