amoghrajesh opened a new pull request, #68136:
URL: https://github.com/apache/airflow/pull/68136
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
http://chris.beams.io/posts/git-commit/
Please make sure that your code changes are covered with tests.
And in case of new features or big changes remember to adjust the
documentation.
Feel free to ping (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [x] Yes - claude sonnet 4.6
<!--
Generated-by: [Tool Name] following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
closes: https://github.com/apache/airflow/issues/67706
---
### What?
Operators that submit work to external systems such as Spark, BigQuery, EMR,
Kubernetes share a common failure mode: the worker holds its slot for the full
polling duration, and if the worker crashes the task retries from scratch,
often submitting a duplicate job. Airflow 3.3 now introduces
`ResumableJobMixin` to solve the crash-and-duplicate problem, and the task
state store enables the broader checkpoint-and-resume pattern. Neither had
documentation, and there was no guidance on when to reach for these over
deferrable operators or async tasks.
### Current behaviour
The only comparison page (`task-sdk/docs/deferred-vs-async-operators.rst`)
covered deferrable and async operators but made no mention of resumable tasks.
`ResumableJobMixin` had no user-facing documentation at all. Users experiencing
repeated job submission failures had no clear path to a solution.
### Proposed change
- Adds `airflow-core/docs/core-concepts/resumable-tasks.rst` - a decision
guide covering all three patterns (deferrable, resumable, async) with trade-off
descriptions, a three-way comparison table, and a general checkpoint example
using `task_store` directly.
- Adds `task-sdk/docs/resumable-job-mixin.rst`- a reference page for
`ResumableJobMixin` covering the interface, method descriptions with inline
examples, the retry flow, the pre-submit crash window limitation, and the
`external_id_key` renaming warning.
- Updates `task-sdk/docs/deferred-vs-async-operators.rst` with a
`versionchanged:: 3.3.0` note pointing to both new pages.
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
