Skip to content

Commit

Permalink
[AIRFLOW-XXX] Add doc on specifying SSH Key in SSH connection (apache…
Browse files Browse the repository at this point in the history
  • Loading branch information
kaxil authored and Jing Guo committed Sep 2, 2019
1 parent 06a2177 commit b8b3bf0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/howto/connection/ssh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Extra (optional)
connection. The following parameters out of the standard python parameters
are supported:

* **key_file** - Full Path of the private SSH Key file that will be used to connect to the remote_host.
* **timeout** - An optional timeout (in seconds) for the TCP connect. Default is ``10``.
* **compress** - ``true`` to ask the remote client/server to compress traffic; `false` to refuse compression. Default is ``true``.
* **no_host_key_check** - Set to ``false`` to restrict connecting to hosts with no entries in ``~/.ssh/known_hosts`` (Hosts file). This provides maximum protection against trojan horse attacks, but can be troublesome when the ``/etc/ssh/ssh_known_hosts`` file is poorly maintained or connections to new hosts are frequently made. This option forces the user to manually add all new hosts. Default is ``true``, ssh will automatically add new host keys to the user known hosts files.
Expand All @@ -50,6 +51,7 @@ Extra (optional)
.. code-block:: json
{
"key_file": "/home/airflow/.ssh/id_rsa",
"timeout": "10",
"compress": "false",
"no_host_key_check": "false",
Expand All @@ -64,4 +66,4 @@ Extra (optional)

.. code-block:: bash
ssh://user:pass@localhost:22?timeout=10&compress=false&no_host_key_check=false&allow_host_key_change=true
ssh://user:pass@localhost:22?timeout=10&compress=false&no_host_key_check=false&allow_host_key_change=true&key_file=%2Fhome%2Fairflow%2F.ssh%2Fid_rsa

0 comments on commit b8b3bf0

Please sign in to comment.