apache-airflow-providers-ssh

Changelog¶

4.0.0¶

Note

This release of provider is only available for Airflow 2.9+ as explained in the Apache Airflow providers support policy.

Breaking changes¶

Warning

All deprecated classes, parameters and features have been removed from the SSH provider package. The following breaking changes were introduced:

Hooks
- Remove attribute timeout from airflow.providers.ssh.hooks.ssh.SSHHook. Use parameter conn_timeout instead.
- The context manager of SSHHook is deprecated. Please use get_conn() as a context manager instead.
- SSHHook.create_tunnel() is deprecated, Please use get_tunnel() instead. But please note that the order of the parameters have changed.
operators
- The deprecated get_hook() method is removed in airflow.providers.ssh.operators.ssh.SSHOperator. Please use hook attribute instead.
- Deprecated exec_ssh_client_command() method on SSHOperator is removed, call ssh_hook.exec_ssh_client_command() instead

Remove Provider Deprecations in SSH (#44544)

Features¶

Add host_proxy_cmd parameter to SSHHook and SFTPHook (#44565)

Misc¶

Bump minimum Airflow version in providers to Airflow 2.9.0 (#44956)
Remove XCom pickling (#43905)

3.14.0¶

Features¶

SSHHook expose auth_timeout parameter (#43048)

3.13.1¶

Bug Fixes¶

SSHHook: check if existing connection is still alive (#41061)

3.13.0¶

Note

This release of provider is only available for Airflow 2.8+ as explained in the Apache Airflow providers support policy.

Misc¶

Bump minimum Airflow version in providers to Airflow 2.8.0 (#41396)

3.12.0¶

Features¶

Add on kill to ssh (#40377)

3.11.2¶

Misc¶

implement per-provider tests with lowest-direct dependency resolution (#39946)

3.11.1¶

Misc¶

Faster 'airflow_version' imports (#39552)
Simplify 'airflow_version' imports (#39497)

3.11.0¶

Note

This release of provider is only available for Airflow 2.7+ as explained in the Apache Airflow providers support policy.

Misc¶

Bump minimum Airflow version in providers to Airflow 2.7.0 (#39240)

3.10.1¶

Misc¶

feat: Switch all class, functions, methods deprecations to decorators (#36876)

3.10.0¶

Features¶

Add skip_on_exit_code to SSHOperator (#36303)

Bug Fixes¶

Allow SSHOperator.skip_on_exit_code to be zero (#36358)
Follow BaseHook connection fields method signature in child classes (#36086)

Misc¶

Review and mark found potential SSH security issues by bandit (#36162)

3.9.0¶

Note

This release of provider is only available for Airflow 2.6+ as explained in the Apache Airflow providers support policy.

Misc¶

Bump minimum Airflow version in providers to Airflow 2.6.0 (#36017)

3.8.1¶

Misc¶

Consolidate stacklevel in ssh operator warning (#35151)

3.8.0¶

Note

This release of provider is only available for Airflow 2.5+ as explained in the Apache Airflow providers support policy.

Misc¶

Bump min airflow version of providers (#34728)
add warn stacklevel=2 to ssh hook (#34527)

3.7.3¶

Misc¶

Use literal dict instead of calling dict() in providers (#33761)
E731: replace lambda by a def method in Airflow providers (#33757)

3.7.2¶

Misc¶

Use str.splitlines() to split lines in providers (#33593)
Simplify conditions on len() in other providers (#33569)

3.7.1¶

Note

This release dropped support for Python 3.7

Misc¶

Remove Python 3.7 support (#30963)

3.7.0¶

Note

This release of provider is only available for Airflow 2.4+ as explained in the Apache Airflow providers support policy.

Misc¶

Bump minimum Airflow version in providers (#30917)

3.6.0¶

Features¶

SSHOperator - Restore ability to override SSHHook cmd_timeout (#30190)

3.5.0¶

Features¶

SSH Provider: Add cmd_timeout to ssh connection extra (#29347)

3.4.0¶

Features¶

Add .bash and other extensions to SSHOperator template_ext (#28617)
Add test_connection method for SSHHook (#28184)
SSH task exit code added to XCOM as 'ssh_exit' key (#27370)

Misc¶

Remove outdated compat imports/code from providers (#28507)
[misc] Get rid of 'pass' statement in conditions (#27775)

3.3.0¶

Note

This release of provider is only available for Airflow 2.3+ as explained in the Apache Airflow providers support policy.

Misc¶

Move min airflow version to 2.3.0 for all providers (#27196)

Features¶

Added docs regarding templated field (#27301)
Added environment to templated SSHOperator fields (#26824)
Apply log formatter on every output line in SSHOperator (#27442)

Bug Fixes¶

A few docs fixups (#26788)
SSHOperator ignores cmd_timeout (#27182) (#27184)

3.2.0¶

Features¶

feat: load host keys to save new host key (#25979)

3.1.0¶

Features¶

Less verbose logging in ssh operator (#24915)
Convert sftp hook to use paramiko instead of pysftp (#24512)

Bug Fixes¶

Update providers to use functools compat for ''cached_property'' (#24582)

3.0.0¶

Breaking changes¶

Note

This release of provider is only available for Airflow 2.2+ as explained in the Apache Airflow providers support policy.

Features¶

Add disabled_algorithms as an extra parameter for SSH connections (#24090)

Bug Fixes¶

fixing SSHHook bug when using allow_host_key_change param (#24116)

2.4.4¶

Bug Fixes¶

Add exception to catch single line private keys (#23043)

2.4.3¶

Bug Fixes¶

Fix mistakenly added install_requires for all providers (#22382)

2.4.2¶

Misc¶

Add Trove classifiers in PyPI (Framework :: Apache Airflow :: Provider)

2.4.1¶

Misc¶

Support for Python 3.10

2.4.0¶

Features¶

Add a retry with wait interval for SSH operator (#14489)
Add banner_timeout feature to SSH Hook/Operator (#21262)
Add a retry with wait interval for SSH operator #14489 (#19981)
Delay the creation of ssh proxy until get_conn() (#20474) (#20474)

2.3.0¶

Features¶

Refactor SSHOperator so a subclass can run many commands (#10874) (#17378)
update minimum version of sshtunnel to 0.3.2 (#18684)
Correctly handle get_pty attribute if command passed as XComArg or template (#19323)

2.2.0¶

Features¶

[Airflow 16364] Add conn_timeout and cmd_timeout params to SSHOperator; add conn_timeout param to SSHHook (#17236)

2.1.1¶

Misc¶

Optimise connection importing for Airflow 2.2.0

2.1.0¶

Features¶

Add support for non-RSA type key for SFTP hook (#16314)

Bug Fixes¶

SSHHook: Using correct hostname for host_key when using non-default ssh port (#15964)
Correctly load openssh-gerenated private keys in SSHHook (#16756)

2.0.0¶

Breaking changes¶

Auto-apply apply_default decorator (#15667)

Warning

Due to apply_default decorator removal, this version of the provider requires Airflow 2.1.0+. If your Airflow version is < 2.1.0, and you want to install this provider version, first upgrade Airflow to at least version 2.1.0. Otherwise your Airflow package version will be upgraded automatically and you will have to manually run airflow upgrade db to complete the migration.

Bug Fixes¶

Display explicit error in case UID has no actual username (#15212)

1.3.0¶

Features¶

A bunch of template_fields_renderers additions (#15130)

1.2.0¶

Features¶

Added support for DSS, ECDSA, and Ed25519 private keys in SSHHook (#12467)

1.1.0¶

Updated documentation and readme files.

Features¶

[AIRFLOW-7044] Host key can be specified via SSH connection extras. (#12944)

1.0.0¶

Initial version of the provider.