docs: add FLYTE_IMAGE_REGISTRY setup step for remote workflow execution#7236
Open
nuthalapativarun wants to merge 2 commits intoflyteorg:masterfrom
Open
docs: add FLYTE_IMAGE_REGISTRY setup step for remote workflow execution#7236nuthalapativarun wants to merge 2 commits intoflyteorg:masterfrom
nuthalapativarun wants to merge 2 commits intoflyteorg:masterfrom
Conversation
When running workflows remotely on a demo cluster using ImageSpec, pyflyte needs FLYTE_IMAGE_REGISTRY set to push the container image to the local registry. Without this, tasks that reference os.environ['FLYTE_IMAGE_REGISTRY'] fail at runtime. Add a step to export FLYTE_IMAGE_REGISTRY=localhost:30000 before pyflyte run, and pass it via --env so task containers also have access to the variable. Fix the pre-existing step numbering error (steps jumped from 4 back to 3). Closes flyteorg#6606 Signed-off-by: Varun Nuthalapati <nuthalapativarun@gmail.com>
nuthalapativarun
force-pushed
the
docs/missing-env-remote-run-6606
branch
from
a6c983a to
5e0e2c5
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #7236 +/- ##
==========================================
- Coverage 56.96% 56.95% -0.01%
==========================================
Files 931 931
Lines 58246 58246
==========================================
- Hits 33178 33175 -3
- Misses 22014 22017 +3
Partials 3054 3054
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
pingsutw
reviewed
Apr 21, 2026
|
|
||
| 7. Run the workflow on the Flyte cluster with `pyflyte run` using the `--remote` flag and additional parameters for the project name and domain. In this example, you can also optionally pass a `name` parameter to the workflow: | ||
| ```{prompt} bash $ | ||
| pyflyte run --remote --env FLYTE_IMAGE_REGISTRY=localhost:30000 -p my-project -d development example.py wf --name Ada |
Member
There was a problem hiding this comment.
Do we need FLYTE_IMAGE_REGISTRY env var in the task?
Suggested change
| pyflyte run --remote --env FLYTE_IMAGE_REGISTRY=localhost:30000 -p my-project -d development example.py wf --name Ada | |
| pyflyte run --remote -p my-project -d development example.py wf --name Ada |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Tracking issue
Closes #6606
Why are the changes needed?
The "Running a workflow locally" guide shows the
pyflyte run --remotecommand but does not mention thatFLYTE_IMAGE_REGISTRYmust be set when the workflow uses ImageSpec. The default project template (basic-template-imagespec) reads this variable to determine where to push the container image. Without it, task execution fails with:The working command is:
What changes were proposed in this pull request?
In
docs/user_guide/getting_started_with_workflow_development/running_a_workflow_locally.md:FLYTE_IMAGE_REGISTRY=localhost:30000with a note explaining why the demo cluster registry is needed.pyflyte runcommand (now step 7) to include--env FLYTE_IMAGE_REGISTRY=localhost:30000so task containers also have access to the variable.How was this patch tested?
Documentation change only; verified by reading the rendered diff.
Labels
fixed
I updated the documentation accordingly.
All new and existing tests passed.
All commits are signed-off.