docs(flyte-sdk-author): call out CWD-relative .flyte/config.yaml discovery - #31
Open
BadToast wants to merge 1 commit into
Open
docs(flyte-sdk-author): call out CWD-relative .flyte/config.yaml discovery#31BadToast wants to merge 1 commit into
BadToast wants to merge 1 commit into
Conversation
…overy Add an anti-pattern noting that `.flyte/config.yaml` is discovered relative to the current working directory, and that `flyte run` / `deploy` / `serve` must be invoked from the directory containing the config file (typically the project root). Running from a subdirectory silently falls back to defaults without any user-visible warning. Complements existing anti-pattern flyteorg#6 (`flyte.init_from_config()` required for apps) — same root cause (config discovery), different failure mode.
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
1 participant
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.
Motivation
Existing anti-pattern #6 already covers "don't forget
flyte.init_from_config()"for the
flyte.serve()case, but the sibling gotcha — that config discoveryis CWD-relative and there is no warning when it falls back to defaults — is
never called out. This surfaces as mystifying "why is my project setting
being ignored?" behaviour that's easy to burn 30 minutes on.
Placement
Appended as anti-pattern #7 at the end of the existing numbered list in
## Anti-Patterns to Avoid. Deliberately kept adjacent to #6 (which coversthe related
flyte.init_from_config()requirement) — same root cause,different failure mode.