Struct ContainerConfig

pub struct ContainerConfig {

    pub hostname: Option<String>,
    pub domainname: Option<String>,
    pub user: Option<String>,
    pub attach_stdin: Option<bool>,
    pub attach_stdout: Option<bool>,
    pub attach_stderr: Option<bool>,
    pub exposed_ports: Option<PortSet>,
    pub tty: Option<bool>,
    pub open_stdin: Option<bool>,
    pub stdin_once: Option<bool>,
    pub env: Option<Vec<String>>,
    pub cmd: Option<Vec<String>>,
    pub healthcheck: Option<HealthConfig>,
    pub args_escaped: Option<bool>,
    pub image: Option<String>,
    pub volumes: Option<HashMap<String, Value>>,
    pub working_dir: Option<String>,
    pub entrypoint: Option<Vec<String>>,
    pub network_disabled: Option<bool>,
    pub mac_address: Option<String>,
    pub on_build: Option<Vec<String>>,
    pub labels: Option<HashMap<String, String>>,
    pub stop_signal: Option<String>,
    pub stop_timeout: Option<i32>,
    pub shell: Option<Vec<String>>,
    pub host_config: Option<HostConfig>,
    pub networking_config: Option<NetworkingConfig>,
}

ContainerConfig contains the configuration data about a container. It should hold only portable information about the container. Here, “portable” means “independent from the host we are running on”. Non-portable information should appear in HostConfig.

Fields

hostname: Option<String>

Hostname.

domainname: Option<String>

Domainname.

user: Option<String>

User that will run the command(s) inside the container, also support user:group.

attach_stdin: Option<bool>

Attach the standard input, makes possible user interaction.

attach_stdout: Option<bool>

Attach the standard output.

attach_stderr: Option<bool>

Attach the standard error.

exposed_ports: Option<PortSet>

List of exposed ports.

tty: Option<bool>

Attach standard streams to a tty, including stdin if it is not closed.

open_stdin: Option<bool>

Open stdin.

stdin_once: Option<bool>

If true, close stdin after the 1 attached client disconnects.

env: Option<Vec<String>>

List of environment variable to set in the container.

cmd: Option<Vec<String>>

Command to run when starting the container.

healthcheck: Option<HealthConfig>

Healthcheck describes how to check the container is healthy.

args_escaped: Option<bool>

True if command is already escaped (meaning treat as a command line) (Windows specific).

image: Option<String>

Name of the image as it was passed by the operator (e.g. could be symbolic).

volumes: Option<HashMap<String, Value>>

List of volumes (mounts) used for the container.

working_dir: Option<String>

Current directory (PWD) in the command will be launched.

entrypoint: Option<Vec<String>>

Entrypoint to run when starting the container.

network_disabled: Option<bool>

Is network disabled.

mac_address: Option<String>

Mac Address of the container.

on_build: Option<Vec<String>>

ONBUILD metadata that were defined on the image Dockerfile.

labels: Option<HashMap<String, String>>

List of labels set to this container.

stop_signal: Option<String>

Signal to stop a container.

stop_timeout: Option<i32>

Timeout (in seconds) to stop a container.

shell: Option<Vec<String>>

Shell for shell-form of RUN, CMD, ENTRYPOINT.

host_config: Option<HostConfig>

Container configuration that depends on the host we are running on.

networking_config: Option<NetworkingConfig>

This container’s networking configuration.

Trait Implementations

impl Clone for ContainerConfig

fn clone(&self) -> ContainerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerConfig

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

Formats the value using the given formatter.

impl Default for ContainerConfig

fn default() -> ContainerConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContainerConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ContainerConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.