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.

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

Add missing connection types and documentation for community providers #28790

Open
25 of 49 tasks
Taragolis opened this issue Jan 8, 2023 · 2 comments
Open
25 of 49 tasks
Labels
area:providers good first issue kind:meta High-level information important to the community kind:task A task that needs to be completed as part of a larger issue

Comments

@Taragolis
Copy link
Contributor

Taragolis commented Jan 8, 2023

Body

Some of Hooks provide connection ability, however quite a few of them do not provide any documentation and/or connection type (missing in the UI). It would be nice if we add missing parts which might help Airflow users.

Hooks Class Attributes reference:

  • conn_type: Unique connection type, should be also listed in providers.yaml
  • conn_name_attr: Name of connection attribute, mainly uses for test connections
  • default_conn_name : Name of default connection, it doesn't do anything if you do not set it directly to conn_name_attr, see as reference SlackHook
  • hook_name, connection name in dropdown list in the UI

List of Providers and missing/inconsistent hooks class attributes or/and documentation:

Note

If someone would like to work on one (or many) just let us know in comments or create PR with reference to this Issue.

alibaba
Mixin connections documentation in the single page

  • AnalyticDBSparkHook (conn_type = "adb_spark", conn_name_attr = "alibabacloud_conn_id" this one Inconsistent with actual hook attribute "oss_conn_id", hook_name = "AnalyticDB Spark")
  • OSSHook (conn_type = "oss", conn_name_attr = "alibabacloud_conn_id" this one Inconsistent with actual hook attribute "oss_conn_id", hook_name = "OSS")

apache.druid

apache.hdfs
Mixin connections documentation in the single page

apache.kylin

apache.livy

apache.pig

  • PigCliHook (conn_type = "pig_cli", conn_name_attr = "pig_cli_conn_id", hook_name = "Pig Client Wrapper")

apache.pinot

apache.spark
Mixin connections documentation in the single page.

apache.sqoop

datadog

dingding

  • DingdingHook (conn_type = "dingding", conn_name_attr = "dingding_conn_id", hook_name = "Dingding")

discord
Discord built in top of HTTP Connection with specific settings, which only described in docstring

exasol

  • ExasolHook (conn_type = "exasol", conn_name_attr = "exasol_conn_id", hook_name = "Exasol")

facebook

google

hashicorp

cloudant

  • CloudantHook (conn_type = "cloudant", conn_name_attr = "cloudant_conn_id", hook_name = "Cloudant")

atlassian.jira

microsoft.azure

  • AzureContainerInstanceHook (conn_type = "azure_container_instance", conn_name_attr = "azure_conn_id", hook_name = "Azure Container Instance")

microsoft.psrp

microsoft.winrm
I'm not familiar with WinRM Protocol, but seems like it actually doesn't use SSH Connection, however connection attribute is ssh_conn_id which might confuse end users.

  • WinRMHook (Missing conn_type, conn_name_attr = "ssh_conn_id")

openfaas

  • OpenFaasHook (Missing conn_type, conn_name_attr = "conn_id")

opsgenie

pagerduty

  • PagerdutyHook (conn_type = "pagerduty", conn_name_attr = "pagerduty_conn_id", hook_name = "Pagerduty")
  • PagerdutyEventsHook (conn_type = "pagerduty_events", conn_name_attr = "pagerduty_events_conn_id", hook_name = "Pagerduty Events")

presto

qubole

  • [ ] QuboleHook (conn_type = "qubole", conn_name_attr = "qubole_conn_id", hook_name = "Qubole") suspended provider

redis

samba

segment

  • SegmentHook (conn_type = "segment", conn_name_attr = "segment_conn_id", hook_name = "Segment")

telegram

vertica

  • VerticaHook (conn_type = "vertica", conn_name_attr = "vertica_conn_id", hook_name = "Vertica")

zendesk

Committer

  • I acknowledge that I am a maintainer/committer of the Apache Airflow project.
@hussein-awala
Copy link
Member

@Taragolis I just created #30057 to fix Vault connection and add missing doc, can you check it?

@shohamy7
Copy link
Contributor

Hi @Taragolis
Looks like WebHDFSHook has been resolved in #36145

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:providers good first issue kind:meta High-level information important to the community kind:task A task that needs to be completed as part of a larger issue
Projects
None yet
Development

No branches or pull requests

3 participants