docs(flyte-sdk-run): add trigger CLI lifecycle cookbook - #32
Open
BadToast wants to merge 1 commit into
Open
Conversation
Add a `Managing Triggers` section covering create / deactivate / re-activate /
delete lifecycle recipes with the `flyte {create,update,delete} trigger`
family, plus a callout for the positional-argument-order inversion between
`create` (TASK_NAME NAME) and `update`/`delete` (NAME TASK_NAME).
Zero coverage of `flyte update trigger --activate/--deactivate` or
`flyte delete trigger` currently exists across any of the 10 SDK skills;
`flyte-sdk-agent` has a single `create trigger` example in an agent-specific
context, but the full lifecycle recipes aren't documented anywhere.
Verified against flyte 2.5.15.
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.
Summary
Adds a
Managing Triggerssection toflyte-sdk-run/SKILL.mdcovering thefull trigger lifecycle via the
flyteCLI:flyte create trigger— with cronflyte update trigger --deactivate— pause without deregisteringflyte update trigger --activate— resumeflyte delete trigger— permanent removalcreateandupdate/delete(the CLI itself has this inconsistency; documenting itsaves users a debugging round-trip).
Motivation
The
flyte-sdk-runskill's description already advertises "manages runlifecycle" and its trigger words include
cancel,abort, andrun metadata,but trigger-lifecycle CLI recipes are missing. The only trigger CLI mention
in any of the 10 SDK skills is one
flyte create triggerexample inflyte-sdk-agent/SKILL.md(in an agent-scheduling context), and it doesn'tcover deactivate / reactivate / delete.
Verification
CLI argument order was cross-checked against
flyte 2.5.15:flyte create trigger --help→Usage: flyte create trigger [OPTIONS] TASK_NAME NAMEflyte update trigger --help→Usage: flyte update trigger [OPTIONS] NAME TASK_NAMEflyte delete trigger --help→Usage: flyte delete trigger [OPTIONS] NAME TASK_NAMEAll new examples use
flytesnacks / developmentas the project / domain,consistent with the rest of
flyte-sdk-run/SKILL.md. No tenant identifiers.Placement
Inserted between the existing
## Re-running Runsand## Running Tasks (vs Workflows)sections — thematically continues the run-lifecycle progression(one-off run → re-run → recurring/scheduled run).