[jira] [Resolved] (AIRFLOW-2948) Arg checking & better doc for SSHOperator and SFTPOperator

["Fokko Driesprong (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/AIRFLOW-2948?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Fokko Driesprong resolved AIRFLOW-2948.
---------------------------------------
       Resolution: Fixed
    Fix Version/s: 2.0.0

> Arg checking & better doc for SSHOperator and SFTPOperator
> ----------------------------------------------------------
>
>                 Key: AIRFLOW-2948
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2948
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: operators
>            Reporter: Xiaodong DENG
>            Assignee: Xiaodong DENG
>            Priority: Minor
>             Fix For: 2.0.0
>
>
> There may be different combinations of arguments, and some processings are being done 'silently', while users may not be fully aware of them.
>  
>  For example
>  - User only needs to provide either `ssh_hook` or `ssh_conn_id`, while this is not clear in doc
>  - if both provided, `ssh_conn_id` will be ignored.
>  - if `remote_host` is provided, it will replace the `remote_host` which wasndefined in `ssh_hook` or predefined in the connection of `ssh_conn_id`
>  
>  These should be documented clearly to ensure it's transparent to the users.
>  
>  log.info() should also be used to remind users and provide clear logs.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)