You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "Xiaodong DENG (JIRA)" <ji...@apache.org> on 2018/08/23 14:58:00 UTC

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

Xiaodong DENG created AIRFLOW-2948:
--------------------------------------

             Summary: 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


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)