This release is a pre-release and may not be stable for production use.
AKernel Python SDK
akernel-sdk is the Python interface for creating and managing remote AKernel
sandboxes. Applications use one stable API for commands, files, interactive
PTYs, port forwarding, and reverse tunnels.
Navigation
- AKernel Python SDK
- Navigation
- Install and configure
- Create a sandbox
- Sandbox runtimes
- Commands
- Filesystem
- Interactive PTYs
- Port forwarding
- Lifecycle compatibility
- Reusable snapshots
- Local failover and reload
- Reverse tunnels
- Rootfs and mounts
- Launch from a Dockerfile
- Resources and lifecycle
- CLI
- Examples and tests
- Public value types
Install and configure
AKernel SDK requires Python 3.10 or newer.
This guide describes the SDK at the selected source revision or release tag. For package installations, read the guide at the corresponding release tag and consult the release notes for version-specific feature availability and changes.
Install the stable SDK from PyPI:
python -m pip install akernel-sdk
To include published release candidates:
python -m pip install --pre akernel-sdk
Choose an SDK version compatible with the deployed backend and pin its exact published version for reproducible installations. To install from source, pin the tested commit and run from the repository root:
python -m pip install ./sdk/python
For source builds, record the commit and artifact digest as well as the package version; version metadata alone may not identify unpublished source changes.
The SDK's ADX dependency is declared in pyproject.toml.
The ADX adapter translates the public AKernel Sandbox API
to adx_environment.Environment. Deploy a matching ADX release exposing
/api/environment/v1 for lifecycle, resources and command subscriptions.
Source installs and CI resolve the declared ADX dependency from the package index.
CI checks AKernel wheel and source distribution installs in separate clean
environments, including pip check, imports, version checks, and the ak CLI.
Configure the public AKernel entrypoint and the deployment token:
export AKERNEL_SERVER_ADDRESS="akernel.example.com"
export AKERNEL_TOKEN="<token>"
Address behavior is deterministic:
- A host or IP without a port uses HTTPS/WSS on 443 for the frontend and HTTP on 80 for public sandbox port URLs.
host:portpreserves shared-port behavior: control uses HTTPS/WSS and public sandbox URLs use HTTP/WS on that explicit port.AKERNEL_GATEWAY_ADDRESSoverrides only the port-forwarding and reverse tunnel data endpoint for nonstandard ports or TLS gateways. An override without a scheme uses HTTP/WS. Scheme-qualified overrides without a port use 443 for HTTPS/WSS and 80 for HTTP/WS; an explicit port is preserved. Exec and file transfer continue to useAKERNEL_SERVER_ADDRESS.
TLS certificate verification
AKERNEL_VERIFY_TLS controls certificate-chain and hostname verification for
the SDK's HTTPS control, command and file requests, command-watch WebSockets,
PTYs, CLI inventory/deletion and resource queries. It defaults to 0 to retain
the current self-signed deployment behavior. HTTPS still encrypts the connection
with this default, but does not authenticate the server certificate.
For an entrypoint with a certificate trusted by the default certificate stores:
export AKERNEL_VERIFY_TLS=1
For a private CA or a standalone self-signed certificate, additionally configure the trusted PEM bundle before the first SDK operation:
export AKERNEL_VERIFY_TLS=1
export SSL_CERT_FILE="/path/to/trusted-ca-or-certificate.pem"
The standalone operator can provide the existing
<data-directory>/adx/tls/ingress-public.pem file. For Kubernetes, the operator
can provide public.pem from the configured ADX TLS Secret. This is public
certificate material; clients do not need the server's private key or the
administrator API key to establish certificate trust. Use the hostname or IP
listed in the certificate's subject alternative names. The default standalone
certificate covers localhost and 127.0.0.1; replace it with a certificate
matching the public hostname for remote access.
The CLI accepts global options before the subcommand:
ak --verify-tls list
ak --ca-file /path/to/trusted-ca-or-certificate.pem resources
ak --ca-file /path/to/trusted-ca-or-certificate.pem exec <sandbox-id>
--ca-file configures SSL_CERT_FILE and enables verification. The explicit
--no-verify-tls option selects the existing unverified mode and cannot be
combined with --ca-file. Environment boolean values accept 1/true/yes/on
and 0/false/no/off; invalid values fail rather than disabling verification.
CA loading follows the underlying transport when verification is enabled:
| Transport | Trust-source contract |
|---|---|
| SDK control, command and file HTTP requests (HTTPX) | A nonempty SSL_CERT_FILE takes precedence over SSL_CERT_DIR and is loaded explicitly. A missing or malformed file raises an error during client construction, even if the directory contains a usable CA. If no file is selected, HTTPX uses SSL_CERT_DIR when set, otherwise its default CA bundle. |
| CLI inventory/deletion, SDK resource queries, PTY and command-watch (Python SSL/OpenSSL) | Use OpenSSL's default trust paths, including SSL_CERT_FILE and SSL_CERT_DIR. A missing or malformed file can be ignored while a usable CA directory still validates the server. |
--ca-file sets the process trust-file variable; it does not restrict all
transports to that file as their sole trust source or guarantee an error for
an invalid path. Check the selected PEM file before use. For a private CA,
configure a valid file and unset SSL_CERT_DIR to avoid an additional
environment-selected directory; OpenSSL can still use its default trust paths.
These loading differences do not disable certificate-chain or hostname checks
in verified mode. When verification is off, these service transports do not
load the CA sources to authenticate the server.
Verification failures do not fall back to unverified TLS. The process backend and dependency HTTP pools retain their configuration, so set trust and verification before first use; restart the client after changing CA material.
Certificate issuance and renewal remain deployment responsibilities. Registry TLS, reverse-tunnel upstream HTTPS trust and SSH host keys have separate configuration; this setting controls the AKernel service connection.
Create a sandbox
from akernel_sdk import Sandbox
with Sandbox(cpu=1000, memory=2048) as sandbox:
result = sandbox.commands.run("printf hello")
print(result.stdout)
The constructor accepts:
Sandbox(
image: str | None = None,
rootfs: S3Config | None = None,
runtime: str = "runsc",
cpu: int = 1000,
memory: int = 4096,
cpu_limit: int = 0,
mem_limit: int = 0,
idle_timeout: int = 300,
schedule_timeout: int = 30,
env: dict[str, str] | None = None,
name: str | None = None,
cwd: str | None = None,
port_forwardings: list[int] | None = None,
mounts: list[Mount] | None = None,
reverse_tunnel: HttpReverseTunnel | None = None,
detached: bool = False,
node_id: str | None = None,
*,
xpu: str | None = None,
storage_mb: int | None = None,
storage_limit_mb: int = 0,
network_policy: NetworkPolicy | None = None,
dockerfile: DockerfileLaunch | None = None,
extra_config: Mapping[str, object] | None = None,
)
Experimental GPU and writable storage
Request a whole NVIDIA GPU by type, exact product model, and count:
with Sandbox(xpu="gpu:l20:1") as sandbox:
print(sandbox.commands.run("nvidia-smi -L").stdout)
The type:model:count value is case-insensitive and canonicalized to lower
case. The model is required and matched exactly; wildcard models are not
supported. The bundled backend currently requires the gVisor runsc runtime
and a node configured for gVisor nvproxy. Runtime compatibility is validated
by the backend rather than the SDK.
Set the storage scheduling quota and actual writable root filesystem hard limit in MiB:
with Sandbox(storage_mb=4 * 1024, storage_limit_mb=20 * 1024) as sandbox:
print(sandbox.commands.run("df -h /").stdout)
storage_mb is the scheduling quota: the storage amount reserved when placing
the sandbox. storage_limit_mb is the actual hard limit on writable-root
capacity. In this example, scheduling reserves 4 GiB while the writable root
can grow up to 20 GiB. Reserving less than the hard limit permits storage
overcommit; the limit does not guarantee that the node has enough physical
space for all sandboxes to reach their limits simultaneously.
storage_limit_mb=0 follows storage_mb, or the cluster default when the
scheduling quota is omitted. If only a positive limit is given, the backend
also reserves that amount for scheduling. A positive limit must be at least
the explicit scheduling quota. Limits must be nonnegative integers; booleans
are rejected.
Explicit writable storage quotas are supported by runsc and Firecracker
and use sandboxd's disk-backed filestore (ext4 in the bundled standalone
deployment, XFS in the Terraform-managed Aliyun profile). Runtime compatibility
is validated by the backend. If storage_limit_mb is not supported by the
selected backend, a nonzero value fails explicitly. See
examples/gpu_sandbox.py and
examples/storage_sandbox.py.
Network ACLs
Omit network_policy to leave all sandbox networking unrestricted. An empty
NetworkPolicy() is equivalent and is omitted from the creation request:
from akernel_sdk import NetworkPolicy, Sandbox
with Sandbox() as unrestricted:
print(unrestricted.commands.run("python3 -c 'import socket; "
"socket.getaddrinfo(\"github.com\", 443)'"))
Block new sandbox flows except the YuanRong control proxy and published sandbox-port routes with the compatibility helper:
with Sandbox(network_policy=NetworkPolicy.block()) as sandbox:
result = sandbox.commands.run("printf 'control plane still works'")
assert result.exit_code == 0
Commands and lifecycle operations continue to work in block mode. The policy
also publishes the sandbox targets required by direct filesystem I/O, reverse
tunnels, and explicit port_forwardings. Replies on those allowed paths are
stateful. Other new network flows remain denied.
Deny conventional DNS lookups for exact names or leading *. suffix
patterns:
policy = NetworkPolicy.deny_dns("github.com", "*.github.com")
with Sandbox(network_policy=policy) as sandbox:
blocked = sandbox.commands.run(
"python3 -c 'import socket; socket.getaddrinfo(\"github.com\", 443)'"
)
assert blocked.exit_code != 0
An exact pattern matches only that name. For example, github.com does not
match api.github.com, while *.github.com matches descendants but not
the apex. Supply both when both should be denied. Patterns are normalized to
lower-case ASCII without a trailing dot; international names are converted to
punycode. Each pattern may be an exact name or begin with one leading
*.. The remaining name is at most 253 characters; each dot-separated label
is 1-63 letters, digits, underscores, or hyphens, and a hyphen cannot start or
end a label. Other wildcard placements and ? are rejected.
Create an egress allowlist with the high-level helper. Rules may select an IPv4 address or CIDR, an exact or leading-wildcard DNS name, TCP or UDP peer ports, and a priority:
from akernel_sdk import NetworkRule, PortRange
policy = NetworkPolicy.allowlist(
[
NetworkRule(
domain="*.example.com",
protocol="tcp",
port_range=PortRange(443),
priority=200,
),
NetworkRule(
cidr="192.0.2.10",
protocol="tcp",
port_range=PortRange(8000, 8010),
),
]
)
with Sandbox(network_policy=policy) as sandbox:
print(sandbox.commands.run("curl https://api.example.com").stdout)
Replace the complete policy of a running sandbox atomically with
update_network_policy. Passing None or an empty NetworkPolicy()
clears the policy and restores unrestricted networking:
with Sandbox() as sandbox:
sandbox.update_network_policy(NetworkPolicy.block())
sandbox.update_network_policy(
NetworkPolicy.deny_dns("github.com", "*.github.com")
)
sandbox.update_network_policy(None)
The desired policy survives sandboxd restarts, explicit reloads, and same-node failover. Dynamic replacement is supported by the default bundled backend.
For independent ingress and egress defaults, deny rules, sandbox-side port
ranges, DNS allowlists, or stateless matching, construct the schema v2 model
directly with TrafficPolicy, NetworkRule, DNSPolicy, and DNSRule.
Traffic rules are evaluated by highest priority first; an equal-priority deny
wins. Stateful mode is the default and permits reply traffic. Priority
4294967295 is reserved for control-plane and published-port rules, so user
priorities are limited to 1..4294967294.
In stateless mode, a protected published-port rule covers ingress only; add an
explicit egress rule for the matching sandbox source port when the application
must send a reply. This avoids turning a published port into an unrestricted
egress escape hatch.
Domain traffic rules authorize IPv4 addresses learned from an allowed original DNS query, following its complete CNAME chain. The authorization uses the answer TTL, clamped to 1..3600 seconds, and is replaced when the name is resolved again with an IPv4 A or ANY query. Existing connections that depended on an expired or replaced authorization are removed. Parallel AAAA queries do not revoke IPv4 grants. DNS names not covered by a domain traffic rule can still resolve when the DNS policy allows the query, but their answers do not grant packet access. While a DNS policy or domain traffic rule is active, ordinary TCP and UDP DNS is accepted only through sandboxd's managed resolver; a traffic rule for another port-53 resolver does not bypass it. The resulting enforcement is at IPv4 and transport layers. Another virtual host sharing an authorized address and port is not distinguishable; use an application proxy when hostname-level isolation is required.
Network policy replacement uses whole-policy semantics. The legacy
block_network and dns_blacklist fields cannot be combined with schema v2
sections. DNS policies cover ordinary UDP and TCP DNS and return a refused
response for denied queries; DNS-over-HTTPS and connections to a known IP are
outside DNS filtering. Packet rules are IPv4. sandboxd accepts 256 combined
traffic rules; the backend reserves entries from that limit for the Function
Proxy and each distinct published sandbox port. IPv6 traffic is dropped
whenever a traffic or DNS policy is active, preventing an alternate resolver
from bypassing the IPv4 policy. Arbitrary non-IP Ethernet protocols are
outside the portable ACL contract. Domain and DNS patterns are normalized
through IDNA.
See examples/network_policy.py for the
compatibility modes and generic allowlist. Deployment nodes must have network
ACL support enabled; the bundled standalone, Helm, and Terraform
configurations enable it. Drain existing sandboxes before upgrading a node to
an ACL-enabled sandboxd configuration, as described in the
deployment guide.
Sandbox runtimes
AKernel uses the gVisor runsc runtime when runtime is omitted. Runtime
identifiers and optional extra_config are forwarded to the selected backend
instead of being restricted or interpreted by an SDK-owned registry. Values in
extra_config must be JSON-compatible. The bundled deployment advertises
runsc, Kata Containers, and Firecracker by default when their host
prerequisites are available.
Kata and Firecracker require at least one cluster node whose sandboxd instance
successfully initialized the requested runtime with a usable /dev/kvm
device. Nodes without KVM remain available for runsc workloads and do not
advertise either VM runtime. The bundled Firecracker configuration disables
virtio-fs and uses EROFS image roots and mounts. OCI/Nydus image roots and
HostPath directories require an operator-enabled compatible virtio-fs profile;
see enabling Firecracker directory access.
OCI image mounts, GPUs, and nested KVM remain unsupported.
The all-in-one image can optionally package a native Linux runc backend.
Operators build it with AKERNEL_ENABLE_RUNC=true and enable it explicitly
because it provides host-kernel container isolation, not the user-space kernel
boundary of runsc. Guided cloud profiles use
make config ENABLE_RUNC=true; standalone deployments use
AKERNEL_ENABLE_RUNC=true, and direct Helm deployments use
node.config.sandboxd.enableRunc=true. After it is advertised:
with Sandbox(runtime="runc") as sandbox:
print(sandbox.commands.run("uname -s").stdout)
with Sandbox(
runtime="runc",
extra_config={"enableKVM": True},
) as sandbox_with_kvm:
print(sandbox_with_kvm.commands.run("test -c /dev/kvm").exit_code)
enableKVM is owned by the runc backend and requires a usable /dev/kvm on
the selected node. Runc supports OCI/EROFS root filesystems, read-only mounts,
networking, command execution, and the default writable overlay. Experimental
GPU requests remain runsc-only; explicit storage_mb quotas are supported by
runsc and Firecracker. See the
sandbox runtime comparison for the
runtime capability boundaries.
See examples/sandbox_runtime.py for a runnable example.
Commands
Run a foreground command:
result = sandbox.commands.run(
"printf $GREETING",
envs={"GREETING": "hello"},
cwd="/tmp",
timeout=60,
)
print(result.stdout, result.stderr, result.exit_code)
Run and control a background command:
handle = sandbox.commands.run("sleep 30", background=True)
print(handle.pid)
for process in sandbox.commands.list():
print(process.pid, process.command, process.running)
handle.kill()
Enable stdin only when it is needed:
handle = sandbox.commands.run("wc -l", background=True, stdin=True)
handle.send_stdin("one\ntwo\n")
handle.close_stdin()
result = handle.wait(timeout=15)
Commands can be reattached by stable command_id (preferred) or an observed
PID without submitting them again. A returned handle binds its stable ID once;
reusing the same PID for another command cannot redirect its identity, wait,
stdin or kill operations. Direct PID operations remain convenience lookups:
handle = sandbox.commands.run("sleep 2; printf done", background=True)
command_id = handle.command_id
sandbox.close()
attached = Sandbox.connect(sandbox.sandbox_id)
try:
result = attached.commands.connect(command_id).wait(timeout=30, check=True)
finally:
attached.close()
check=True on run/wait opts into CommandExitException for nonzero exit,
retaining stdout, stderr and exit_code, and TimeoutException for an unfinished
observation. The default continues returning CommandResult. Authentication,
permission, missing-resource, timeout, rate-limit and service-busy exceptions
subclass BackendOperationError and retain structured service context.
Foreground commands return a backend-neutral CommandResult. Background
commands return an AKernel CommandHandle; its lifecycle operations are
delegated to the selected backend.
With the ADX backend, handle.wait(timeout) returns
CommandResult(exit_code=None, status="RUNNING", error_code="WAIT_TIMEOUT")
when the wait deadline expires. The command keeps running; a later wait() can
observe its completion. handle.kill() and sandbox.commands.kill(pid) return
False when the command does not exist or has already finished.
PTY session wrappers are not retained by the factory after the caller releases
them. A successful wait() also removes the completed session from its tracked
sessions. A wait timeout keeps the session active; use close() or a context
manager to terminate an interactive session explicitly.
Filesystem
sandbox.files.write("/tmp/message.txt", "hello")
print(sandbox.files.read("/tmp/message.txt"))
sandbox.files.write("/tmp/data.bin", b"\x00\x01")
print(sandbox.files.read("/tmp/data.bin", format="bytes"))
for entry in sandbox.files.list("/tmp"):
print(entry.path, entry.type, entry.size)
sandbox.files.make_dir("/workspace")
sandbox.files.rename("/tmp/message.txt", "/workspace/message.txt")
sandbox.files.remove("/workspace/message.txt")
Copy local files or directories through the frontend exec WebSocket:
sandbox.files.copy_from_local("./project", "/workspace/project")
sandbox.files.copy_to_local("/workspace/result.json", "./result.json")
Interactive PTYs
Use sandbox.pty for an interactive byte stream with stdin, streaming output, terminal resizing, and an exit status:
import sys
from akernel_sdk import Sandbox
def write_output(data: bytes) -> None:
sys.stdout.buffer.write(data)
sys.stdout.buffer.flush()
with Sandbox() as sandbox:
with sandbox.pty.create(on_data=write_output) as session:
session.send_stdin(b"echo hello from PTY\n")
session.resize(rows=40, cols=120)
session.send_stdin(b"exit 7\n")
print(session.wait())
PTY output remains bytes so the SDK does not guess the terminal encoding. Use session.close_stdin() to signal end-of-input while continuing to receive output. A session belongs to its WebSocket connection: closing it terminates the remote interactive process, and reconnecting to an existing session is not supported.
Use sandbox.commands instead when the caller needs separate stdout and stderr, a complete CommandResult, or a controllable background process. The former Shell API and its actor bash_* methods were removed before the v0.1.0 public API was released.
Port forwarding
Declare each sandbox port at creation time:
from akernel_sdk import Sandbox
with Sandbox(port_forwardings=[8080]) as sandbox:
server = sandbox.commands.run(
"python3 -m http.server 8080 --bind 0.0.0.0",
background=True,
)
print(sandbox.get_port_url(8080))
server.kill()
get_port_url() rejects undeclared ports. Pass internal=True only when a
deployment operator explicitly wants the direct ADX Ingress address instead of the
public gateway.
Lifecycle compatibility
These APIs follow E2B's Python naming while preserving AKernel's existing constructor, ID, detached cleanup, command-result and creation-budget contracts.
from akernel_sdk import Client, SandboxQuery, SandboxState
client = Client(api_url="https://akernel.example.com", api_key="<tenant-key>",
verify_tls=True)
# An explicit Client captures its own API/gateway/token. It neither changes
# os.environ nor redirects top-level Sandbox operations. Specify gateway_address
# when the data gateway differs. Addresses must be HTTP(S) origins without paths.
source = client.Sandbox.create(image="python:3.13-slim", idle_timeout=600)
identity = source.sandbox_id # source.id remains supported
try:
source.files.write("/tmp/progress", "saved")
assert source.pause() # beta_pause() is an alias; already paused returns False
source.close() # closes local transports, retaining the remote sandbox
restored = client.Sandbox.connect(identity)
try:
assert restored.sandbox_id == identity
assert restored.files.read("/tmp/progress") == "saved"
finally:
restored.close()
print(client.Sandbox.get_info(identity)) # get_by_id(identity) also supported
pages = client.Sandbox.list(limit=20,
query=SandboxQuery(state=[SandboxState.RUNNING, SandboxState.PAUSED]))
while pages.has_next:
for info in pages.next_items():
print(info.sandbox_id, info.state)
finally:
source.close()
client.Sandbox.kill(identity) # bool: False means already absent
connect attaches to Running or resumes Paused under the same logical ID.
It does not create a replacement, rerun a Dockerfile, restart a command, or create
cwd. It waits for Pausing/Resuming to settle and errors on other states. Its
timeout is a logical connection/resume wait budget; transport retry margins and
tunnel initialization can add elapsed time. Supply port_forwardings and
reverse_tunnel again to reconstruct local routing; do not reuse old PTYs or
streams. A failed attachment closes only local resources and never deletes the
existing sandbox. As with fresh sandboxes, a connected handle's context manager
owns remote deletion unless detached=True; use close() to retain it.
Pause creates an anonymous in-place checkpoint with permanent retention until
explicit deletion. It is separate from create_snapshot()'s reusable catalog
snapshot and from_snapshot()'s new ID. The SDK stops its own reverse tunnel
before pause so that its reconnect loop cannot immediately demand-resume the
sandbox. Other connected clients or inbound traffic may still resume it.
Pause errors and unknown outcomes propagate; False means authoritatively paused.
| Operation | Ownership and result |
|---|---|
sandbox.close() |
Idempotent local disconnect; does not delete the remote sandbox. Closing PTYs terminates their interactive processes. |
sandbox.kill() / context exit |
Existing behavior: owned handles delete remote state and close locally; detached handles only close locally. Returns None. |
sandbox.kill(delete_remote=True) |
Explicit remote deletion, including detached or previously closed handles. Failures remain retryable. |
Sandbox.kill(id) / Sandbox.kill_by_id(id) |
Canonical by-ID deletion, returns bool. False means already absent; permission/network/unknown errors propagate. |
Sandbox.delete(sandbox_id=id) |
Explicit by-ID deletion returning None; existing positional Sandbox.delete(name) continues to delete a named detached sandbox. |
sandbox.get_info() / Sandbox.get_info(id) |
Handle or canonical directory query; get_by_id(id) is an explicit class alias. |
Sandbox.list(query=..., limit=20, next_token=None) |
Lazy paginator. next_items() fetches one filtered page, has_next and next_token retain progress. Errors do not advance the cursor. Default states are Running and Paused. |
Timeouts and supported backend surface
All budgets use seconds. The constructor, fresh Sandbox.create(),
Sandbox.create(snapshot_id=...) and compatible Sandbox.from_snapshot()
accept init_timeout=30, an integer in 1..86400. Booleans are rejected.
The constructor's create_timeout and factory/restore timeout have identical
logical creation-budget semantics:
- Omitted: derive
schedule_timeout + init_timeout + 30. - Explicit: require at least that minimum, preserving the supplied value exactly.
Invalid combinations raise
ValueErrorbefore allocating an environment; fork validates before capturing its temporary snapshot. The 30-second reserve follows the supported ADX create contract. AKernel prevents native automatic budget expansion rather than silently changing an explicit caller limit. - Defaults stay scheduling 30, initialization 30, logical creation 90 seconds.
ADX_ENVIRONMENT_CREATE_TIMEOUTdoes not override the public SDK budget.
# A 120-second initialization policy derives a 180-second create budget.
with Sandbox(init_timeout=120, failover=True) as sandbox:
print(sandbox.commands.run("echo ready").stdout)
# Sandbox(init_timeout=120, create_timeout=150) raises before allocation.
| Budget | Covered stages and limits |
|---|---|
schedule_timeout |
Central scheduling queue, where that path is used; default 30. |
init_timeout during fresh create / reusable-snapshot restore |
Execd initialization and readiness after backend preparation, within the remaining total create deadline. Cold image/checkpoint preparation and runtime start also consume the logical creation budget. |
init_timeout during in-place reload / same-node failover |
The retained server execution policy bounds the initialization attempt, including execution preparation, checkpoint materialization, runtime restore, Execd readiness and route activation. It does not bound prior teardown or all reconciliation/cleanup. |
create_timeout / factory timeout |
Logical creation of a new environment, including admission, preparation, start and publication. Not a running lifetime or a wall-clock guarantee for the Python call or physical cleanup. |
| Client observation / transport | Separate deadlines. Native create transport adds its communication margin; tunnel setup and client bootstrap have independent bounds. Native reload uses 300 seconds plus communication margin (default 30) per transport attempt, with the same operation identity on transport retries. |
idle_timeout |
Inactivity before reclamation, not a maximum lifetime. |
The stage coverage above describes the pinned backend packaged by this revision;
initialization is not only Execd work on every lifecycle path. A larger
initialization policy does not extend unrelated backend RPC, transport, task or
command-wait deadlines. Configure cold-image total budgets separately.
reload() does not accept per-call initialization or observation overrides.
A False reload result is not proof that a server operation was canceled.
Initialization policy persists on the server and is reused by manual reload and
automatic failover, including after connect(). Named creation can reuse an
existing environment and does not replace that policy. Reusable-snapshot
restore creates a new environment with the requested policy (default 30), not
a policy inferred from snapshot metadata.
Enable DEBUG logging for akernel_sdk._backends.adx to see resolved request
budgets. These diagnostics contain budget scalars and operation/identity fields,
not tokens, environment variables, mounts, runtime configuration or request bodies.
A reused/connected environment's actual policy cannot be queried by this SDK;
reload diagnostics mark it as server-owned rather than reporting a local default
as its effective policy. Creation errors retain server failure, probe_failure,
request ID and operation ID when supplied; their reason/message identify the
failing stage. Missing server context remains unknown. For reload returning
False, inspect server lifecycle diagnostics for the environment ID; do not retry
rollback or replay the business command to obtain diagnostics.
The maintained ak CLI currently exposes inventory, exec and delete, without a
create or restore command.
Timeout configuration uses the Environment lifecycle operations supported by the declared ADX dependency. The deployed backend must support the documented creation and recovery semantics. Custom user metadata and filtering, a running-lifetime deadline/set_timeout, live command-output callbacks, and per-command user selection are outside this public SDK surface. They require separately reviewed backend capabilities; the SDK does not emulate them with scheduler labels, idle timers or output replay.
Reusable snapshots
Reusable snapshots require a cluster and runtime that support reusable memory/filesystem snapshots. Unsupported operations fail with the backend's structured error.
from akernel_sdk import Sandbox
snapshot = None
try:
with Sandbox(image="python:3.12-slim") as source:
source.files.write("/tmp/progress", "turn 10")
snapshot = source.create_snapshot(name="turn-10", timeout=300)
print(Sandbox.get_snapshot(snapshot.snapshot_id))
# Source resumes after capture; it can also be deleted independently.
with Sandbox.create(snapshot.snapshot_id) as restored:
assert restored.files.read("/tmp/progress") == "turn 10"
finally:
if snapshot is not None:
Sandbox.delete_snapshot(snapshot.snapshot_id)
| API | Result / semantics |
|---|---|
sandbox.create_snapshot(name=None, *, timeout=300) |
SnapshotInfo(snapshot_id, names); captures runtime memory and filesystem, then the source continues. Timeout is 1..3600 seconds. |
Sandbox.get_snapshot(snapshot_id) |
Query catalog metadata by opaque ID; pending deletion may still return metadata. |
Sandbox.list_snapshots(name=None, limit=None, next_token=None) |
Lazy SnapshotPaginator; limit is the page size. Returns the accessible catalog, optionally filtered by name. |
Sandbox.delete_snapshot(snapshot_id) |
Idempotent when absent, returns None after acceptance; active references can reject deletion with SNAPSHOT_IN_USE. |
Sandbox.create(snapshot_id, ...) |
New Sandbox, new ID and fresh commands/files/PTY facades; does not delete or change the source. Accepts an ID or SnapshotInfo. |
Sandbox.from_snapshot(snapshot_id, ...) |
Retained compatibility entry point with the same options, validation, errors and ownership as create. |
The naming and paginator pattern follow E2B, including
Sandbox.create(snapshot.snapshot_id). Without a snapshot ID,
Sandbox.create(image=...) creates a fresh sandbox, and Sandbox.create()
uses the cluster default rootfs. Existing constructors and
Sandbox.from_snapshot(...) remain supported. AKernel does not resolve E2B
or agentenv template aliases or another platform's snapshot IDs.
Listing is a class-level catalog operation, including when accessed through an
instance; delete returns None because the backend does not distinguish absent from
newly deleted snapshots. Only memory/filesystem capture is exposed; no
unsupported filesystem-only mode or fabricated timestamps/storage metrics.
pages = Sandbox.list_snapshots(name="turn-10", limit=20)
while pages.has_next:
for snapshot in pages.next_items():
print(snapshot.snapshot_id, snapshot.names)
# Save pages.next_token between pages to resume a listing later.
Restore inherits captured runtime and CPU/memory geometry rather than applying
constructor defaults. It does not replay a Dockerfile, image ENTRYPOINT, CMD or
working-directory creation. cwd only sets the command default. idle_timeout
(default 300), schedule_timeout (30), init_timeout (30), timeout (schedule timeout + init timeout + 30), name,
detached, failover, node_id, port_forwardings, mounts, reverse_tunnel
and network_policy configure the new environment/client. Rebind the local
HttpReverseTunnel target explicitly; source client sockets/PTYs/Python handles
are not restored. Supply network_policy explicitly to preserve restrictions:
the pinned ADX backend does not inherit captured execution policy on restore.
An omitted or empty policy uses the backend default. A supplied policy is
applied during creation, before the restored workload is made available.
For mounted external data, consistency and availability remain the caller's
responsibility; restore does not copy node-local HostPath storage.
Snapshots outlive their source and do not expire automatically. Delete them
explicitly. Current ADX rejects deletion with BackendOperationError code
SNAPSHOT_IN_USE while environments or templates retain references. Release
those users and retry; a rejected delete has not marked the snapshot for deletion.
Older deployments can accept deletion before references are released. On either
version, an acknowledged delete prevents new restores and never kills existing
sandboxes; physical collection is asynchronous. Catalog records may remain
queryable while Deleting, so a successful
get_snapshot() is not a readiness or physical-deletion check. Once collection
marks the snapshot Deleted, the backend returns not-found. The
current backend descriptor exposes only ID and names, not catalog state; the
service validates readiness on create() / from_snapshot(). Storage locality
and cross-node restore depend on cluster configuration. Capturing complete
process state does not imply a full physical copy: incremental/reflink storage
is a runtime/deployment concern, not selected
by this API. These APIs are separate from anonymous failover/reload checkpoints.
A remote snapshot does not save the host harness conversation or cursor, model requests, or external service state. Quiesce tools and model streams and pair local harness state with the returned ID. A restore can execute concurrently with its source; the harness must fence the old instance before allowing a recovered agent to proceed. It must not also relaunch an agent whose process memory has been restored.
BackendOperationError preserves status, code, retry/outcome, request ID and
operation ID when supplied. Snapshot creation makes one request attempt. Restore
uses the native transport's same-operation retries (stable request ID); the
public SDK does not initiate a second logical restore. On unknown outcome,
reconcile using the supplied identity instead of blindly calling create/restore
again. Before creation is confirmed, native unknown-outcome context can contain
a lookup name rather than a canonical ID; do not pass it blindly to ak delete.
After creation is confirmed, failure context retains the canonical ID. Read-only
route checks retry temporary 409/503 responses within a 10-second retry window,
without recreating the sandbox. A blocking transport call is separately bounded.
Initialization failures, including interruption during tunnel startup, attempt
to delete the known-created clone and preserve the original error. Failed
rollback errors remain in cleanup_errors for diagnosis and explicit retry.
See examples/snapshots.py.
timeout must be at least schedule_timeout + init_timeout + 30 seconds; shorter budgets raise
ValueError before a create request. This prevents the pinned native SDK from
silently increasing the supplied budget. It is the frontend's logical creation
budget, not a wall-clock deadline for the entire Python call: transport margins,
tunnel/readiness setup, facade binding and cleanup can add elapsed time.
Fork a running sandbox
sandbox.fork(count=N) captures one reusable memory/filesystem snapshot and
derives N new running sandboxes. It returns an ordered list[Sandbox | Exception]
with exactly one result per requested child. A child failure does not kill
successful siblings; a capture failure raises for the whole call. The source
keeps its ID and idle policy and continues after capture.
from akernel_sdk import ForkCleanupError, Sandbox
children = []
pending_snapshot = None
try:
with Sandbox(image="python:3.13-slim-bookworm") as source:
# Explicitly acknowledge this fresh example's unrestricted policy;
# older API versions omit creation ownership from their responses.
source.update_network_policy(None)
source.files.write("/tmp/state", "captured")
try:
results = source.fork(count=3)
except ForkCleanupError as error:
# Preserve handles even when resource cleanup was not acknowledged.
children.extend(r for r in error.results if isinstance(r, Sandbox))
children.extend(error.pending_sandboxes)
pending_snapshot = error.snapshot_id
raise
for result in results:
if isinstance(result, Exception):
print("child failed:", result)
else:
children.append(result)
print(result.id, result.files.read("/tmp/state"))
finally:
# Production callers should attempt every deletion and retain failed IDs.
for child in children:
child.kill()
if pending_snapshot is not None:
Sandbox.delete_snapshot(pending_snapshot)
The maintained examples/fork.py attempts cleanup for all
known children even when one deletion fails, and preserves workload exceptions.
| Parameter | Meaning |
|---|---|
count=1 |
Integer 1..20; booleans are rejected. |
idle_timeout=None |
Child idle timeout in seconds; omitted inherits the source's configured idle timeout. Zero disables idle expiry. |
snapshot_timeout=300 |
Capture operation deadline in seconds, 1..3600. |
restore_timeout=None |
Logical creation budget per child in seconds; minimum/default is the handle's schedule timeout + effective child init timeout + 30. Checked before capture. |
init_timeout=None |
Child initialization budget, integer seconds 1..86400. Omission inherits this handle's creation configuration; an override applies only to children. Connected handles use 30 by default. Named reuse retains the handle's requested configuration for children; neither path queries or changes the existing server initialization policy. |
Children inherit captured resources. Fork explicitly supplies the source
client's last acknowledged network policy with each create request, including
successful policy updates since source creation. After an uncertain/interrupted
policy update it refuses to capture until a policy is successfully reapplied.
Serialize policy changes and captures in the application. This differs from a
bare from_snapshot() call, which requires an explicit policy for restrictions.
As with restore, the logical create budget excludes client/transport overhead;
the client's cwd, declared ports, mounts and reverse tunnel are rebound with
fresh handles. Children are non-detached owned handles even if the source is
detached. Writes to each child's captured root filesystem and process memory
are independent. External services and writable HostPath mounts remain shared
external state. Quiesce model/tool streams before capture, reconnect affected
connections afterwards, and do not relaunch processes already restored from
memory. Deleting the source or one child does not delete its siblings.
The count/ordered partial-result convention follows E2B fork. Deliberate differences:
- AKernel provides an instance method, not E2B's additional fork-by-ID
class variant. There is no separate all-or-nothing
clone()operation. - The supported ADX SDK and packaged Environment API have snapshot/create/delete primitives but no native batch fork method/route. The ADX adapter captures once and then creates children sequentially; this is multiple requests, not E2B's single server-side fork operation.
- E2B fork's
timeoutis an absolute child lifetime. AKernel exposesidle_timeoutand named operation deadlines instead of promising a lifetime its backend does not implement. There is no ambiguoustimeoutalias. - Only a confirmed new environment's creation policy is trusted. Named reuse
can retain an older specification even when the constructor succeeds; missing
ownership confirmation and connected handles are unconfirmed too. Fork fails
with
NETWORK_POLICY_UNCONFIRMEDbefore capture until the caller successfully reapplies the intended policy withupdate_network_policy(policy). Passing constructor arguments again does not prove they changed an existing sandbox. - Temporary snapshot deletion is requested after all creates settle. When the
backend explicitly rejects it with
SNAPSHOT_IN_USE/not_started, each child exposesfork_snapshot_id; the SDK retains the snapshot and deletes it after the last owned child's confirmedkill().close()does not release a live child's reference. Save the ID if deleting children by ID, from another client, or after a client restart; then delete the snapshot explicitly after its users are released. No background or garbage-collection deletion is performed. Other initial cleanup failures raiseForkCleanupError:resultsretains successful child handles,snapshot_idsupports retrying deletion, andcleanup_errorpreserves the original error. A failed client binding whose child deletion fails or is unconfirmed is retained inpending_sandboxes; retrykill()after deciding that remote deletion is intended. Actual cleanup exceptions are inchild_cleanup_errors; local-only closure need not raise one. With no other cleanup error,cleanup_error.codeis the SDK-generatedCLEANUP_UNCONFIRMED(outcome="not_started"for remote deletion). If snapshot cleanup fails on the last child kill, that call raisesForkCleanupErrorwith the snapshot ID; retry that child'skill()or delete the snapshot explicitly. Confirmed child deletion is not repeated during that retry.
Unknown capture/create outcomes preserve BackendOperationError request and
lookup identity; the SDK does not initiate an extra logical attempt. An
unconfirmed create may still exist remotely. Distinguish native lookup names
from canonical IDs when reconciling. Confirmed-created IDs, including failures
during native bootstrap or public binding, remain in environment_id; rollback
failures remain in cleanup_errors. Interruption, including during final
snapshot deletion, attempts ownership-aware rollback of every known child and
deletion of the temporary snapshot, and re-raises the original exception
object/type. Automatic rollback deletes only confirmed newly created children;
false or missing ownership closes local resources only. Local closure is not
remote deletion: these children stay pending with retryable handles, even when
local closure succeeds. An explicit kill() can delete such a child by ID after
the local client has closed. Reconciliation data
on that exception includes snapshot_id, created_environment_ids,
pending_environment_ids, pending_sandboxes, cleanup_errors, and
creation_errors. Pending sandboxes are cleanup-only public handles: retry
kill() without rebinding commands, files or tunnels. Query or connect separately
if inspection is needed. Errors from a second interruption during cleanup are
retained alongside other cleanup errors rather than replacing the first one.
After releasing unresolved users, explicitly retry snapshot deletion. Unknown
creation errors retain their lookup/request context; do not blindly delete a
lookup name as though it were a confirmed-created ID.
Restore readiness and native session/tunnel initialization can fail before a
child reaches the fork result list. Secondary interruptions while closing or
rolling back are retained on the original exception. Known unresolved bootstrap
children still appear in the fork's pending IDs and cleanup-only handles; their
failed automatic rollback is not repeated before returning the cancellation.
creation_errors combines the complete backend result set with earlier public
binding errors, deduplicated by exception identity. It preserves nested request,
operation, lookup and rollback context even if binding an earlier child is
interrupted. Uncertain creation errors do not grant ownership or trigger deletion
of their lookup names.
Run real isolation, partial-failure and cleanup acceptance on a supporting deployment using a complete image that contains Python 3 (not a CLI mount image):
AKERNEL_RUN_INTEGRATION=1 \
AKERNEL_TEST_IMAGE=python:3.13-slim-bookworm \
PYTHONPATH=sdk/python \
python sdk/python/tests/integration/test_fork.py
The companion tests/integration/test_fork_network.py covers two independent
tunnels (default and custom listen ports), private published-port responses,
creation-time and updated deny policy, and isolated child policy clearing.
It first verifies an allowed TCP baseline against AKERNEL_TEST_EGRESS_HOST
(default 1.1.1.1) and AKERNEL_TEST_EGRESS_PORT (443); an unreachable baseline
fails instead of producing a false policy pass. Run both suites with:
AKERNEL_RUN_INTEGRATION=1 AKERNEL_TEST_IMAGE=python:3.13-slim-bookworm \
PYTHONPATH=sdk/python python -m unittest \
tests.integration.test_fork tests.integration.test_fork_network -v
The partial-failure case injects one client-side error before its child create; the other two children are real. The cleanup case injects one deletion failure and verifies explicit retry. The suite checks real process memory/PID/open-file offsets, private writes, source/sibling independence, and snapshot collection. It never changes cluster configuration or induces a platform capacity failure.
Local failover and reload
Sandbox(failover=True) opts into same-node recovery of the same logical
sandbox after its physical runtime fails. sandbox.reload() requests the same
rollback explicitly. It returns False whenever the rollback is not completed,
including when no usable local anonymous checkpoint exists, the sandbox is
already closed, or the backend reports an operational failure. A successful
reload preserves sandbox.id and the existing commands, filesystem, and PTY
facades. The SDK also confirms the data route with a read-only process
listing before reporting success. A temporary route conflict is retried within
a 10-second window; it never reissues the rollback. Other errors, explicit
non-retryable errors, or an expired wait return False.
Recovery points are local and follow the source sandbox lifecycle. They are
created by sandbox workloads through Execd's internal POST /checkpoint
endpoint on /run/akernel/execd.sock. A successful request returns
{"status":"completed"}; a concurrent checkpoint request returns HTTP 409.
This Unix-socket protocol is experimental and is not a stable public AKernel
SDK interface. These anonymous checkpoints have no public catalog; use the
separate reusable snapshot APIs above when you need an independent snapshot ID
and restoration to a new sandbox.
The bundled runsc and Firecracker runtimes support this recovery flow. The maintained example validates it with runsc and installs curl in the sandbox before calling the internal Unix-socket endpoint, so the default RRT runtime profile is sufficient:
AKERNEL_TEST_RUNTIME=runsc python examples/failover_reload.py
See examples/failover_reload.py for the
internal trigger used during integration.
Reverse tunnels
A reverse tunnel lets sandbox code call an HTTP or HTTPS service reachable from the machine running the SDK:
from akernel_sdk import HttpReverseTunnel, Sandbox
tunnel = HttpReverseTunnel(
target="https://service.example.com",
reverse_port=8765,
listen_port=8766,
connect_timeout=60,
)
with Sandbox(reverse_tunnel=tunnel) as sandbox:
result = sandbox.commands.run(
f"curl {sandbox.reverse_tunnel.url}/health"
)
reverse_port carries the WebSocket tunnel through ADX Ingress. listen_port is
the loopback HTTP listener used inside the sandbox. Consequently,
sandbox.reverse_tunnel.url is always
http://127.0.0.1:<listen_port>, even when target uses HTTPS.
For an HTTPS target, the SDK-side tunnel client performs the TLS handshake and certificate verification. The sandbox application talks only to its loopback HTTP listener. AKernel supports one HTTP/HTTPS reverse tunnel per sandbox and does not expose a general TCP tunnel.
The bundled backend supports custom internal tunnel
ports. Its frontend derives the WebSocket port from the HTTP listener, so
reverse_port must equal listen_port - 1. Both ports are reserved inside
that sandbox while the tunnel is active and must not also appear in
port_forwardings; they do not occupy ports on the SDK host.
Replacing a network policy can interrupt the existing tunnel connection. After
acknowledgement, the SDK that owns the tunnel actively retires its old transport
and reuses its reconnect loop, keeping the session and resumable requests.
Return from update_network_policy() confirms policy installation; tunnel
readiness may follow, so retry requests during recovery. Updates through another
client or raw HTTP use the existing heartbeat fallback (20-second interval and
10-second pong timeout by default).
Rootfs and mounts
Use a public OCI image:
with Sandbox(image="ubuntu:24.04") as sandbox:
print(sandbox.commands.run("cat /etc/os-release").stdout)
To start the effective OCI image ENTRYPOINT and CMD as the managed sandbox
workload, enable entrypoint inheritance and wait for its exit status:
with Sandbox(image="example/worker:latest", inherit_entrypoint=True) as sandbox:
exit_code = sandbox.wait_entrypoint()
print(exit_code, sandbox.entrypoint_exit_info)
For this image-inheritance path, sandbox.startup_command is None.
wait_entrypoint() returns an integer exit code; entrypoint_exit_info
contains the structured exit details collected by that call. Waiting observes
process exit, not application readiness. An inherited process exiting after
successful sandbox creation does not by itself terminate the sandbox.
For a long-running service, check its application health endpoint separately.
Sandbox(cwd=...) sets the default working directory for subsequent
sandbox.commands.run() calls that omit cwd. With inherit_entrypoint=True,
the image process starts in the image's OCI WORKDIR; the constructor's
cwd does not override it. For example, if the image declares WORKDIR /app:
with Sandbox(
image="example/worker:latest", inherit_entrypoint=True, cwd="/tmp"
) as sandbox:
# The inherited image entrypoint starts in /app.
print(sandbox.commands.run("pwd").stdout) # /tmp
print(sandbox.commands.run("pwd", cwd="/").stdout) # /
Or use an object in S3-compatible storage as the rootfs:
from akernel_sdk import S3Config, Sandbox
rootfs = S3Config(
endpoint="https://s3.example.com",
bucket="akernel-rootfs",
object="ubuntu-24.04/rootfs.img",
access_key="<optional>",
secret_key="<optional>",
)
with Sandbox(rootfs=rootfs) as sandbox:
print(sandbox.commands.run("cat /etc/os-release").stdout)
image and rootfs are mutually exclusive. The SDK generates the backend
wire representation; callers do not pass raw rootfs JSON or override the
runtime inside an S3 object. When neither source is supplied, AKernel sends
only the selected isolation runtime and openYuanRong overlays it onto the
rootfs configured by the deployed service.
The default Firecracker profile uses the deployed EROFS root when image
and rootfs are omitted; explicit rootfs S3 objects must contain raw EROFS
images. Sandbox(runtime="firecracker", image="ubuntu:24.04") requires the
operator-enabled virtio-fs profile described below. With that profile, OCI and
Nydus roots use the image manager's directory directly. The shared root stays
read-only; sandbox writes use its private node-local ext4 overlay. The bundled
distill-fs supports Nydus RAFS v5; select --fs-version 5 when preparing images
with nydusify convert.
Enabling Firecracker directory access
This is a node deployment setting, not an SDK extra_config option. Helm and
standalone keep plugin.runtime.firecracker.virtiofs_enabled=false by default.
Operators who need OCI/Nydus roots or HostPath directories must:
- Qualify a KVM-capable image containing the compatible Firecracker VMM, guest kernel/agent and virtiofsd. Include the Firecracker build payload.
- Drain existing Firecracker sandboxes before changing the runtime profile. Recreate recovery points when the rootfs or mount layout changes.
- In Helm, update the
[plugin.runtime.firecracker]section ofnode.config.sandboxd.configtovirtiofs_enabled=true(core.node...in the umbrella chart), preserving the rest of the TOML configuration. For standalone, update the same section in the sandboxd configuration used by the launcher. Restart the drained node services with the updated profile. - Verify a fresh Sandbox using the required root or HostPath directory, including permissions, private writes and checkpoint/reload, before admitting workloads. Keep runtime state and private writable layers on node-local disk, separate from shared checkpoints.
An incompatible runtime or filesystem profile requires new recovery points; do not restore old checkpoints across that migration.
The same S3Config type can be used as a read-only mount source:
from akernel_sdk import Mount
mount = Mount(target="/models", type="erofs", s3_config=rootfs)
with Sandbox(mounts=[mount]) as sandbox:
print(sandbox.commands.run("ls /models").stdout)
OCI images can also be mounted read-only:
mount = Mount(target="/opt/tools", image_url="ubuntu:24.04")
Firecracker S3 mounts use type="erofs" with a raw EROFS image. It rejects
image_url mounts. HostPath directories require the enabled virtio-fs profile
above; the default profile rejects them.
Node HostPath bind mounts
Trusted management clients can bind an existing node-visible path into a sandbox. For example, expose a prepared log directory on a selected runsc node:
from akernel_sdk import Mount, Sandbox
logs = Mount(
target="/apps/logs", # Path inside the sandbox.
host_path="/apps/logs", # Path visible to sandboxd on the selected node.
read_only=False, # Explicitly allow application log writes.
)
with Sandbox(node_id="<prepared-node-id>", mounts=[logs]) as sandbox:
print(sandbox.commands.run("ls -ld /apps/logs").stdout)
read_only=True is the default. HostPath supports type="bind" only;
read_only=False is rejected for Image/S3 mounts, which remain read-only.
Exactly one of image_url, s3_config, or host_path is required. The source
must be an absolute POSIX path without traversal components or control
characters. The SDK does not inspect the client machine's filesystem or create
the source directory; it sends create_if_missing=false. An absent source or
insufficient filesystem permissions is a node-side error.
In Kubernetes, the node Pod must first see the source, for example through an
operator-managed hostPath volume and matching volumeMount. An ECS directory
does not become visible to sandboxd merely because its path is in the SDK
request. Directory ownership and permissions must allow the sandbox's process
UID/GID to use it. Separate workers' local directories are separate data;
node_id selects the prepared node but does not replicate storage. Data written
through a bind can outlive the sandbox. Runtime-specific mount restrictions
are enforced by the deployed backend. Firecracker HostPath directories,
including read-only directories, require the operator-enabled virtio-fs profile.
Read-only regular-file injection can use the default Firecracker profile;
writable regular-file mounts are unsupported.
For operator-managed Kubernetes preparation and the retention/C/R contract, see node-local application directories.
Restrict HostPath creation to trusted management clients and source paths
controlled by the operator. These mounts do not provide per-tenant source-path
isolation; SDK path validation and read-only defaults do not authorize access
to the node's filesystem. Server permission errors are returned through the
normal BackendOperationError fields.
The maintained example requires an explicit node and source. It lists the
read-only mount by default; --write creates one uniquely named log file and
leaves that file on the node:
python sdk/python/examples/hostpath_mounts.py \
--node-id <prepared-node-id> --host-path /apps/logs --write
Launch from a Dockerfile
Dockerfile direct launch is a supported AKernel SDK capability and will remain available. Its documented strict subset evolves incrementally with production experience; unsupported inputs continue to fail closed. The specific API surface may evolve, with documentation and migration guidance for material changes. It is not a general-purpose Docker build.
FROM supplies only the root filesystem; inherited OCI configuration is not
applied. Precheck the context, then pass its launch configuration to Sandbox:
from akernel_sdk import DockerfileLaunch, LocalDockerContext, Sandbox, check_direct_launch
context = LocalDockerContext("Dockerfile", context_dir=".")
if check_direct_launch(context).direct_launchable:
with Sandbox(dockerfile=DockerfileLaunch(context, run_timeout=300)) as sandbox:
startup = sandbox.startup_command
if startup is not None:
# For a finite CMD/ENTRYPOINT, collect its exit code and output.
result = startup.wait(timeout=60)
print(result.exit_code, result.stdout, result.stderr)
startup_command is a CommandHandle for the Dockerfile's background
CMD/ENTRYPOINT. It is None when auto_start_cmd=False or no startup
command is declared. The handle supports wait(timeout=...) and kill();
construction confirms dispatch, while application readiness requires a
separate health check. For long-running services, perform that check instead
of waiting for exit during startup.
wait_entrypoint() is exclusive to image launches with
inherit_entrypoint=True; calling it on a Dockerfile launch raises
RuntimeError, and entrypoint_exit_info is None. See the
image launch examples for that path.
RUN, COPY, and ADD run on every launch without a snapshot or cache;
unsupported Dockerfiles must be built externally. Read the complete contract,
security boundaries, and supported syntax in
the Dockerfile launch guide. See the
runnable example.
Resources and lifecycle
resources() returns stable NodeInfo values rather than backend objects:
from akernel_sdk import resources
for node in resources():
print(node.id, node.status, node.capacity, node.allocatable, node.labels)
Accelerators appear under keys such as GPU/l20. Capacity is the total card
count and allocatable is the currently free count. ak resources renders the
same information as, for example, gpu/l20 1/4. Its status column renders only
normal nodes as OK; unavailable states remain explicit as EVICTING,
RECOVERING, or TO_BE_DELETED.
Use a context manager or call kill() in a finally block. The SDK does not
delete sandboxes during garbage collection or interpreter exit. Cleanup failures
propagate and can be retried explicitly; existing workload exceptions are
preserved on context exit. Server idle_timeout is a fallback, not a maximum
lifetime.
For a named detached sandbox, explicitly delete it when it is no longer needed:
sandbox = Sandbox(name="worker", detached=True)
sandbox.kill() # closes local clients; remote sandbox remains
Sandbox.delete("worker") # terminates the named remote sandbox
When the backend accepts creation with an existing successful name, it returns
that sandbox and its original resource allocation; changed arguments never
resize it. Some older deployments reject changed specifications with CONFLICT
instead of reusing them. If local initialization fails while reusing a result,
the SDK closes
its local handle and preserves the original workload. Automatic rollback
removes a remote instance only when the server confirms this create owns it.
This applies to backend readiness and cwd setup, public facade construction,
and Dockerfile COPY, RUN or startup-dispatch failures.
Use get_info() to inspect the retained allocation, or delete the named
sandbox before creating a replacement with a different specification.
sandbox.id (also sandbox.sandbox_id) is the logical ID shown by ak list. get_info() returns a
SandboxInfo containing id, state, requested CPU, memory, XPU and storage,
and the OCI image when one was configured.
CLI
The ak CLI is installed with the SDK package:
ak resources
ak list
ak list --quiet
ak exec <sandbox-id>
ak exec <sandbox-id> -- /bin/sh
ak delete <sandbox-id> [<sandbox-id> ...]
It uses the same AKERNEL_SERVER_ADDRESS and AKERNEL_TOKEN environment as
the Python API.
ak list displays ID, TENANT, and STATUS. Administrator keys can see
instances across tenants; tenant keys only see their own instances. ak list --quiet still prints only IDs. A server that omits tenant_id is displayed
with - in the tenant column; the CLI does not guess the owner.
ak resources displays per-node CPU, memory, disk, and accelerator resources.
DISK is scheduling capacity, DISK ALLOC is allocated capacity, and
DISK% is the allocated fraction. Disk values use GiB (G) after converting the API's MiB values.
The cluster summary totals disk capacity and allocation.
CPU/MEM used values and disk allocation describe the scheduling ledger, not
measured process usage or filesystem occupancy. Missing disk values are
shown as - and excluded from disk totals.
Examples and tests
Maintained examples are under examples/:
basic_usage.pycommand_stdin.pycustom_image.pydockerfile_launch.pysnapshots.pylifecycle.pyfailover_reload.pygpu_sandbox.pyhostpath_mounts.pynamed_sandbox.pynetwork_policy.pypty.pyport_forwarding.pyreverse_tunnel.pys3_rootfs_and_mounts.pystorage_sandbox.py
Run unit tests without a deployment:
PYTHONPATH=sdk/python \
python -m unittest discover -s sdk/python/tests/unit -t sdk/python -v
Run the integration suite against a configured deployment:
export AKERNEL_RUN_INTEGRATION=1
PYTHONPATH=sdk/python \
python -m unittest discover -s sdk/python/tests/integration -t sdk/python -v
Set AKERNEL_TEST_RUNTIME=firecracker or firecracker-pvm and
AKERNEL_TEST_IMAGE=ubuntu:24.04 after explicitly enabling a compatible
virtio-fs profile on the test node to exercise the same suite, including
checkpoint/reload, against a directory image root. AKERNEL_TEST_IMAGE also
accepts a Nydus image reference and enables checks for private writes and
network policy replacement. Use immutable digest references when qualifying a
runtime release, and run both OCI and Nydus images. The pinned distill-fs
requires Nydus RAFS v5.
The network checks use https://example.com/ by default. Set
AKERNEL_TEST_NETWORK_URL to an HTTP endpoint reachable from the sandbox to
verify an isolated deployment without external network access. The suite checks
access before blocking new flows, SDK command execution while blocked, and
access after removing the policy. Images can include curl and CA certificates
in advance; otherwise the suite installs them using apt-get. Omit
AKERNEL_TEST_IMAGE to test the deployed default EROFS root.
Load and transfer benchmarks live under benchmarks/ and are
not part of the default test suite.
Public value types
| Type | Fields |
|---|---|
CommandResult |
stdout, stderr, exit_code (optional), status, error_code, error_message (optional) |
CommandInfo |
pid, command, running |
EntryInfo |
name, path, type, size, permissions, modified_time |
SandboxInfo |
id, state, cpu, memory, image, xpu, storage_mb |
NodeInfo |
id, status, capacity, allocatable, labels |
S3Config |
endpoint, bucket, object, optional credentials |
Mount |
target, exactly one of image_url / s3_config / host_path, type, read_only (default True; writable only for HostPath) |
HttpReverseTunnel |
target, reverse_port, listen_port, connect_timeout |
PortRange |
first, last |
NetworkRule |
action, direction, protocol, peer and sandbox port selectors, priority |
TrafficPolicy |
independent ingress/egress defaults, rules, mode |
DNSRule |
pattern, action |
DNSPolicy |
default_action, rules |
NetworkPolicy |
legacy fields or schema v2 traffic and dns sections |
DockerfileLaunch |
context, auto_start_cmd, run_timeout |
DockerContext |
Abstract Dockerfile and build-context source |
DockerContextEntry |
path, kind, mode |
LocalDockerContext |
Local Dockerfile and context implementation |
Backend errors
BackendOperationError preserves optional service context directly on the
public exception: code, retry, outcome, request_id, operation_id,
environment_id, status_code, scheduling_failure, failure,
probe_failure, and request_forwarded. Fields absent from the backend response
are None; the original exception remains in __cause__. cleanup_errors is a
tuple of rollback failures (empty when absent). Known-created IDs and these
errors are also attached to interruption exceptions without changing their type.
from akernel_sdk import BackendOperationError, Sandbox
try:
sandbox = Sandbox(cpu=1000, memory=2048)
except BackendOperationError as error:
print(error.code, error.retry, error.outcome, error.request_id)
print(error.scheduling_failure)
else:
sandbox.kill()
A service-confirmed cancelled scheduling request uses outcome="not_started"
and retry="never": the configured queue wait has finished. Capacity and
placement details are available in scheduling_failure when supported by the
server and ADX SDK. An older backend can omit those details. Ambiguous execution
results retain outcome="unknown" and retry="same_operation"; preserve the
original identity when querying or retrying. Do not infer execution or cleanup
from a timeout message. status_code describes the service failure (including
an SSE final event's error code); it need not equal the stream's HTTP status.
Metadata
Release files for akernel-sdk 0.2.0rc5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| akernel_sdk-0.2.0rc5.tar.gz | 156.2 kB | With provenance | Details for akernel_sdk-0.2.0rc5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| akernel_sdk-0.2.0rc5-py3-none-any.whl | Python 3 | none | any | Details for akernel_sdk-0.2.0rc5-py3-none-any.whl |
Total release size: 283.5 kB
Release files / akernel_sdk-0.2.0rc5.tar.gz
| Download URL | akernel_sdk-0.2.0rc5.tar.gz |
|---|---|
| Size | 156.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8018bc3630439325822ffac8c7d0e542356cc793d41f3c8e68b7c39486f2797b
|
|
BLAKE2b-256 checksum How to use checksums |
bf5f6313f27aceed428d431c478fec766f6eb28f894868f4200855488b5ead3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.
Transparency logRelease files / akernel_sdk-0.2.0rc5-py3-none-any.whl
| Download URL | akernel_sdk-0.2.0rc5-py3-none-any.whl |
|---|---|
| Size | 127.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0df47f65e173422e14b7a73ad5d50be61860d40809705863f16088959eedfc99
|
|
BLAKE2b-256 checksum How to use checksums |
357607157e3b8092ad9fec38fb3d62daa0e6a4885180bb5c2ba9728486e45441
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.
Transparency logSecurity for akernel-sdk 0.2.0rc5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for akernel_sdk-0.2.0rc5.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.