Skip to content

docs: describe sdk runtime architecture #2

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

Closed
KAJdev wants to merge 3 commits into from
Closed

docs: describe sdk runtime architecture #2

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
276258f
docs: describe sdk runtime architecture
KAJdev Jul 27, 2026
670e4f8
docs: tighten runtime readme
KAJdev Jul 27, 2026
54213ce
Merge branch 'main' into docs/runtime-architecture
KAJdev Oct 20, 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
26 changes: 1 addition & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Runpod SDK Runtime

Worker runtime package and container images for apps built with the Runpod Python SDK.
The runtime has its own release cadence so worker fixes and image updates can ship
independently from SDK releases.

## Runtime images

Expand All @@ -20,8 +18,7 @@ packages excluded from GPU deployment artifacts.
| `runpod/task-gpu:py3.12-latest` | ephemeral GPU task pods |

Python 3.10 through 3.14 are published. Release tags use
`py<python>-<runtime-version>`, and `latest` tracks the newest release. Manual image
publishes support channels such as `dev`.
`py<python>-<runtime-version>`, and `latest` tracks the newest release.

## Package

Expand All @@ -38,27 +35,6 @@ python -m runpod_sdk_runtime.task.runner

`RUNPOD_RUNTIME_KIND` selects `queue` or `api` when running the shared bootstrap.

## Storage bindings

Apps provisioning supplies `RUNPOD_MOUNTS`, a JSON array of bindings with `kind`
(`network` or `global`), declared `reference`, resolved volume `id`, and absolute
`path`. Queue, API, and task workers install these before importing user code.
The compatible Apps SDK's `volume.path` uses this worker-level map; request
payloads cannot replace it. Missing configuration means no mounts; malformed
configuration fails startup.

## Task cleanup

Active background jobs and inline executions can run indefinitely, including
after the client disconnects. The watchdog checks for idle cleanup every 15
seconds. `RUNPOD_TASK_IDLE_TIMEOUT` (600 seconds by default) applies only to
pods waiting for submission or holding uncollected results.

Self-deletion requires `RUNPOD_API_KEY` and `RUNPOD_POD_ID`. The runtime exits
only after GraphQL acknowledges `podTerminate` without errors. Transient
failures receive three bounded attempts; any failed deletion leaves the runtime
alive for the next watchdog pass. Container exit alone does not stop pod billing.

## Development

Install the Apps SDK checkout first, then install this project:
Expand Down
Loading