Commit fa3b401
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>1 parent 10aac29 commit fa3b401
3 files changed
Lines changed: 86 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 | |
|---|---|---|---|
| |||
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
51 | | - | |
| 51 | + | |
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
| |||
Lines changed: 30 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
115 | 115 | | |
116 | 116 | | |
117 | 117 | | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
118 | 138 | | |
119 | 139 | | |
120 | 140 | | |
| |||
130 | 150 | | |
131 | 151 | | |
132 | 152 | | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
133 | 163 | | |
134 | 164 | | |
135 | 165 | | |
| |||
Lines changed: 55 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
30 | 43 | | |
31 | 44 | | |
32 | 45 | | |
| |||
78 | 91 | | |
79 | 92 | | |
80 | 93 | | |
| 94 | + | |
| 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 | + | |
81 | 136 | | |
82 | 137 | | |
83 | 138 | | |
| |||
0 commit comments