A managed runner is the CoreWeave-managed component that runs sandboxes inside your CKS cluster. This page covers the full lifecycle: register a runner, confirm it is healthy, adjust its configuration as your needs change, and remove it when you no longer need it.Documentation Index
Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
Use this file to discover all available pages before exploring further.
CoreWeave sandboxes are in public preview. For access, contact your CoreWeave account team, reach out to CoreWeave Support, or email support@coreweave.com.
Before you begin
Both the CLI and the curl examples on this page authenticate with a CoreWeave API access token. Generate one from the Tokens page in the cloud console and copy the Token Secret value. For more on tokens, see Manage API Access Tokens. CLI: install the CoreWeave Intelligent CLI (cwic), then run cwic auth login and paste the token when prompted. The token is stored in your local cwic config; subsequent commands read it automatically. There is no environment variable to set.
Runner commands
Thecwic sandbox runner group manages runners.
| Goal | Command |
|---|---|
| Create a runner (wizard) | cwic sandbox runner create [RUNNER-ID] |
| Create a runner from a file | cwic sandbox runner create [RUNNER-ID] -f runner.yaml |
| List runners | cwic sandbox runner get (alias ls) |
| Inspect one runner | cwic sandbox runner get [RUNNER-ID] |
| Detailed view | cwic sandbox runner describe [RUNNER-ID] |
| Edit a runner | cwic sandbox runner edit [RUNNER-ID] |
| Apply an available update | cwic sandbox runner upgrade [RUNNER-ID] |
| Delete a runner | cwic sandbox runner delete [RUNNER-ID] |
Create a runner
Each CKS cluster hosts at most one managed runner. On create you must supply:- Runner ID: a client-assigned human-readable ID, unique within your organization.
- Zone: the geographic zone the cluster belongs to.
- Cluster ID (or cluster name): which CKS cluster the runner runs on. You can find both on the Clusters page in the cloud console.
- Profile bindings: at least one binding, with exactly one default. The profile referenced in each binding must already exist.
- CLI
- curl
The wizard collects cluster, profiles, release channel, and maintenance windows interactively, then opens your editor with a pre-filled spec before submitting:File mode accepts YAML or JSON, which makes it the preferred path for repeatable setups and a natural interface for agents like Claude Code or Codex that generate runner specs on your behalf (the CLI also reads from stdin with Submit the spec:
-f -):runner.yaml
maintenance_policy.windowsis optional. When set, automatic updates apply only during the specified cron windows.runner_group_idis optional and is used for scheduling affinity when you have multiple runners in the same zone.
Common validation errors
| Error | Fix |
|---|---|
runner.identity.zone is required | Supply a zone. Find zones where you have a CKS cluster (and therefore quota for a runner) on the Clusters page in the cloud console, or by running cwic cluster get. |
runner.identity.cluster_id or cluster_name is required | Supply one. You can find both on the Clusters page in the cloud console, or by running cwic cluster get. |
one or more profile_bindings reference a template that does not exist | Create the profile first, or double-check the ID by running cwic sandbox profile get [PROFILE-ID] (or cwic sandbox profile get with no args to list all profiles). |
runner cannot have more than one default profile binding | Exactly one binding must be the default. |
a managed runner already exists for this cluster | A cluster hosts at most one managed runner. Update the existing one, or delete it first. |
Check runner status
After creation, check the runner’s status to confirm it rolled out successfully and to diagnose problems if it didn’t.- CLI
- curl
get:prod-us-east-1) or the server-assigned UUID.installStatus: progress of the runner deployment into your cluster (PENDING,PROVISIONING,READY, orFAILED).connectionStatus: live connectivity (CONNECTEDorDISCONNECTED). The runner’s heartbeat updates this value. Expect up to 30 seconds of lag.
installStatus == FAILED, the response includes a structured installError:
remediationHints are the actions you should take. diagnosticDetail also contains internal logs that are useful to attach if you open a support ticket.
Update a runner
The runner edit command supports both an interactive wizard and a file-driven patch. Under the hood, updates use a field mask: only the fields you change are applied. Everything else (installStatus, connectionStatus, timestamps, and the resolved deployment spec) is read-only.
The following paths are mutable:
identity.zoneidentity.runner_group_idmanaged_spec(whole object)managed_spec.release_channelmanaged_spec.maintenance_policymanaged_spec.overridesprofile_bindings(whole list)
Common runner updates
Example: switch release channel
- CLI
- curl
Apply a one-line patch from stdin:Or write the patch to a file and submit it:
patch.yaml
Example: attach a second profile
profile_bindings is replaced as a whole list. To attach a new profile while you preserve the existing default, send both bindings:
- CLI
- curl
bindings.yaml
profile_template_id. Missing entries are detached, new entries are attached, and changed entries are updated in place, all in one transaction.
Example: pin node placement through deployment overrides
Themanaged_spec.overrides field tunes the runner’s own pod, not sandbox pods. Use it when the runner needs specific tolerations, node selectors, or runtime classes to land on the right nodes.
A common case is routing the runner pod through the SUNK Pod Scheduler so it can run in your SUNK cluster alongside Slurm jobs. Set the scheduler name and the SUNK annotations on the runner overrides; see SUNK Pod Scheduler integration for the available annotations and required setup.
- CLI
- curl
overrides.yaml
Trigger an on-demand runner update
WhenupdateAvailable is true on the runner, you can apply the update immediately rather than wait for the next maintenance window:
- CLI
- curl
target_revision. The in-cluster controller rolls it out.
List runners
- CLI
- curl
Delete a runner
- CLI
- curl
--yes to skip the prompt for scripted use:See also
- Configure a sandbox profile: cwic workflow plus field-by-field walkthrough of the profile spec.
- Profile reference: every field you can set on a profile.