Skip to content

docs: Document Flash endpoint/app lifecycle operations are now CLI-only #681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
promptless wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Document Flash endpoint/app lifecycle operations are now CLI-only #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b39e41
Document Flash endpoint/app lifecycle operations are CLI-only
promptless[bot] Jun 30, 2026
ac34c72
Resolve base-branch merge conflicts
promptless[bot] Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions flash/apps/deploy-apps.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ flash deploy
uv run flash deploy
```

<Note>
The Flash CLI manages endpoint and app lifecycle operations: `deploy`, `undeploy`, `update`, and creating or deleting apps and environments. If you call these methods directly from the SDK, Flash raises a `FlashUsageError` that names the equivalent `flash` command. Routing lifecycle changes through the CLI keeps the build and manifest pipeline aligned with Flash's local state tracking. Direct SDK calls bypass that orchestration and can leave deployments in an inconsistent state.

@promptless promptless Bot Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR #346 (feat(sdk): make endpoint/app lifecycle operations CLI-only) adds a cli_only() decorator in core/cli_context.py and applies it to ServerlessResource.{deploy,undeploy,update}, NetworkVolume.deploy, and FlashApp create/delete/environment methods. The decorator raises FlashUsageError naming the equivalent flash command when called outside the CLI, because direct SDK calls bypass the build/manifest pipeline and local state tracking. This Note documents that behavior.

Source: runpod/flash#346

</Note>

This command performs the following steps:

1. **Build**: Packages your code, dependencies, and manifest.
Expand Down
4 changes: 4 additions & 0 deletions release-notes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ description: "New features, fixes, and improvements for the Runpod platform."

<Accordion title="June 2026">

<h4><Badge color="red">Breaking</Badge> Lifecycle operations are now CLI-only</h4>

Flash SDK methods for endpoint and app lifecycle operations—deploy, undeploy, update, and creating or deleting apps and environments—now raise a `FlashUsageError` that points to the equivalent `flash` command. Run these operations through the [Flash CLI](/flash/cli/overview) instead, which keeps the build and manifest pipeline and local state tracking consistent.

<h4><Badge color="green">New Release</Badge> High-Performance Network Volumes now available</h4>

You can now attach high-performance network volumes to [Pods, Serverless endpoints, and Instant Clusters](/storage/network-volumes) for significantly faster model load times. Look for the purple diamond icon to identify compatible datacenters.
Expand Down
Loading