search

apache / airflow

Apache Airflow - A platform to programmatically author, schedule, and monitor workflows
https://airflow.apache.org/
Apache License 2.0
35.26k stars 13.78k forks source link

smtp connection doc should mention non-credentials field will not be used for notification #40226

Open chulkilee opened 2 weeks ago

chulkilee commented 2 weeks ago

What do you see as an issue?

Email Configuration mentions

To configure SMTP settings, checkout the SMTP section in the standard configuration. If you do not want to store the SMTP credentials in the config or in the environment variables, you can create a connection called smtp_default of Email type, or choose a custom connection name and set the email_conn_id with its name in the configuration & store SMTP username-password in it. Other SMTP settings like host, port etc always gets picked up from the configuration only. The connection can be of any type (for example ‘HTTP connection’).

However, SMTP Connection does not mention that such limitation.

As a result, even SMTP connection test passes, the connection cannot be used in DAG failture notification. This is quite counter-intuitive, confusing, and misleading for users expecting STMP connection holds all information for all cases.

See https://github.com/apache/airflow/issues/37442 for example.

Solving the problem

Either Airflow notification picks up all other attributes (other than credentials), or SMTP connection doc and UI should mention the limitation.

Anything else

No response

Are you willing to submit PR?

Code of Conduct

boring-cyborg[bot] commented 2 weeks ago

Thanks for opening your first issue here! Be sure to follow the issue template! If you are willing to raise PR to address this issue please do so, no need to wait for approval.