Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
e897470
Add Flash documentation section
promptless[bot] Jan 20, 2026
60d135a
Update flash overview
muhsinking Jan 22, 2026
8f0edc7
Update overview description
muhsinking Jan 22, 2026
1fff74d
Merge branch 'main' into promptless/flash-documentation-section
muhsinking Jan 26, 2026
b5453eb
Tetra -> Flash
muhsinking Feb 6, 2026
4620f5f
Add environment variable instructions
muhsinking Feb 11, 2026
9b9c314
Add CLI reference, expand app guides
muhsinking Feb 18, 2026
c7e2f5e
Update filestructure to include apps/ section
muhsinking Feb 19, 2026
688281e
Improve flash apps and run docs, remove endpoint management section
muhsinking Feb 19, 2026
317a846
Add section for coding agent skills
muhsinking Feb 19, 2026
8a12edf
Update overview, remove duplicate info from the quickstart.
muhsinking Feb 20, 2026
486dae2
Improve explanation of Flash apps
muhsinking Feb 20, 2026
ecaa467
Merge branch 'main' into promptless/flash-documentation-section
muhsinking Feb 20, 2026
6f87d4a
Update flash examples url
muhsinking Feb 20, 2026
aa2ba70
Update flash examples url
muhsinking Feb 20, 2026
e08dd61
Improve "why use flash"
muhsinking Feb 20, 2026
196da4d
Fix tooltip, improve "why use flash"
muhsinking Feb 20, 2026
88d9514
Add custom docker images guide
muhsinking Feb 21, 2026
2a62978
Update "why use flash"
muhsinking Feb 21, 2026
822b7bd
Update
muhsinking Feb 21, 2026
222fb05
Update
muhsinking Feb 21, 2026
aeb1352
Improve "why use flash" section
muhsinking Feb 21, 2026
815d81b
Add text generation example to flash quickstart
muhsinking Feb 23, 2026
02e612b
Fix typo
muhsinking Feb 23, 2026
ad64a40
Simplify the Flash quickstart
muhsinking Feb 23, 2026
1a18ed4
Add image gen and text gen tutorials for flash
muhsinking Feb 23, 2026
2dc8818
Use periods consistently after bulleted lists
muhsinking Feb 23, 2026
4fabf82
Move + update Flash example tutorials
muhsinking Feb 25, 2026
314b5fb
Move tutorials back to examples/
muhsinking Feb 25, 2026
09845ab
Update quickstart next steps
muhsinking Feb 25, 2026
61c5ec2
Update flash init/run/deploy architecture, add resource configuration…
muhsinking Feb 26, 2026
399905a
update docs.json
muhsinking Feb 26, 2026
a4c91ea
Update Flash LB tutorial
muhsinking Feb 26, 2026
abdb17f
Fix typo
muhsinking Feb 26, 2026
f08047d
Update parameters
muhsinking Feb 26, 2026
1d41a12
remove references to /tmp
muhsinking Feb 26, 2026
9c9c9ec
Add coding agent integration to quickstart
muhsinking Feb 26, 2026
7b45c18
test wide mode
muhsinking Feb 27, 2026
90225dd
Rebuild Runpod overview, remove duplicated info from Flash, add Flash…
muhsinking Feb 27, 2026
99346a9
Update card style
muhsinking Feb 27, 2026
6accfaa
Update
muhsinking Feb 27, 2026
b84a7de
Make "why use flash" shorter
muhsinking Feb 27, 2026
1c6d86d
Add troubleshooting guide
muhsinking Mar 2, 2026
579277f
add execution model, reorder cards
muhsinking Mar 2, 2026
0699e5c
update
muhsinking Mar 2, 2026
58e6e23
tutorials -> examples
muhsinking Mar 2, 2026
459ede8
Update overview, remove excessive beta tags
muhsinking Mar 2, 2026
f033b69
fix docs after QA review; add flash login
muhsinking Mar 2, 2026
971d3fa
Merge branch 'main' into promptless/flash-documentation-section
muhsinking Mar 2, 2026
94a6425
Update sidebar
muhsinking Mar 2, 2026
5d60fbb
add missing period
muhsinking Mar 2, 2026
47e108c
Update overview, add Flash to concepts
muhsinking Mar 3, 2026
5dc09d7
Unify card styles
muhsinking Mar 3, 2026
b10c8f0
fix typo
muhsinking Mar 3, 2026
fab9ddd
Consolidate resource config docs
muhsinking Mar 3, 2026
1eae66e
Use UV, simplify Flash overview and apps section
muhsinking Mar 3, 2026
46941ca
Simplify coding agent intro
muhsinking Mar 3, 2026
033f63f
Update
muhsinking Mar 3, 2026
8be8695
update
muhsinking Mar 3, 2026
c595180
Rewrite flash intro, remove venv steps
muhsinking Mar 4, 2026
c4c26e9
Add pip instructions
muhsinking Mar 4, 2026
b34339d
Update
muhsinking Mar 4, 2026
5c9c376
Update
muhsinking Mar 4, 2026
7dcccf1
Update Flash endpoint syntax: @remote -> @endpoint (#545)
muhsinking Mar 5, 2026
51985f4
Update overview
muhsinking Mar 5, 2026
704a40c
Update overview
muhsinking Mar 5, 2026
bbb598e
Add release note for Flash
muhsinking Mar 5, 2026
8be44d8
Update post-QA test
muhsinking Mar 5, 2026
acc68c9
Add flash examples to quickstart next steps
muhsinking Mar 5, 2026
81000d8
Update custom container title
muhsinking Mar 5, 2026
39accb0
Rename create endpoints file
muhsinking Mar 5, 2026
c2dd078
Update endponts intro
muhsinking Mar 6, 2026
082c551
Update docs for flash 1.8.0 release
muhsinking Mar 10, 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
2 changes: 1 addition & 1 deletion .cursor/rules/rp-styleguide.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ alwaysApply: true
---

Always use sentence case for headings and titles.
These are proper nouns: Runpod, Pods, Serverless, Hub, Instant Clusters, Secure Cloud, Community Cloud, Tetra.
These are proper nouns: Runpod, Pods, Serverless, Hub, Instant Clusters, Secure Cloud, Community Cloud, Flash.
These are generic terms: endpoint, worker, cluster, template, handler, fine-tune, network volume.

Prefer using paragraphs to bullet points unless directly asked.
Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Follow the Runpod style guide (`.cursor/rules/rp-styleguide.mdc`) and Google Dev
### Capitalization and Terminology

- **Always use sentence case** for headings and titles
- **Proper nouns**: Runpod, Pods, Serverless, Hub, Instant Clusters, Secure Cloud, Community Cloud, Tetra
- **Proper nouns**: Runpod, Pods, Serverless, Hub, Instant Clusters, Secure Cloud, Community Cloud, Flash
- **Generic terms** (lowercase): endpoint, worker, cluster, template, handler, fine-tune, network volume

### Writing Style
Expand Down
4 changes: 2 additions & 2 deletions community-solutions/ohmyrunpod/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Check the repository for additional features, updates, and documentation: [githu
## Key features

<CardGroup cols={2}>
<Card title="Easy File Transfer" icon="arrow-right-arrow-left">
<Card title="Easy File Transfer" icon="arrow-right-arrow-left" horizontal>
Simplified file transfer between your local machine and Runpod instances using SFTP or Croc
</Card>
<Card title="Automatic SSH Setup" icon="key">
<Card title="Automatic SSH Setup" icon="key" horizontal>
Automatically configures SSH access with secure key generation and password management
</Card>
</CardGroup>
Expand Down
8 changes: 4 additions & 4 deletions community-solutions/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,31 @@ Community tools and solutions are provided as-is and maintained by their creator
Explore these community-created tools that can enhance your Runpod workflow:

<CardGroup cols={1}>
<Card
<Card horizontal
title="ComfyUI to API"
icon="wand-magic-sparkles"
href="/community-solutions/comfyui-to-api/overview"
>
Web-based tool that analyzes ComfyUI workflows and automatically generates Dockerfiles and GitHub repositories for deployment on Runpod Serverless.
</Card>

<Card
<Card horizontal
title="OhMyRunPod"
icon="rocket"
href="/community-solutions/ohmyrunpod/overview"
>
Python package for easy SFTP setup and file transfers. Simplifies connecting to your Pods with file transfer software like FileZilla.
</Card>

<Card
<Card horizontal
title="SSH password setup & migration tools"
icon="arrows-rotate"
href="/community-solutions/ssh-password-migration/overview"
>
Bash and Python scripts for migrating data between Runpod instances when you need to move Pods or backup data.
</Card>

<Card
<Card horizontal
title="CopyParty file manager"
icon="folder-open"
href="/community-solutions/copyparty-file-manager/overview"
Expand Down
10 changes: 5 additions & 5 deletions containers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,35 @@
title: "Containers"
---

<Card href="/tutorials/introduction/containers">
<Card href="/tutorials/introduction/containers" horizontal>
## 📄️ Overview

Learn how to build and deploy applications on the Runpod platform with this set of tutorials, covering tools, technologies, and deployment methods, including Containers, Docker, and Serverless implementation.

</Card>

<Card href="/tutorials/introduction/containers/">
<Card href="/tutorials/introduction/containers/" horizontal>
## 📄️ Intro to containers

Discover the world of containerization with Docker, a platform for isolated environments that package applications, frameworks, and libraries into self-contained containers for consistent and reliable deployment across diverse computing environments.

</Card>

<Card href="/tutorials/introduction/containers/create-dockerfiles">
<Card href="/tutorials/introduction/containers/create-dockerfiles" horizontal>
## 📄️ Dockerfile

Learn how to create a Dockerfile to customize a Docker image and use an entrypoint script to run a command when the container starts, making it a reusable and executable unit for deploying and sharing applications.

</Card>

<Card href="/tutorials/introduction/containers/persist-data">
<Card href="/tutorials/introduction/containers/persist-data" horizontal>
## 📄️ Persist data outside of containers

Learn how to persist data outside of containers by creating named volumes, mounting volumes to data directories, and accessing persisted data from multiple container runs and removals in Docker.

</Card>

<Card href="/tutorials/introduction/containers/docker-commands">
<Card href="/tutorials/introduction/containers/docker-commands" horizontal>
## 📄️ Docker commands

Runpod enables BYOC development with Docker, providing a reference sheet for commonly used Docker commands, including login, images, containers, Dockerfile, volumes, network, and execute.
Expand Down
64 changes: 63 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
},
"background": {},
"styling": {
"css": "/style.css",
"codeblocks": {
"theme": {
"dark": "github-dark",
Expand Down Expand Up @@ -44,6 +45,55 @@
"get-started/mcp-servers"
]
},
{
"group": "Flash",
"pages": [
"flash/overview",
"flash/quickstart",
"flash/pricing",
"flash/create-endpoints",
"flash/custom-docker-images",
{
"group": "Configure resources",
"pages": [
"flash/configuration/storage",
"flash/configuration/gpu-types",
"flash/configuration/cpu-types",
"flash/configuration/parameters",
"flash/configuration/best-practices"
]
},
"flash/execution-model",
"flash/troubleshooting",
{
"group": "Build apps",
"pages": [
"flash/apps/overview",
"flash/apps/build-app",
"flash/apps/initialize-project",
"flash/apps/customize-app",
"flash/apps/local-testing",
"flash/apps/apps-and-environments",
"flash/apps/deploy-apps",
"flash/apps/requests"
]
},
{
"group": "CLI reference",
"pages": [
"flash/cli/overview",
"flash/cli/init",
"flash/cli/login",
"flash/cli/run",
"flash/cli/build",
"flash/cli/deploy",
"flash/cli/env",
"flash/cli/app",
"flash/cli/undeploy"
]
}
]
},
{
"group": "Serverless",
"pages": [
Expand Down Expand Up @@ -168,13 +218,13 @@
"pages": [
"public-endpoints/overview",
"public-endpoints/quickstart",
"public-endpoints/reference",
"public-endpoints/requests",
"public-endpoints/ai-sdk",
"public-endpoints/ai-coding-tools",
{
"group": "Models",
"pages": [
"public-endpoints/reference",
{
"group": "Image models",
"pages": [
Expand Down Expand Up @@ -358,6 +408,14 @@
"tutorials/serverless/run-gemma-7b"
]
},
{
"group": "Flash",
"pages": [
"tutorials/flash/text-generation-with-transformers",
"tutorials/flash/image-generation-with-sdxl",
"tutorials/flash/build-rest-api-with-load-balancer"
]
},
{
"group": "Pods",
"pages": [
Expand Down Expand Up @@ -823,6 +881,10 @@
{
"source": "/hub/public-endpoint-reference",
"destination": "/public-endpoints/reference"
},
{
"source": "/flash/endpoint-functions",
"destination": "/flash/create-endpoints"
}
]
}
158 changes: 158 additions & 0 deletions flash/apps/apps-and-environments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
---
title: "Apps and environments"
sidebarTitle: "Apps and environments"
description: "Understanding Flash's two-level deployment structure for organizing projects and managing deployments."
---

Flash uses a two-level organizational structure for deployments: **apps** and **environments**. Understanding this structure helps you organize projects, manage multiple deployment stages, and isolate resources effectively.

## Flash apps

A **Flash app** is a namespace on Runpod's backend that groups all resources for a single project. The app itself is just metadata—actual cloud resources (endpoints, volumes) are created when you deploy to an environment.

An app consists of:

- **App registry entry**: Metadata in Runpod's system (namespace, project identifier).
- **Environments**: Different deployment stages (dev, staging, production).
- **Builds**: Versioned tarball artifacts containing your code and dependencies.
- **Serverless endpoints**: Running infrastructure created per environment.

Apps are created automatically when you first run `flash deploy`, or explicitly with `flash app create <name>`.

### App hierarchy

<Tree>
<Tree.Folder name="Flash App (my-project)" defaultOpen>
<Tree.Folder name="Environments" defaultOpen>
<Tree.Folder name="dev" defaultOpen>
<Tree.Folder name="Endpoints" defaultClosed>
<Tree.File name="lb_worker" />
<Tree.File name="gpu_worker" />
<Tree.File name="cpu_worker" />
</Tree.Folder>
<Tree.Folder name="Volumes" defaultClosed>
<Tree.File name="model-cache" />
</Tree.Folder>
</Tree.Folder>
<Tree.Folder name="staging" defaultOpen>
<Tree.Folder name="Endpoints" defaultClosed>
<Tree.File name="lb_worker" />
<Tree.File name="gpu_worker" />
<Tree.File name="cpu_worker" />
</Tree.Folder>
<Tree.Folder name="Volumes" defaultClosed>
<Tree.File name="model-cache" />
</Tree.Folder>
</Tree.Folder>
<Tree.Folder name="production" defaultOpen>
<Tree.Folder name="Endpoints" defaultClosed>
<Tree.File name="lb_worker" />
<Tree.File name="gpu_worker" />
<Tree.File name="cpu_worker" />
</Tree.Folder>
<Tree.Folder name="Volumes" defaultClosed>
<Tree.File name="model-cache" />
</Tree.Folder>
</Tree.Folder>
</Tree.Folder>
<Tree.Folder name="Builds" defaultOpen>
<Tree.File name="build_v1" />
<Tree.File name="build_v2" />
<Tree.File name="build_v3" />
</Tree.Folder>
</Tree.Folder>
</Tree>


## Environments

An **environment** is an isolated deployment stage within a Flash app (e.g., `dev`, `staging`, `production`). Each environment has its own endpoints, build version, volumes, and deployment state. Environments are completely independent—deploying to `dev` has no effect on `production`.

An environment contains:

- **Deployed endpoints**: Serverless workers for your `@Endpoint` functions.
- **Build version**: The specific code version running in this environment.
- **Volumes**: Persistent storage attached to workers.
- **State**: Current deployment status (deploying, deployed, failed).

Environments are created automatically when you deploy with `--env <name>` or explicitly with `flash env create <name>`.

### Environment states

Environments can be in several states:

| State | Description |
|-------|-------------|
| `deploying` | Deployment in progress (building artifacts, provisioning endpoints) |
| `deployed` | Successfully deployed and running |
| `failed` | Deployment failed (check logs in the [Runpod console](https://www.runpod.io/console/serverless)) |
| `updating` | Configuration update in progress |

## Builds and deployments

When you run `flash deploy`, Flash creates and uploads a build artifact, then provisions endpoints:

### Build process

1. **Create tarball**: Flash packages your code into `.flash/artifact.tar.gz` containing:
- Worker Python files (`lb_worker.py`, `gpu_worker.py`, `cpu_worker.py`).
- Pre-installed dependencies (bundled during build).
- Deployment manifest (`flash_manifest.json`).
- Auto-generated handler code.

2. **Upload artifact**: The tarball is uploaded to Runpod's storage and associated with your app as a versioned "build".

3. **Provision endpoints**: For each resource configuration, Flash creates a Serverless endpoint that:
- Runs on pre-built Flash Docker images (`runpod/flash:latest` or `runpod/flash-cpu:latest`).
- Extracts your tarball and executes your code.
- Scales automatically based on load.

4. **Activate environment**: The environment is linked to the build and endpoints.

<Tip>
You're **not** building custom Docker images. Flash uses pre-built images that extract your tarball and run your code. This is why deployments are fast (no image build step) and limited to 500 MB (code and dependencies only).
</Tip>

## Common environment patterns

### Single environment (simple projects)

For small projects or solo development, use a single environment:

```bash
flash deploy --env production
```

All deployments go to `production`. Simple, but no testing isolation.

### Multiple environments (team projects)

For team projects, use separate environments for development, testing, and production:

```bash
flash deploy --env dev # Development and testing
flash deploy --env staging # QA and pre-production validation
flash deploy --env production # Live user-facing deployment
```

Each environment is completely isolated. Deploy to `dev` for testing, `staging` for QA approval, then `production` for users.

## Managing apps and environments

Use the CLI to manage your apps and environments:

```bash
# Apps
flash app list # List all apps
flash app get <name> # View app details
flash app delete <name> # Delete app and all environments

# Environments
flash env list # List environments in current app
flash env get <name> # View environment details
flash env delete <name> # Delete specific environment
```

<Warning>
Deleting an app or environment is irreversible. All endpoints and configuration are permanently removed.
</Warning>
Loading
Loading