docsy(v2): document run recovery (--recover / --recover-from) - #1439
docsy(v2): document run recovery (--recover / --recover-from)#1439ppiegaze wants to merge 1 commit into
Conversation
Add a "Recover a failed run" page covering the shipped CLI and SDK surface: flyte rerun --recover, flyte run --recover-from, --force-rerun-action, --allow-missing-outputs, and with_runcontext(recover=..., recover_force_rerun_actions=..., allow_missing_source_outputs=...). Also documents the action-identity model that decides what is reused vs. re-executed (cache-key naming from flyte-sdk#1373), the requirements the Run Service validates (source run must exist, be terminal, be in the same project/domain), and the Recovered action phase. Gated to the union variant: recovery in the OSS backend is still a design proposal (flyteorg/flyte#7825), not implemented. Sibling updates: cross-links + a rerun-vs-recover comparison on rerun-runs, a Recovery parameter table on run-context (part of DOC-1267), and --rerun-from / --recover-from / --force-rerun-action on run-command-options. Co-Authored-By: docsy <docsy@union.ai> Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
GHA build & deploy previewBuilt by
Updated automatically on every push. |
|
Closing: superseded, and merging this would regress the docs. The SDK surface moved six days after this was drafted. flyte-sdk#1452 (2026-08-20, first absent in v2.6.3) removed Meanwhile #1464 merged on 2026-08-21 and landed No residual gap for this branch to fill. DOC-1211 moves to Done against #1464. — docsy · automated docs agent · DOC-1211 · run report |
Documents run recovery (
--recover/--recover-from), the shipped Phase 1 slice of the Recovery Run project. Closes the gap DOC-1211 tracks.Why now
Readiness verified off the code artifact, not status fields:
--recover/--recover-fromlanded inflyte-sdk#1237 (4955aa4d, 2026-08-03), first released in v2.5.17flyte-sdk#1373 (22f43e6e), released in v2.5.19; this is what fixed "--recover-fromwith a code change does not work"flyteidl22.0.31+ carriesRunSpec.relation,RunSpec.recover,RELATION_TYPE_RECOVER, so the SDK'sNotImplementedErrorgate is openACTION_PHASE_RECOVEREDacross all systems, cloud#16862, merged 2026-07-16Latest release at time of writing:
flytev2.6.0.What changed
New page
user-guide/tasks/task-deployment/recover-runs.md(-flyte +union, weight 15):flyte rerun --recoverandflyte run --recover-fromhash(parent + inputs + task identity + call seq)where task identity istask name + interface + per-task code version, deliberately excluding the image, code bundle version, resources, and env vars--force-rerun-action/recover_force_rerun_actionsas the escape hatchflyte.rerun()never recoversRecoveredaction phase andrecovered_fromprovenance--allow-missing-outputs; the SDK 2.6.0 floor on the source runSibling updates:
rerun-runs.md: union-gated pointer to the new page, a note under the rerun/--rerun-fromcomparison table, a Related entry, and the pre-existing "such as recovering a failed run" clause now links somewhererun-context.md: a union-gated Recovery parameter table (recover,recover_force_rerun_actions,allow_missing_source_outputs). This closes therecoverline item of DOC-1267run-command-options.md:--rerun-from(both variants, a pre-existing gap that the rerun page already cross-referenced) plus union-gated--recover-fromand--force-rerun-actiondebug-runs.md: weight 15 → 16 to make roomVariant scope
Union only. Recovery in the OSS backend is still a design-doc PR (flyteorg/flyte#7825, open, unmerged), so nothing recover-related renders in the
flytevariant. Verified in the built output for both variants.Deliberately not documented
flyte.replay()/with_replaycontext()(PRD Phase 2). Named in ENG26-830 but absent from the SDK's exports onorigin/main. Not shipped, so not documented.Verification
make variant VARIANT=unionandVARIANT=flyte: clean builds, 1403 / 1289 pagesmake check-links: all internal links valid, both variantsdist/: zerorecoveroccurrences in the flyte build ofrerun-runs,run-command-options,run-context— docsy · automated docs agent · DOC-1211