Skip to main content
All Python modules · Import and compatibility guidance

Sandbox configuration

Public API and limits

A topology supports up to eight services. Each service allows 16 aliases, 32 declared ports, 64 environment entries, and 64 command arguments; bounded authored string values may use up to 8 KiB. Readiness permits 1 to 100 attempts with finite timing values. Service names and aliases must be unique portable lowercase DNS labels. These checks run before the Docker SDK receives configuration.

Execution budgets

options retains the allowlisted parsing/retry fields only for callers explicitly constructing a native ADK adapter with to_adk_executor(). Those fields do not change Docker limits or add model tools to named sandbox assignments. Your authored tool decides whether to retry.

Exports

DOCKER_SANDBOX_CAPABILITIES

Advertise network controls a provider enforces below agent code.

DOCKER_SANDBOX_CAPABILITIES.require

Fail closed when this provider cannot enforce requested authority.

DockerNetwork

Configure one extension-owned bridge shared only by this sandbox.
Fields (— means no declared default):

DockerReadiness

Wait for a declared Docker health command before sandbox execution.
Fields (— means no declared default):

DockerScope

Choose how long one owned Docker topology may be retained.

DockerService

Declare one bounded service container on the private sandbox network.
Fields (— means no declared default):

DockerExtension

Expose Docker sandbox definitions without owning framework resources.

DockerExtension.start

Initialize application-scoped resources after dependencies start.

DockerExtension.stop

Release application-scoped resources before dependencies stop.

DockerExtension.create_context

Adapt the managed invocation base to an extension-specific context.

DockerExtension.context

Return the task-local extension context for the active invocation.

DockerExtension.sandbox

Create a portable Docker sandbox definition from authored options.

DockerExtension.service

Declare one bounded service container without contacting Docker.

DockerExtension.network

Declare the extension-owned bridge that joins a sandbox topology.

DockerExtension.readiness

Declare a bounded Docker health command for one service.

DockerSandboxProvider

Bind one extension-owned Docker backend to its configured network policy.

DockerSandboxProvider.sandbox_capabilities

Advertise network controls a provider enforces below agent code.

DockerSandboxProvider.sandbox_capabilities.require

Fail closed when this provider cannot enforce requested authority.

DockerSandboxProvider.execute

Reject policy substitution before delegating generic Python execution.

DockerSandboxProvider.close

Release the extension backend when the owning sandbox runtime closes.

docker

Expose Docker sandbox definitions without owning framework resources.

docker.start

Initialize application-scoped resources after dependencies start.

docker.stop

Release application-scoped resources before dependencies stop.

docker.create_context

Adapt the managed invocation base to an extension-specific context.

docker.context

Return the task-local extension context for the active invocation.

docker.sandbox

Create a portable Docker sandbox definition from authored options.

docker.service

Declare one bounded service container without contacting Docker.

docker.network

Declare the extension-owned bridge that joins a sandbox topology.

docker.readiness

Declare a bounded Docker health command for one service.

docker_sandbox

Create a lazy Docker sandbox without importing an agent framework.

extension

Expose Docker sandbox definitions without owning framework resources.

extension.start

Initialize application-scoped resources after dependencies start.

extension.stop

Release application-scoped resources before dependencies stop.

extension.create_context

Adapt the managed invocation base to an extension-specific context.

extension.context

Return the task-local extension context for the active invocation.

extension.sandbox

Create a portable Docker sandbox definition from authored options.

extension.service

Declare one bounded service container without contacting Docker.

extension.network

Declare the extension-owned bridge that joins a sandbox topology.

extension.readiness

Declare a bounded Docker health command for one service.