05ab45225a
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Sandbox providers are the seam that lets agent runs execute in isolated environments; today the only first-party remote provider is Daytona, a hosted third-party service > - Self-hosters running Paperclip on their own infrastructure (often Kubernetes already) have no first-party way to run agent sandboxes on a cluster they control > - That gap matters for teams with data-residency, sovereignty, or cost constraints who cannot or will not send workloads to a hosted sandbox service > - This pull request adds a Kubernetes sandbox-provider plugin as a standalone, workspace-excluded package: it implements every SandboxProvider hook the Daytona provider does, on infrastructure the operator owns > - The benefit is that any Paperclip deployment with a Kubernetes cluster gets multi-tenant, network-isolated, quota-bounded agent sandboxes with zero new external dependencies ## Linked Issues or Issue Description No existing issue. Following the feature template: - **Problem:** Paperclip's remote sandbox execution requires a hosted third-party provider. Self-hosters cannot run agent sandboxes on their own Kubernetes clusters with a first-party provider. - **Proposed solution:** A `@paperclipai/plugin-kubernetes` sandbox-provider plugin with two backends: long-lived sandboxes via the [kubernetes-sigs/agent-sandbox](https://github.com/kubernetes-sigs/agent-sandbox) CRD (multi-command exec, adapter-install pattern) and one-shot `batch/v1` Jobs (stable APIs only, no extra controllers). - **Alternatives considered:** Driving kubectl from a generic shell provider (no lifecycle/lease semantics), or requiring a hosted provider (exactly the constraint this removes). ## What Changed This is **stage 1 of 3** of a staged contribution (direction agreed with maintainers): the plugin package alone. Stage 2 (server integration: lease params, provider registration) and stage 3 (agent runtime images + CI) are companion PRs that will be cross-linked from a comment here. - New package `packages/plugins/sandbox-providers/kubernetes` (workspace-excluded, like the path already carved out in `pnpm-workspace.yaml`): src, unit + kind integration tests, operator prerequisite manifests, README, smoke-test guide - Implements the full SandboxProvider hook surface the Daytona provider implements: `validateConfig`, `probe`, `acquireLease`, `resumeLease`, `releaseLease`, `destroyLease`, `realizeWorkspace`, `execute` - Two backends: `sandbox-cr` (default; long-lived pod via the agent-sandbox `Sandbox` CR, supports multi-command exec) and `job` (one-shot `batch/v1` Job; nothing beyond k8s 1.27+ required) - Per-run adapter resolution: one environment serves mixed harnesses; the per-run `adapterType` hint is read through a local optional type extension, so the plugin typechecks and builds against the current plugin SDK and simply falls back to the environment's configured default adapter until stage 2 lands - Exec-env wrapping: the Kubernetes exec API carries no environment, so commands are wrapped to receive the run's env - Fast-upload interception for workspace realization, scoped per lease - Per-tenant isolation: derived namespace per company, RBAC, ResourceQuota, restricted-PSS pod security (runAsNonRoot, drop ALL, seccomp RuntimeDefault, no SA token automount) - Network egress policy in two flavors: native `NetworkPolicy` and `CiliumNetworkPolicy` (FQDN allowlists) - Image allowlist with glob matching, registry override, and per-run image override validation - Per-run Kubernetes Secrets carrying agent credentials, ownerRef'd to the Job or Sandbox CR for cascade GC ## Verification - Standalone build, exactly as the README documents: ```bash cd packages/plugins/sandbox-providers/kubernetes pnpm install --ignore-workspace pnpm test # 147 unit tests, 17 files, all green pnpm typecheck # clean against the in-repo plugin SDK on master pnpm build # dist/ emitted, manifest + worker entrypoints present ``` - A kind-cluster end-to-end integration test is included (`RUN_K8S_INTEGRATION_TESTS=1 pnpm test test/integration/end-to-end-run.test.ts`) - Beyond CI: this provider has been verified in a production multi-tenant deployment against five harnesses (opencode, pi, codex, gemini, claude code) with real billed runs ## Risks - **Zero behavior change for any existing deployment.** The package is workspace-excluded; nothing in the server imports or loads it until stage 2's integration lands. No existing code paths are touched. - The default `sandbox-cr` backend depends on an alpha CRD (`agents.x-k8s.io/v1alpha1`); the README flags this and the `job` backend uses only stable APIs as a fallback. - Risk surface is confined to deployments that explicitly install and configure the plugin. - The default runtime images (`ghcr.io/paperclipai/agent-runtime-*`) are published by the stage 3 companion PR (#7934); until that lands, deployments must point `runtimeImage` at their own images. ## Model Used Claude Opus 4.8 (1M context), extended thinking, with tool use (Claude Code). ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots (no UI changes) - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green (pending this push) - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
96 lines
4.1 KiB
TypeScript
96 lines
4.1 KiB
TypeScript
import { describe, it, expect } from "vitest";
|
|
import { buildJobManifest } from "../../src/pod-spec-builder.js";
|
|
|
|
const baseInput = {
|
|
namespace: "paperclip-acme",
|
|
jobName: "r-01h00000000000000000000000",
|
|
adapterType: "claude_local",
|
|
image: "ghcr.io/paperclipai/agent-runtime-claude:v1",
|
|
envSecretName: "r-01h00000000000000000000000-env",
|
|
serviceAccountName: "paperclip-tenant-sa",
|
|
labels: { "paperclip.io/run-id": "r1" },
|
|
resources: { requests: { cpu: "250m", memory: "512Mi" }, limits: { cpu: "2", memory: "4Gi" } },
|
|
runtimeClassName: undefined,
|
|
activeDeadlineSec: 3600,
|
|
ttlSecondsAfterFinished: 900,
|
|
};
|
|
|
|
describe("buildJobManifest", () => {
|
|
it("returns a Job manifest with the correct apiVersion and kind", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
expect(job.apiVersion).toBe("batch/v1");
|
|
expect(job.kind).toBe("Job");
|
|
});
|
|
|
|
it("sets Job-level lifecycle controls: backoffLimit=0, ttlSecondsAfterFinished, activeDeadlineSeconds", () => {
|
|
const job = buildJobManifest({ ...baseInput, activeDeadlineSec: 1800, ttlSecondsAfterFinished: 600 });
|
|
expect(job.spec.backoffLimit).toBe(0);
|
|
expect(job.spec.ttlSecondsAfterFinished).toBe(600);
|
|
expect(job.spec.activeDeadlineSeconds).toBe(1800);
|
|
});
|
|
|
|
it("sets the security context to non-root, drop ALL caps, read-only rootFS, seccomp RuntimeDefault", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
const podSec = job.spec.template.spec.securityContext;
|
|
expect(podSec.runAsNonRoot).toBe(true);
|
|
expect(podSec.runAsUser).toBe(1000);
|
|
expect(podSec.fsGroupChangePolicy).toBe("OnRootMismatch");
|
|
expect(podSec.seccompProfile.type).toBe("RuntimeDefault");
|
|
|
|
const container = job.spec.template.spec.containers[0];
|
|
expect(container.securityContext.runAsNonRoot).toBe(true);
|
|
expect(container.securityContext.readOnlyRootFilesystem).toBe(true);
|
|
expect(container.securityContext.allowPrivilegeEscalation).toBe(false);
|
|
expect(container.securityContext.capabilities.drop).toEqual(["ALL"]);
|
|
});
|
|
|
|
it("wraps the entrypoint in tini for PID 1", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
const container = job.spec.template.spec.containers[0];
|
|
expect(container.command).toEqual(["/usr/bin/tini", "--", "/usr/local/bin/paperclip-agent-shim"]);
|
|
});
|
|
|
|
it("declares explicit writable emptyDir mounts for the standard agent paths", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
const mounts = job.spec.template.spec.containers[0].volumeMounts;
|
|
const mountPaths = mounts.map((m: { mountPath: string }) => m.mountPath).sort();
|
|
expect(mountPaths).toEqual(["/home/paperclip", "/home/paperclip/.cache", "/tmp", "/workspace"]);
|
|
|
|
const volumes = job.spec.template.spec.volumes;
|
|
expect(volumes.every((v: { emptyDir?: unknown }) => v.emptyDir !== undefined)).toBe(true);
|
|
});
|
|
|
|
it("envFrom references the per-run secret", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
const envFrom = job.spec.template.spec.containers[0].envFrom;
|
|
expect(envFrom[0].secretRef.name).toBe(baseInput.envSecretName);
|
|
});
|
|
|
|
it("applies runtimeClassName when set", () => {
|
|
const job = buildJobManifest({ ...baseInput, runtimeClassName: "kata-fc" });
|
|
expect(job.spec.template.spec.runtimeClassName).toBe("kata-fc");
|
|
});
|
|
|
|
it("does not set runtimeClassName when unset", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
expect(job.spec.template.spec.runtimeClassName).toBeUndefined();
|
|
});
|
|
|
|
it("sets pod restartPolicy=Never (required for Job)", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
expect(job.spec.template.spec.restartPolicy).toBe("Never");
|
|
});
|
|
|
|
it("disables automountServiceAccountToken to avoid exposing an unnecessary SA token", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
expect(job.spec.template.spec.automountServiceAccountToken).toBe(false);
|
|
});
|
|
|
|
it("applies the provided labels to both Job metadata and pod template", () => {
|
|
const job = buildJobManifest(baseInput);
|
|
expect(job.metadata.labels["paperclip.io/run-id"]).toBe("r1");
|
|
expect(job.spec.template.metadata.labels["paperclip.io/run-id"]).toBe("r1");
|
|
expect(job.spec.template.metadata.labels["paperclip.io/role"]).toBe("agent");
|
|
});
|
|
});
|