Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[AIRFLOW-XXX] Add doc on specifying SSH Key in SSH connection #5872

Merged
merged 2 commits into from
Aug 20, 2019
Merged

[AIRFLOW-XXX] Add doc on specifying SSH Key in SSH connection #5872

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46259b1
[AIRFLOW-XXX] Add doc on specifying SSH Key in SSH connection
kaxil Aug 20, 2019
42fc845
Update ssh.rst
kaxil Aug 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/howto/connection/ssh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,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 @@ -48,6 +49,7 @@ Extra (optional)
.. code-block:: json

{
"key_file": "/home/airflow/.ssh/id_rsa",
"timeout": "10",
"compress": "false",
"no_host_key_check": "false",
Expand All @@ -62,4 +64,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