Skip to main content

DockerConfig

Struct DockerConfig 

Source
pub struct DockerConfig {
    pub image: String,
    pub work_dir: String,
    pub setup_commands: Vec<String>,
    pub environment: Vec<String>,
    pub bind_mounts: Vec<String>,
    pub network_disabled: bool,
    pub container_name_prefix: String,
    pub auto_start: bool,
    pub auto_remove: bool,
}
Expand description

Configuration for the Docker executor.

§Example

use adk_code::DockerConfig;

let config = DockerConfig::python();
assert_eq!(config.image, "python:3.12-slim");
assert_eq!(config.work_dir, "/workspace");

Fields§

§image: String

Container image to use.

§work_dir: String

Working directory inside the container.

§setup_commands: Vec<String>

Setup commands to run after container creation (e.g., pip install).

§environment: Vec<String>

Extra environment variables to set in the container.

§bind_mounts: Vec<String>

Bind mounts in host:container[:ro] format.

§network_disabled: bool

Whether to disable network access.

§container_name_prefix: String

Container name prefix (a random suffix is appended).

§auto_start: bool

Whether to auto-start on first execute if not already running.

§auto_remove: bool

Whether to auto-stop and remove the container on drop.

Implementations§

Source§

impl DockerConfig

Source

pub fn python() -> Self

Python 3.12 preset.

Source

pub fn node() -> Self

Node.js 20 preset.

Source

pub fn custom(image: impl Into<String>) -> Self

Custom image preset.

Source

pub fn setup_command(self, cmd: impl Into<String>) -> Self

Add a setup command to run after container creation.

Source

pub fn pip_install(self, packages: &[&str]) -> Self

Add a pip install command for Python dependencies.

Source

pub fn npm_install(self, packages: &[&str]) -> Self

Add an npm install command for Node.js dependencies.

Source

pub fn with_network(self) -> Self

Enable network access (disabled by default).

Source

pub fn bind_mount(self, mount: impl Into<String>) -> Self

Add a bind mount.

Source

pub fn env(self, var: impl Into<String>) -> Self

Add an environment variable.

Source

pub fn validate_sandbox_policy( &self, policy: &SandboxPolicy, ) -> Result<(), ExecutionError>

Checks that a container created from this configuration satisfies policy.

A persistent container’s network mode, bind mounts, and environment are fixed when it is created, so a request cannot narrow them afterwards. DockerExecutor calls this before every execution and rejects a request whose policy is stricter than the container:

PolicySatisfied when
NetworkPolicy::Disablednetwork_disabled is true
FilesystemPolicy::Nonethere are no bind mounts
FilesystemPolicy::WorkspaceReadOnly { root }every bind mount is read-only (:ro) and its host path lies under root
FilesystemPolicy::WorkspaceReadWrite { root }every bind mount’s host path lies under root
FilesystemPolicy::Paths { read_only, read_write }every bind mount lies under a read_write path, or is read-only and lies under a read_only path
EnvironmentPolicy::Noneenvironment is empty
EnvironmentPolicy::AllowList(names)every environment entry’s name is in names

Bind-mount host paths must be absolute and free of .. components, so a named volume never satisfies a filesystem policy. Variables defined by the image itself (PATH, LANG) come from the image, not the host, and are not checked.

§Errors

Returns ExecutionError::UnsupportedPolicy naming the first setting that exceeds the policy.

§Example
use adk_code::{DockerConfig, NetworkPolicy, SandboxPolicy};

let strict = SandboxPolicy::strict_rust();
assert!(DockerConfig::python().validate_sandbox_policy(&strict).is_ok());

// A networked container cannot honour a request that disables the network.
let networked = DockerConfig::python().with_network();
assert!(networked.validate_sandbox_policy(&strict).is_err());

let allows_network = SandboxPolicy { network: NetworkPolicy::Enabled, ..strict };
assert!(networked.validate_sandbox_policy(&allows_network).is_ok());

Trait Implementations§

Source§

impl Clone for DockerConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DockerConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for DockerConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more