yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-11-11 00:42:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(airflow): update plugin setup docs to include UI setup approach (#9253)

Browse Source
This commit is contained in:
Jia (Jason) Teoh 2023-11-16 16:05:56 -08:00 committed by GitHub
parent b778def10a
commit c348f841c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/lineage/airflow.md
View File

@ -37,12 +37,24 @@ pip install 'acryl-datahub-airflow-plugin[plugin-v2]'
### Configuration ### Configuration
Set up a DataHub connection in Airflow. Set up a DataHub connection in Airflow, either via command line or the Airflow UI.
#### Command Line
```shell ```shell
airflow connections add --conn-type 'datahub-rest' 'datahub_rest_default' --conn-host 'http://datahub-gms:8080' --conn-password '<optional datahub auth token>' airflow connections add --conn-type 'datahub-rest' 'datahub_rest_default' --conn-host 'http://datahub-gms:8080' --conn-password '<optional datahub auth token>'
``` ```
#### Airflow UI
On the Airflow UI, go to Admin -> Connections and click the "+" symbol to create a new connection. Select "DataHub REST Server" from the dropdown for "Connection Type" and enter the appropriate values.
<p align="center">
<img width="70%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/airflow/plugin_connection_setup.png"/>
</p>
#### Optional Configurations
No additional configuration is required to use the plugin. However, there are some optional configuration parameters that can be set in the `airflow.cfg` file. No additional configuration is required to use the plugin. However, there are some optional configuration parameters that can be set in the `airflow.cfg` file.
```ini title="airflow.cfg" ```ini title="airflow.cfg"