k8s-agent-sandbox-awx
A broker-backed, kubeconfig-free overlay for the Agentic Sandbox client. It
adds a BrokerSandboxClient that drives the sandbox control plane (create → wait
ready → terminate, commands, and files) through one identity broker service over
HTTPS instead of the Kubernetes API or a public router. The broker proxies
authorized data operations to its internal router, so client applications need
no kubeconfig and no direct Kubernetes or router access.
pip install k8s-agent-sandbox-awx==0.5.2
from k8s_agent_sandbox_awx import Sandbox
sandbox = Sandbox.create(keepalive_ttl_seconds=0)
result = sandbox.commands.run('echo "Hello from Agent Sandbox!"')
print(result.stdout)
# Leave it available until its timeout; call sandbox.kill() for early cleanup.
How it works
The client presents an audience-bound Kubernetes or GitLab OIDC token to the broker.
The broker cryptographically verifies the caller from that token, creates the
SandboxClaim under its own identity, and stamps the verified caller identity
onto the claim — attribution the client cannot forge.
Set both broker_url and api_url to the broker URL. The model rejects a
different api_url to prevent accidental direct-router bypass.
This package is a purely additive overlay: it builds on
k8s-agent-sandbox-base (a
seamed re-publish of the upstream client) and edits zero upstream files. The import
package is k8s_agent_sandbox_awx.
Configuration
The zero-argument API reads:
| Variable | Purpose |
|---|---|
AGENT_SANDBOX_BROKER_URL |
Public HTTPS broker endpoint |
AGENT_SANDBOX_TOKEN_PATH |
Rotating Kubernetes projected-token file |
AGENT_SANDBOX_TOKEN |
GitLab or other OIDC ID token |
AGENT_SANDBOX_WARMPOOL |
Approved warm pool; defaults to python-sandbox-warmpool |
AGENT_SANDBOX_NAMESPACE |
Broker-owned claim namespace; defaults to agent-sandbox |
AGENT_SANDBOX_TTL_SECONDS |
Sandbox timeout in seconds; defaults to 300 |
AGENT_SANDBOX_KEEPALIVE_TTL_SECONDS |
Opt-in activity timeout reset; defaults to 0 (disabled) |
Timeouts
Sandbox.create() defaults to 300 seconds (five minutes). An explicit
shutdown_after_seconds overrides AGENT_SANDBOX_TTL_SECONDS (or legacy
SANDBOX_TTL_SECONDS), which overrides that default. Values must be positive.
Commands do not reset the deadline unless keepalive is explicitly enabled.
sandbox.set_timeout(600) resets it to ten minutes from the call and can shorten
or extend it. The broker enforces its hard lifetime from the original claim
creation time (24 hours in US nonprod); extensions cannot reset that cap, and
caller policy may impose a shorter per-request maximum.
Plain assignment leaves the sandbox running after the script exits.
with Sandbox.create() as sandbox: and sandbox.kill() intentionally delete
it immediately. Job ttlSecondsAfterFinished cleans the caller Job/Pod, not the
sandbox. A replacement caller Pod cannot take ownership of the previous Pod's
claim merely by using the same ServiceAccount.
These defaults apply to SDK 0.5.2. When using older 0.5.0, the broker
supplies the five-minute default, but pass keepalive_ttl_seconds=0 explicitly
for fixed-deadline behavior.
Kubernetes normally needs no Python authentication code:
from k8s_agent_sandbox_awx import Sandbox
with Sandbox.create() as sandbox:
print(sandbox.commands.run("python3 -c 'print(6 * 7)'").stdout)
Mount a projected ServiceAccount token at the configured path with its
audience set to the broker URL. The file is re-read on every request so token
rotation is honored.
Cleanup activity
If sandbox creation or readiness fails, upstream attempts a cleanup delete.
The broker overlay marks that delete with request_purpose: create_cleanup;
normal explicit deletes are not marked. This is diagnostic client intent only
and never bypasses admission, action-policy or ownership checks. Broker
v0.10.2 and the console can distinguish create, delete and SDK-reported cleanup
even when caller admission fails. Older records cannot be retroactively labeled.
SDK 0.5.2 includes this cleanup attribution; older 0.5.0 does not.
GitLab supplies the same zero-argument API using a native ID token:
job:
id_tokens:
AGENT_SANDBOX_TOKEN:
aud: https://sandbox-broker.example
variables:
AGENT_SANDBOX_BROKER_URL: https://sandbox-broker.example
script:
- python app.py
Explicit authentication objects are available when environment discovery is not appropriate:
from k8s_agent_sandbox_awx import KubernetesAuth, OIDCTokenAuth, Sandbox
k8s = Sandbox.create(auth=KubernetesAuth("/var/run/secrets/tokens/broker"))
ci = Sandbox.create(auth=OIDCTokenAuth.from_env("MY_ID_TOKEN"))
The SDK deliberately has no provider="gitlab" or provider="kubernetes"
switch. It transports the token; the broker derives the provider from the
verified issuer and applies the matching policy.
Requirements
- A deployed identity broker service reachable over HTTPS.
- An OIDC token whose audience matches the broker's. Kubernetes projected tokens
and GitLab
id_tokens:are supported by the broker policy. k8s-agent-sandbox-base(installed automatically as a dependency).
License
Apache-2.0 — see LICENSE.
Metadata
Release files for k8s-agent-sandbox-awx 0.5.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| k8s_agent_sandbox_awx-0.5.2.tar.gz | 28.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| k8s_agent_sandbox_awx-0.5.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 52.4 kB
Release files / k8s_agent_sandbox_awx-0.5.2.tar.gz
| Download URL | k8s_agent_sandbox_awx-0.5.2.tar.gz |
|---|---|
| Size | 28.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
65d0ed6f0fcc44394bfbde773d75e55ec0d22efb6423f10ff72b1c8857293b48
|
|
BLAKE2b-256 checksum How to use checksums |
58a0c3bb71cc64fbf0550745f35966b9952dbb921e9b0f6d2c97990ca788155f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.2
|
Release files / k8s_agent_sandbox_awx-0.5.2-py3-none-any.whl
| Download URL | k8s_agent_sandbox_awx-0.5.2-py3-none-any.whl |
|---|---|
| Size | 23.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
99e6c3b897a282d28ade356d8b628bf69f6e3c7abe4dff9afe2a855b77bc9d38
|
|
BLAKE2b-256 checksum How to use checksums |
bfa26fd9f92c8ce857a83f2511296465f74f460e236060d35d832fcc14091fad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.2
|