EphemeralContainer class

An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation.

To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.

Constructors

EphemeralContainer({Input<List<String>>? args, Input<List<String>>? command, Input<List<EnvVar>>? env, Input<List<EnvFromSource>>? envFrom, Input<String>? image, Input<String>? imagePullPolicy, Input<Lifecycle>? lifecycle, Input<Probe>? livenessProbe, required Input<String> name, Input<List<ContainerPort>>? ports, Input<Probe>? readinessProbe, Input<List<ContainerResizePolicy>>? resizePolicy, Input<ResourceRequirements>? resources, Input<String>? restartPolicy, Input<List<ContainerRestartRule>>? restartPolicyRules, Input<SecurityContext>? securityContext, Input<Probe>? startupProbe, Input<bool>? stdin, Input<bool>? stdinOnce, Input<String>? targetContainerName, Input<String>? terminationMessagePath, Input<String>? terminationMessagePolicy, Input<bool>? tty, Input<List<VolumeDevice>>? volumeDevices, Input<List<VolumeMount>>? volumeMounts, Input<String>? workingDir})
Creates a new EphemeralContainer. args 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 command 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 env List of environment variables to set in the container. Cannot be updated. envFrom List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. 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. image Container image name. More info: https://kubernetes.io/docs/concepts/containers/images imagePullPolicy 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 lifecycle Lifecycle is not allowed for ephemeral containers. livenessProbe Probes are not allowed for ephemeral containers. name Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. ports Ports are not allowed for ephemeral containers. readinessProbe Probes are not allowed for ephemeral containers. resizePolicy Resources resize policy for the container. resources Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. restartPolicy Restart policy for the container to manage the restart behavior of each container within a pod. You cannot set this field on ephemeral containers. restartPolicyRules Represents a list of rules to be checked to determine if the container should be restarted on exit. You cannot set this field on ephemeral containers. 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. startupProbe Probes are not allowed for ephemeral containers. stdin 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. stdinOnce 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 targetContainerName If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. terminationMessagePath 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. terminationMessagePolicy 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. tty Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. volumeDevices volumeDevices is the list of block devices to be used by the container. volumeMounts Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated. workingDir 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.
const
EphemeralContainer.fromMap(Map<String, dynamic> map)
factory

Properties

args → Input<List<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
final
command → Input<List<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
final
env → Input<List<EnvVar>>?
List of environment variables to set in the container. Cannot be updated.
final
envFrom → Input<List<EnvFromSource>>?
List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. 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.
final
hashCode → int
The hash code for this object.
no setterinherited
image → Input<String>?
Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
final
imagePullPolicy → Input<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
final
lifecycle → Input<Lifecycle>?
Lifecycle is not allowed for ephemeral containers.
final
livenessProbe → Input<Probe>?
Probes are not allowed for ephemeral containers.
final
name → Input<String>
Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
final
ports → Input<List<ContainerPort>>?
Ports are not allowed for ephemeral containers.
final
readinessProbe → Input<Probe>?
Probes are not allowed for ephemeral containers.
final
resizePolicy → Input<List<ContainerResizePolicy>>?
Resources resize policy for the container.
final
resources → Input<ResourceRequirements>?
Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod.
final
restartPolicy → Input<String>?
Restart policy for the container to manage the restart behavior of each container within a pod. You cannot set this field on ephemeral containers.
final
restartPolicyRules → Input<List<ContainerRestartRule>>?
Represents a list of rules to be checked to determine if the container should be restarted on exit. You cannot set this field on ephemeral containers.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityContext → Input<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.
final
startupProbe → Input<Probe>?
Probes are not allowed for ephemeral containers.
final
stdin → Input<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.
final
stdinOnce → Input<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
final
targetContainerName → Input<String>?
If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.
final
terminationMessagePath → Input<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.
final
terminationMessagePolicy → Input<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.
final
tty → Input<bool>?
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
final
volumeDevices → Input<List<VolumeDevice>>?
volumeDevices is the list of block devices to be used by the container.
final
volumeMounts → Input<List<VolumeMount>>?
Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
final
workingDir → Input<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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited