-
Notifications
You must be signed in to change notification settings - Fork 15.5k
feat(docs): explain owners definition #53176
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
Open
AlexisBRENON
wants to merge
4
commits into
apache:main
Choose a base branch
from
AlexisBRENON:owners_docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+39
−1
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
.. Licensed to the Apache Software Foundation (ASF) under one | ||
or more contributor license agreements. See the NOTICE file | ||
distributed with this work for additional information | ||
regarding copyright ownership. The ASF licenses this file | ||
to you under the Apache License, Version 2.0 (the | ||
"License"); you may not use this file except in compliance | ||
with the License. You may obtain a copy of the License at | ||
|
||
.. http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
.. Unless required by applicable law or agreed to in writing, | ||
software distributed under the License is distributed on an | ||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
KIND, either express or implied. See the License for the | ||
specific language governing permissions and limitations | ||
under the License. | ||
|
||
|
||
.. _ownership: | ||
|
||
Ownership | ||
========= | ||
|
||
When multiple users are authoring the DAGs of a single Airflow instance, it can be tedious to know who is responsible of what. | ||
One way to overcome this is to attach owners, allowing users to know who is in charge of a particular DAG or Task. | ||
|
||
This ownership is split in two parts: | ||
|
||
1. at the Task level, through the ``owner`` argument of the :class:`~airflow.models.baseoperator.BaseOperator`; | ||
2. at the DAG level, to customize the UI through the ``owner_links`` definition. | ||
|
||
In Airflow 2, the list of owners was displayed in the DAG list view, not taking into account the ``owner_links`` value. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is misleading because it generalizes for all of Airflow 2. The https://airflow.apache.org/docs/apache-airflow/2.4.0/howto/add-owner-links.html |
||
Starting with Airflow 3.1, the owners are displayed in the header of the DAG view. | ||
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. | ||
|
||
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we've decided to refer to “DAG” as “Dag” from now on, so please change it accordingly.