Struct DockerOverrides 

pub struct DockerOverrides {

    pub image: Option<String>,
    pub extra_args: Vec<String>,
    pub entrypoint: Option<String>,
    pub command: Option<Vec<String>>,
    pub user: Option<String>,
    pub gpus: Option<String>,
    pub platform: Option<String>,
    pub privileged: bool,
    pub security_opt: Vec<String>,
    pub sysctls: HashMap<String, String>,
    pub labels: HashMap<String, String>,
    pub restart: Option<String>,
    pub rm: bool,
    pub init: bool,
    pub hostname: Option<String>,
    pub ipc: Option<String>,
    pub pid: Option<String>,
    pub cap_add: Vec<String>,
    pub cap_drop: Vec<String>,
}

Docker runtime overrides.

Fields

image: Option<String>

Override container image.

extra_args: Vec<String>

Additional docker run arguments.

entrypoint: Option<String>

Override entrypoint.

command: Option<Vec<String>>

Override command.

user: Option<String>

User to run as (uid:gid).

gpus: Option<String>

GPU configuration.

platform: Option<String>

Platform for multi-arch support.

privileged: bool

Privileged mode (dangerous!).

security_opt: Vec<String>

Security options.

sysctls: HashMap<String, String>

Sysctls.

labels: HashMap<String, String>

Container labels.

restart: Option<String>

Restart policy.

rm: bool

Remove container after execution.

init: bool

Init process.

hostname: Option<String>

Hostname.

ipc: Option<String>

IPC mode.

pid: Option<String>

PID mode.

cap_add: Vec<String>

Capabilities to add.

cap_drop: Vec<String>

Capabilities to drop.

Implementations

impl DockerOverrides

pub fn new() -> Self

Create new Docker overrides.

pub fn with_image(self, image: impl Into<String>) -> Self

Set container image.

pub fn with_extra_arg(self, arg: impl Into<String>) -> Self

Add extra docker run argument.

pub fn with_entrypoint(self, entrypoint: impl Into<String>) -> Self

Set entrypoint.

pub fn with_command(self, command: Vec<String>) -> Self

Set command.

pub fn with_user(self, user: impl Into<String>) -> Self

Set user.

pub fn with_gpus(self, gpus: impl Into<String>) -> Self

Enable GPU access.

pub fn with_all_gpus(self) -> Self

Enable all GPUs.

pub fn with_platform(self, platform: impl Into<String>) -> Self

Set platform.

pub fn privileged(self) -> Self

Enable privileged mode (dangerous!).

pub fn with_security_opt(self, opt: impl Into<String>) -> Self

Add security option.

pub fn with_no_new_privileges(self) -> Self

Disable new privileges.

pub fn with_sysctl( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add sysctl.

pub fn with_label( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add label.

pub fn with_restart(self, policy: impl Into<String>) -> Self

Set restart policy.

pub fn keep_container(self) -> Self

Keep container after execution.

pub fn with_init(self) -> Self

Enable init process.

pub fn with_hostname(self, hostname: impl Into<String>) -> Self

Set hostname.

pub fn add_capability(self, cap: impl Into<String>) -> Self

Add a capability.

pub fn drop_capability(self, cap: impl Into<String>) -> Self

Drop a capability.

pub fn drop_all_capabilities(self) -> Self

Drop all capabilities.

pub fn to_docker_args(&self) -> Vec<String>

Build docker run arguments from these overrides.

Trait Implementations

impl Clone for DockerOverrides

fn clone(&self) -> DockerOverrides

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockerOverrides

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

Formats the value using the given formatter.

impl Default for DockerOverrides

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DockerOverrides

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DockerOverrides

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.