Skip to content

Commit ebcdafb

Browse files
committed
move to authoring section
1 parent 7eb8fd3 commit ebcdafb

File tree

4 files changed

+39
-26
lines changed

4 files changed

+39
-26
lines changed

airflow-core/docs/authoring-and-scheduling/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ It's recommended that you first review the pages in :doc:`core concepts </core-c
3333
connections
3434
dynamic-task-mapping
3535
assets
36+
ownership
3637

3738
.. _scheduling-section:
3839

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
or more contributor license agreements. See the NOTICE file
3+
distributed with this work for additional information
4+
regarding copyright ownership. The ASF licenses this file
5+
to you under the Apache License, Version 2.0 (the
6+
"License"); you may not use this file except in compliance
7+
with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
software distributed under the License is distributed on an
13+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
KIND, either express or implied. See the License for the
15+
specific language governing permissions and limitations
16+
under the License.
17+
18+
19+
.. _ownership:
20+
21+
Ownership
22+
=========
23+
24+
When multiple users are authoring the DAGs of a single Airflow instance, it can be tedious to know who is responsible of what.
25+
One way to overcome this is to attach owners, allowing users to know who is in charge of a particular DAG or Task.
26+
27+
This ownership is split in two parts:
28+
29+
1. at the Task level, through the ``owner`` argument of the :class:`~airflow.models.baseoperator.BaseOperator`;
30+
2. at the DAG level, to customize the UI through the ``owner_links`` definition.
31+
32+
In Airflow 2, the list of owners was displayed in the DAG list view, not taking into account the ``owner_links`` value.
33+
Starting with Airflow 3.1, the owners are displayed in the header of the DAG view.
34+
Hence, a clickable link (that may be a instant messaging handle or a mailto link) is displayed for any owner matching an item defined in the ``owner_links`` dictionary is converted to a clickable link.
35+
36+
If you don't need the Task level granularity, and want to define a set of owners at the DAG level, you may leverage the :ref:` \`\`default_args\`\` argument <concepts-default-arguments>` to apply the same set of owners to every tasks in the DAG.
37+
38+

airflow-core/docs/core-concepts/dags.rst

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -686,23 +686,6 @@ This is especially useful if your tasks are built dynamically from configuration
686686
Here's a [url](www.airbnb.com)
687687
"""
688688
689-
.. _concepts:dags-ownership:
690-
691-
Ownership
692-
~~~~~~~~~
693-
694-
In addition to these documentation and notes, you are also able to link a DAG with a set of owners.
695-
This way the DAG users may be able to reach out the right set of people when needed.
696-
697-
This ownership is split in two parts:
698-
699-
1. at the :ref:`Task level <concepts:task-owner>` through the ``owner`` definition;
700-
2. at the DAG level to customize the UI through the ``owner_links`` definition.
701-
702-
Each DAG collects the set of owners from its task set, and display it on the DAGs view UI.
703-
Any owner matching an item defined in the ``owner_links`` dictionary is converted to a clickable link (that may be a instant messaging handle or a mailto link).
704-
705-
706689
Packaging dags
707690
--------------
708691

airflow-core/docs/core-concepts/tasks.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -236,12 +236,3 @@ This is achieved via the ``executor_config`` argument to a Task or Operator. Her
236236

237237
The settings you can pass into ``executor_config`` vary by executor, so read the :doc:`individual executor documentation <executor/index>` in order to see what you can set.
238238

239-
240-
.. _concepts:task-owner:
241-
242-
Ownership
243-
---------
244-
245-
It is possible to set an owner to a Task through the ``owner`` argument of the :class:`~airflow.models.baseoperator.BaseOperator`.
246-
This may allow DAGs users to know who is in charge of the development of the different parts of a DAG.
247-
The owner definition also allows to customize the DAG rendering in the DAGs view UI, :ref:`creating links <concepts:dags-ownership>` to contact the owners through the ``owner_links`` of the :class:`~airflow.models.dag.DAG`.

0 commit comments

Comments
 (0)