Skip to content

Replace the stale "OSS backend doesn't apply raw_data_path" note with a flyteorg/flyte v2.0.54 requirement - #1937

Draft
unionai-docsy-agent[bot] wants to merge 1 commit into
mainfrom
docsy/case-3486
Draft

unionai-docsy-agent[bot] wants to merge 1 commit into
mainfrom
docsy/case-3486

Conversation

@unionai-docsy-agent

Copy link
Copy Markdown
Contributor

What changed in the product

flyteorg/flyte#8026 ("feat(runs): apply the run base dir and raw data path settings") merged on 2026-11-02 as commit c773118d. It shipped in flyteorg/flyte v2.0.54, published 2026-11-03. The commit is an ancestor of the v2.0.54 tag and not of v2.0.53.

Before #8026, the open-source backend accepted a run's raw data prefix but wrote offloaded data under each action's output location. From v2.0.54, the backend uses the prefix. Here is where it's applied in flyteorg/flyte at v2.0.54:

  • actions/k8s/client.go: applyRunSpecToTaskAction copies runSpec.RawDataStorage.RawDataPrefix into TaskAction.Spec.RawDataPrefix. Child actions inherit it from the parent in inheritRunContextFromParentTaskAction.
  • executor/pkg/plugin/task_exec_context.go: the new ComputeActionRawOutputPath builds the action's raw output paths from Spec.RawDataPrefix when it's set. It falls back to the output prefix only when no prefix is set. Checkpoint paths resolve the same way.
  • runs/service/run_service.go: CreateRun no longer replaces an empty raw data prefix with the default storage prefix.

On the SDK side, flyte-sdk main (src/flyte/_run.py) sends with_runcontext(raw_data_path=...) as RawDataStorage(raw_data_prefix=...), which is the field the backend now reads.

Signal that asked for this

unionai-docs#1879 deferred this follow-up in its description: "When flyteorg/flyte#8026 merges and ships in a release, remove the note in where-data-lives.md and the pointers to it." That release is now out.

Open-source deployments on a backend older than v2.0.54 still don't apply the setting. The docs style rule says to state a version requirement when behavior depends on one. So instead of only deleting the "doesn't apply" text, this PR replaces it with a one-line requirement wherever the Flyte variant says raw_data_path routes offloaded data: "On the open-source Flyte backend, remote runs apply raw_data_path only with flyteorg/flyte v2.0.54 or later."

#1879 also deferred adding a pointer to run-command-options.md, integrations/huggingface/_index.md and integrations/hydra/_index.md. This PR adds the requirement line to run-command-options.md, which documents --raw-data-path. The Hugging Face and Hydra pages aren't changed.

Changes, page by page

Every changed block is a {{< variant flyte >}} block, so only the Flyte variant changes. Union pages are unaffected.

  • content/user-guide/get-started/core-concepts/where-data-lives.md: under "Per-run customization: raw_data_path", replaced the NOTE with the version requirement. Removed the one-line pointer after "The short version" list. That list's raw_data_path bullet is a summary, and the condition is stated in the section above it.
  • content/user-guide/tasks/task-deployment/run-context.md: replaced the line after the Storage table with the requirement, covering both raw_data_path and --raw-data-path.
  • content/user-guide/run-scaling/data-flow.md: replaced the pointer after "Output upload" with the requirement. Removed the duplicate pointer after "Per-run configuration", because the line earlier on the page covers both mentions.
  • content/user-guide/tasks/task-deployment/run-command-options.md: added the requirement for --raw-data-path in that option's section, after the examples.

No other page links to the removed NOTE. The #per-run-customization-raw_data_path anchor is a section heading, so the link from the Hugging Face page still works.

Not verified / open questions

  • Behavior not tested on a backend: I didn't run a remote run against a v2.0.54 OSS backend. The evidence above comes from reading the merged code at the tag.
  • How long to keep the version line: v2.0.54 came out days ago, so many self-hosted open-source deployments are probably still on an earlier backend. That is why the requirement is stated. It's still open when the line can go: either once older backends are out of support, or never, as with the other "requires X or later" lines in the docs. No owner on the routing list covers the OSS backend, so this question isn't addressed to anyone.

Pre-flight review

Docsy's reviewer read this draft before it was opened and found 4 problems to fix. The draft was amended for them, and a check of the amendment found nothing left to fix.


Docsy case 3486: https://docsy.apps.demo.hosted.unionai.cloud/cases/3486

Drafted by Docsy, Union.ai's documentation agent, from the product changes and requests in this case. Review it like any PR; close it if it's not wanted.

… a flyteorg/flyte v2.0.54 requirement

Drafted by Docsy for case 3486.

Signed-off-by: unionai-docsy-agent[bot] <336110417+unionai-docsy-agent[bot]@users.noreply.github.com>
@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown

GHA build & deploy preview

Built by .github/workflows/build-pr.yml and deployed to the docs CF Pages project by .github/workflows/deploy-pr-preview.yml.

Branch alias https://pr-1937-docsy-case-3486.docs-dog.pages.dev
This commit https://a02b93b4.docs-dog.pages.dev
Commit SHA 4dbd35a8c657b41bfae69273ffabd619500f6f82

Updated automatically on every push.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants