Struct ContainerConfig 

pub struct ContainerConfig {

    pub metadata: Option<ContainerMetadata>,
    pub image: Option<ImageSpec>,
    pub command: Vec<String>,
    pub args: Vec<String>,
    pub working_dir: String,
    pub envs: Vec<KeyValue>,
    pub mounts: Vec<Mount>,
    pub devices: Vec<Device>,
    pub labels: HashMap<String, String>,
    pub annotations: HashMap<String, String>,
    pub log_path: String,
    pub stdin: bool,
    pub stdin_once: bool,
    pub tty: bool,
    pub linux: Option<LinuxContainerConfig>,
    pub windows: Option<WindowsContainerConfig>,
}

ContainerConfig holds all the required and optional fields for creating a container.

Fields

metadata: Option<ContainerMetadata>

Metadata of the container. This information will uniquely identify the container, and the runtime should leverage this to ensure correct operation. The runtime may also use this information to improve UX, such as by constructing a readable name.

image: Option<ImageSpec>

Image to use.

command: Vec<String>

Command to execute (i.e., entrypoint for docker)

args: Vec<String>

Args for the Command (i.e., command for docker)

working_dir: String

Current working directory of the command.

envs: Vec<KeyValue>

List of environment variable to set in the container.

mounts: Vec<Mount>

Mounts for the container.

devices: Vec<Device>

Devices for the container.

labels: HashMap<String, String>

Key-value pairs that may be used to scope and select individual resources. Label keys are of the form: label-key ::= prefixed-name | name prefixed-name ::= prefix ‘/’ name prefix ::= DNS_SUBDOMAIN name ::= DNS_LABEL

annotations: HashMap<String, String>

Unstructured key-value map that may be used by the kubelet to store and retrieve arbitrary metadata.

Annotations MUST NOT be altered by the runtime; the annotations stored here MUST be returned in the ContainerStatus associated with the container this ContainerConfig creates.

In general, in order to preserve a well-defined interface between the kubelet and the container runtime, annotations SHOULD NOT influence runtime behaviour.

log_path: String

Path relative to PodSandboxConfig.LogDirectory for container to store the log (STDOUT and STDERR) on the host. E.g., PodSandboxConfig.LogDirectory = /var/log/pods/<podUID>/ ContainerConfig.LogPath = containerName/Instance#.log

WARNING: Log management and how kubelet should interface with the container logs are under active discussion in https://issues.k8s.io/24677. There may be future change of direction for logging as the discussion carries on.

stdin: bool

Variables for interactive containers, these have very specialized use-cases (e.g. debugging).

stdin_once: bool

tty: bool

linux: Option<LinuxContainerConfig>

Configuration specific to Linux containers.

windows: Option<WindowsContainerConfig>

Configuration specific to Windows containers.

Trait Implementations

impl Clone for ContainerConfig

fn clone(&self) -> ContainerConfig

Returns a duplicate 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() -> Self

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 Message for ContainerConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ContainerConfig

fn eq(&self, other: &ContainerConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for ContainerConfig