Struct EphemeralContainerCommon 

pub struct EphemeralContainerCommon {

    pub name: Option<String>,
    pub image: Option<String>,
    pub command: Vec<String>,
    pub args: Vec<String>,
    pub working_dir: Option<String>,
    pub ports: Vec<ContainerPort>,
    pub env_from: Vec<EnvFromSource>,
    pub env: Vec<EnvVar>,
    pub resources: Option<ResourceRequirements>,
    pub resize_policy: Vec<ContainerResizePolicy>,
    pub restart_policy: Option<String>,
    pub volume_mounts: Vec<VolumeMount>,
    pub volume_devices: Vec<VolumeDevice>,
    pub liveness_probe: Option<Probe>,
    pub readiness_probe: Option<Probe>,
    pub startup_probe: Option<Probe>,
    pub lifecycle: Option<Lifecycle>,
    pub termination_message_path: Option<String>,
    pub termination_message_policy: Option<String>,
    pub image_pull_policy: Option<String>,
    pub security_context: Option<SecurityContext>,
    pub stdin: Option<bool>,
    pub stdin_once: Option<bool>,
    pub tty: Option<bool>,
}

EphemeralContainerCommon is a copy of all fields in Container to be inlined in EphemeralContainer. This separate type allows easy conversion from EphemeralContainer to Container and allows separate documentation for the fields of EphemeralContainer. When a new field is added to Container it must be added here as well.

Fields

name: Option<String>

Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.

image: Option<String>

Container image name. More info: https://kubernetes.io/docs/concepts/containers/images

command: Vec<String>

Entrypoint array. Not executed within a shell. The image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic

args: Vec<String>

Arguments to the entrypoint. The image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell +optional +listType=atomic

working_dir: Option<String>

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated. +optional

ports: Vec<ContainerPort>

Ports are not allowed for ephemeral containers. +optional +patchMergeKey=containerPort +patchStrategy=merge +listType=map +listMapKey=containerPort +listMapKey=protocol

env_from: Vec<EnvFromSource>

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. +optional +listType=atomic

env: Vec<EnvVar>

List of environment variables to set in the container. Cannot be updated. +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name

resources: Option<ResourceRequirements>

Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. +optional

resize_policy: Vec<ContainerResizePolicy>

Resources resize policy for the container. +featureGate=InPlacePodVerticalScaling +optional +listType=atomic

restart_policy: Option<String>

Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers. +featureGate=SidecarContainers +optional

volume_mounts: Vec<VolumeMount>

Pod volumes to mount into the container’s filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated. +optional +patchMergeKey=mountPath +patchStrategy=merge +listType=map +listMapKey=mountPath

volume_devices: Vec<VolumeDevice>

volumeDevices is the list of block devices to be used by the container. +patchMergeKey=devicePath +patchStrategy=merge +listType=map +listMapKey=devicePath +optional

liveness_probe: Option<Probe>

Probes are not allowed for ephemeral containers. +optional

readiness_probe: Option<Probe>

Probes are not allowed for ephemeral containers. +optional

startup_probe: Option<Probe>

Probes are not allowed for ephemeral containers. +optional

lifecycle: Option<Lifecycle>

Lifecycle is not allowed for ephemeral containers. +optional

termination_message_path: Option<String>

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. +optional

termination_message_policy: Option<String>

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. +optional

image_pull_policy: Option<String>

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images +optional

security_context: Option<SecurityContext>

Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. +optional

stdin: Option<bool>

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. +optional

stdin_once: Option<bool>

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false +optional

tty: Option<bool>

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false. +optional

Implementations

impl EphemeralContainerCommon

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn image(&self) -> &str

Returns the value of image, or the default value if image is unset.

pub fn working_dir(&self) -> &str

Returns the value of working_dir, or the default value if working_dir is unset.

pub fn termination_message_path(&self) -> &str

Returns the value of termination_message_path, or the default value if termination_message_path is unset.

pub fn image_pull_policy(&self) -> &str

Returns the value of image_pull_policy, or the default value if image_pull_policy is unset.

pub fn stdin(&self) -> bool

Returns the value of stdin, or the default value if stdin is unset.

pub fn stdin_once(&self) -> bool

Returns the value of stdin_once, or the default value if stdin_once is unset.

pub fn tty(&self) -> bool

Returns the value of tty, or the default value if tty is unset.

pub fn termination_message_policy(&self) -> &str

Returns the value of termination_message_policy, or the default value if termination_message_policy is unset.

pub fn restart_policy(&self) -> &str

Returns the value of restart_policy, or the default value if restart_policy is unset.

Trait Implementations

impl Clone for EphemeralContainerCommon

fn clone(&self) -> EphemeralContainerCommon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EphemeralContainerCommon

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

Formats the value using the given formatter.

impl Default for EphemeralContainerCommon

fn default() -> Self

Returns the “default value” for a type.

impl Message for EphemeralContainerCommon

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 EphemeralContainerCommon

fn eq(&self, other: &EphemeralContainerCommon) -> 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 StructuralPartialEq for EphemeralContainerCommon