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.

Sign up for GitHub

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

Jump to bottom

Clarify owner links document #26515

Merged
merged 2 commits into from Sep 20, 2022
Merged

Clarify owner links document #26515

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9677ad1
Clarify owner links doc and fix errors
BasPH Sep 20, 2022
2ee0698
Add examples
BasPH Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 15 additions & 14 deletions docs/apache-airflow/howto/add-owner-links.rst
View file
Open in desktop
Expand Up @@ -23,26 +23,27 @@ Add Owner Links to DAG

.. versionadded:: 2.4.0

You can pass the ``owner_link`` parameter for your DAG object, which will make the owner to become a clickable link
in the main DAGs view page.
You can use it to set a custom HTTP link (for example, the owner's Slack channel), or use a
`maitlo <https://en.wikipedia.org/wiki/Mailto>`_ link to have an automated email message (up to 500 characters).
You can set the ``owner_links`` argument on your DAG object, which will make the owner a clickable link in the
main DAGs view page instead of a search filter.

Example:
In your DAG file, add a ``owners_link`` parameter to the DAG object that will hold a dictionary of an owner and it's link.
After that, define a task that will use this owner, and the link in the DAGs view will become clickable
Two options are supported:

* An HTTP link (e.g. ``https://www.example.com``) which opens the webpage in your default internet client
* A `mailto <https://en.wikipedia.org/wiki/Mailto>`_ link (e.g. ``mailto:example@airflow.com``) which opens your default email client to send an email to the specified address

In your DAG, set the ``owner_links`` argument specifying a dictionary of an owner (key) and its link (value).
Next define a task using this owner, and the owner in the DAGs view will link to the specified address.

.. code-block:: python
:emphasize-lines: 5

dag = DAG(
with DAG(
dag_id="example_dag_owners",
schedule="0 0 * * *",
start_date=datetime(2022, 8, 5),
owner_links={"airflow": "https://airflow.apache.org/"},
)

with dag:
bash_task = BashOperator(task_id='task_using_linked_owner', bash_command='echo 1', owner='airflow')
schedule="0 0 * * *",
owner_links={"airflow": "https://airflow.apache.org"},
):
BashOperator(task_id="task_using_linked_owner", bash_command="echo 1", owner="airflow")

**Screenshot**:

Expand Down