Skip to content

Commit 286ec5a

Browse files
jasonkeungoz-agentliliwilson
authored
Clarify self-hosted task images (#146)
* Clarify self-hosted task images Explain that custom dependencies belong in the cloud agent task image, not the Warp-managed sidecar/runtime image, and clarify Kubernetes default_image usage. Co-Authored-By: Oz <oz-agent@warp.dev> * Update src/content/docs/agent-platform/cloud-agents/environments.mdx Co-authored-by: Lili Wilson <56806227+liliwilson@users.noreply.github.com> * Apply suggestion from @liliwilson Co-authored-by: Lili Wilson <56806227+liliwilson@users.noreply.github.com> --------- Co-authored-by: Oz <oz-agent@warp.dev> Co-authored-by: Lili Wilson <56806227+liliwilson@users.noreply.github.com>
1 parent e7b37d7 commit 286ec5a

3 files changed

Lines changed: 5 additions & 3 deletions

File tree

src/content/docs/agent-platform/cloud-agents/environments.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,12 @@ Environments define _how_ an agent runs, not _what_ it does. They're required fo
3333

3434
An environment typically includes:
3535

36-
* **Docker image (required)** – The toolchain and runtime the agent runs with. For self-hosted Kubernetes workers, a [`default_image`](/agent-platform/cloud-agents/self-hosting/managed-kubernetes/) on the worker lets you skip creating an environment entirely.
36+
* **Docker image (required)** – The task/workspace image with the toolchain and dependencies your code needs. For self-hosted Kubernetes workers, a [`default_image`](/agent-platform/cloud-agents/self-hosting/managed-kubernetes/) on the worker lets you skip creating an environment entirely.
3737
* **Repository/workspace** – One or more repos the agent can clone and operate on.
3838
* **Setup commands** – Commands to prepare the workspace (e.g., dependency install, builds, bootstrapping).
3939

40+
Use the Docker image for language runtimes, package managers, system libraries, and scripts needed by your project. Custom images do not need to handle installing the Warp CLI binary; Warp supplies the agent runtime separately. You can start from an official image or one of Warp's [prebuilt dev images](https://github.com/warpdotdev/oz-dev-environments).
41+
4042
:::note
4143
Configuring runtime settings:
4244

src/content/docs/agent-platform/cloud-agents/self-hosting/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ When creating a run, schedule, or integration in the [Oz web app](https://oz.war
181181

182182
Self-hosted workers fully support [environments](/agent-platform/cloud-agents/environments/). When a task specifies an environment, the worker resolves the Docker image, clones the repositories, runs setup commands, and executes the agent inside the prepared container or Kubernetes Job.
183183

184-
The same environment can be used for both Warp-hosted and self-hosted runs without modification. See [Environments](/agent-platform/cloud-agents/environments/) for details on creating and configuring them.
184+
The same environment can be used for both Warp-hosted and self-hosted runs without modification. If your agents need custom tools, binaries, scripts, or system packages, add them to the environment's Docker image. See [Environments](/agent-platform/cloud-agents/environments/) for details on creating and configuring custom images.
185185

186186
:::note
187187
With the Kubernetes backend, setting a [`default_image`](/agent-platform/cloud-agents/self-hosting/reference/#kubernetes-backend-config) on the worker lets you skip creating a Warp environment when all your tasks use the same base image.

src/content/docs/agent-platform/cloud-agents/self-hosting/managed-kubernetes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ To scale horizontally, deploy multiple Helm releases with distinct worker IDs ra
123123
**Kubernetes backend:**
124124

125125
* `kubernetesBackend.namespace` — Namespace for task Jobs. Defaults to the release namespace.
126-
* `kubernetesBackend.defaultImage` — Default Docker image for task pods when the run has no Warp environment image. Leave empty (default) to fall back to `ubuntu:22.04`.
126+
* `kubernetesBackend.defaultImage` — Default Docker image for task pods when no [Warp environment](/agent-platform/cloud-agents/environments/) has been supplied. Leave empty (default) to fall back to `ubuntu:22.04`.
127127
* `kubernetesBackend.imagePullPolicy` — Image pull policy for task pods. Defaults to `IfNotPresent`.
128128
* `kubernetesBackend.preflightImage` — Image for the startup preflight Job. Set this if your cluster restricts allowed registries.
129129
* `kubernetesBackend.unschedulableTimeout` — How long a pod may remain unschedulable before failing. Defaults to `30s`.

0 commit comments

Comments
 (0)