Commit a436f1d
docsy(v2): document tracked local runs (--tracked / --tracked-strict) (#1462)
* docs: document tracked local runs (--tracked / --tracked-strict)
Regen #1424 published --tracked, --tracked-strict and
flyte create config --local-tracked in the generated CLI reference, but no
narrative page mentions them. A reader searching the user guide for "tracked"
finds nothing, and running-locally describes local runs as leaving no trace on
the control plane, which --tracked changes.
Document tracking as a modifier on local execution rather than a fourth run
mode, since --tracked implies --local and the task still executes in the local
Python process:
- run-command-options: a --tracked / --tracked-strict section covering what is
reported (actions, attempts, phases, inputs, outputs, reports, cache status),
what is not (logs stay in the terminal), the best-effort reporting policy and
why strict mode exists, the run-name contract (<=30 chars, no leading u or r,
auto-named local-<id>), and the local.tracked config key.
- running-locally: a "Track local runs in the console" section, plus a note on
the "What works locally" table, which otherwise implies local runs are
invisible to the control plane.
- run-modes/_index: the union comparison table listed "No (TUI only)" under
Flyte UI for local execution, which is no longer accurate.
Gated to the union variant: flyteorg/flyte carries only the flyteidl2 protos
and generated stubs for TrackedRunService, with no server implementation. It is
implemented in the Union control plane.
NOT FOR MERGE until tracked runs is released. Drafted under the publish gate.
Co-Authored-By: docsy <docsy@union.ai>
Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
* docs: scope the tracked-run naming rules as additive
The two rules validate_tracked_run_name enforces (<=30 chars, no leading u or
r) are specific to tracked runs. Phrasing them as the naming contract read as
exhaustive, which would mislead a reader who then hits the separate --name
charset behavior reported in DOC-1425 (unresolved: no eng verdict, and the
constraint is not in the SDK or in Union CreateRun, which rejects only a
leading 'u').
Co-Authored-By: docsy <docsy@union.ai>
Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
* docs: name the Tracked Runs section, and add the zero-file example
Two corrections to the tracked-runs pages, both verified against
unionai/cloud@origin/main and by running the CLI.
Where tracked runs appear. Both pages said a tracked run shows up
"alongside" or "next to" your remote runs, which reads as the Runs list.
It is not: clientsv2/src/components/NavPanel/NavItemConfigs.tsx defines
TrackedRunsLink as its own sidebar item pointing at
/domain/<domain>/project/<project>/tracked-runs, separate from RunsLink,
and the Runs list has no tracked-run handling at all. Running
`flyte run --tracked hello` printed a link ending
/project/<project>/tracked-runs/local-ffa90918. A reader following the
old wording looks in the wrong list, so both pages now name the section.
The zero-file path. `flyte run hello` landed in flyte-sdk #1496 on
2026-09-01 and is already in the pinned CLI reference. It writes a
built-in example to a scratch directory and runs it, so
`flyte run --tracked hello` takes someone from a fresh config to a run
in the console without writing a file first. Verified by execution on
flyte 2.6.13, not by reading: local and tracked both complete with
ActionOutputs(o0=14.0).
Co-Authored-By: docsy <docsy@union.ai>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017CJ89R9ri86y11FFhPdVJV
Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
---------
Signed-off-by: Peeter Piegaze <1153481+ppiegaze@users.noreply.github.com>
Co-authored-by: docsy <docsy@union.ai>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>1 parent 2527e08 commit a436f1d
3 files changed
Lines changed: 100 additions & 1 deletion
File tree
- content/user-guide
- get-started/run-modes
- tasks/task-deployment
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
53 | | - | |
| 53 | + | |
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| |||
Lines changed: 38 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
122 | 122 | | |
123 | 123 | | |
124 | 124 | | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
125 | 153 | | |
126 | 154 | | |
127 | 155 | | |
| |||
137 | 165 | | |
138 | 166 | | |
139 | 167 | | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
140 | 178 | | |
141 | 179 | | |
142 | 180 | | |
| |||
Lines changed: 61 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
32 | 45 | | |
33 | 46 | | |
34 | 47 | | |
| |||
80 | 93 | | |
81 | 94 | | |
82 | 95 | | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
83 | 144 | | |
84 | 145 | | |
85 | 146 | | |
| |||
0 commit comments