case class EphemeralContainer(args: Optional[Vector[String]] = Optional.Absent, command: Optional[Vector[String]] = Optional.Absent, env: Optional[Vector[EnvVar]] = Optional.Absent, envFrom: Optional[Vector[EnvFromSource]] = Optional.Absent, image: Optional[String] = Optional.Absent, imagePullPolicy: Optional[String] = Optional.Absent, lifecycle: Optional[Lifecycle] = Optional.Absent, livenessProbe: Optional[Probe] = Optional.Absent, name: String, ports: Optional[Vector[ContainerPort]] = Optional.Absent, readinessProbe: Optional[Probe] = Optional.Absent, resources: Optional[ResourceRequirements] = Optional.Absent, securityContext: Optional[SecurityContext] = Optional.Absent, startupProbe: Optional[Probe] = Optional.Absent, stdin: Optional[Boolean] = Optional.Absent, stdinOnce: Optional[Boolean] = Optional.Absent, targetContainerName: Optional[String] = Optional.Absent, terminationMessagePath: Optional[String] = Optional.Absent, terminationMessagePolicy: Optional[String] = Optional.Absent, tty: Optional[Boolean] = Optional.Absent, volumeDevices: Optional[Vector[VolumeDevice]] = Optional.Absent, volumeMounts: Optional[Vector[VolumeMount]] = Optional.Absent, workingDir: Optional[String] = Optional.Absent) extends Product with Serializable
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.
This is a beta feature available on clusters that haven't disabled the EphemeralContainers feature gate.
- args
Arguments to the entrypoint. The docker 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 docker 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 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.
- image
Docker 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
- 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.
- 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. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
- 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.
- Alphabetic
- By Inheritance
- EphemeralContainer
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
EphemeralContainer(args: Optional[Vector[String]] = Optional.Absent, command: Optional[Vector[String]] = Optional.Absent, env: Optional[Vector[EnvVar]] = Optional.Absent, envFrom: Optional[Vector[EnvFromSource]] = Optional.Absent, image: Optional[String] = Optional.Absent, imagePullPolicy: Optional[String] = Optional.Absent, lifecycle: Optional[Lifecycle] = Optional.Absent, livenessProbe: Optional[Probe] = Optional.Absent, name: String, ports: Optional[Vector[ContainerPort]] = Optional.Absent, readinessProbe: Optional[Probe] = Optional.Absent, resources: Optional[ResourceRequirements] = Optional.Absent, securityContext: Optional[SecurityContext] = Optional.Absent, startupProbe: Optional[Probe] = Optional.Absent, stdin: Optional[Boolean] = Optional.Absent, stdinOnce: Optional[Boolean] = Optional.Absent, targetContainerName: Optional[String] = Optional.Absent, terminationMessagePath: Optional[String] = Optional.Absent, terminationMessagePolicy: Optional[String] = Optional.Absent, tty: Optional[Boolean] = Optional.Absent, volumeDevices: Optional[Vector[VolumeDevice]] = Optional.Absent, volumeMounts: Optional[Vector[VolumeMount]] = Optional.Absent, workingDir: Optional[String] = Optional.Absent)
- args
Arguments to the entrypoint. The docker 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 docker 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 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.
- image
Docker 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
- 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.
- 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. The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
- 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.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val args: Optional[Vector[String]]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
- val command: Optional[Vector[String]]
- val env: Optional[Vector[EnvVar]]
- val envFrom: Optional[Vector[EnvFromSource]]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
getArgs: IO[K8sFailure, Vector[String]]
Arguments to the entrypoint.
Arguments to the entrypoint. The docker 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
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getCommand: IO[K8sFailure, Vector[String]]
Entrypoint array.
Entrypoint array. Not executed within a shell. The docker 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
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getEnv: IO[K8sFailure, Vector[EnvVar]]
List of environment variables to set in the container.
List of environment variables to set in the container. Cannot be updated.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getEnvFrom: IO[K8sFailure, Vector[EnvFromSource]]
List of sources to populate environment variables in the container.
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.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getImage: IO[K8sFailure, String]
Docker image name.
Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getImagePullPolicy: IO[K8sFailure, String]
Image pull policy.
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
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getLifecycle: IO[K8sFailure, Lifecycle]
Gets lifecycle.
Gets lifecycle.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getLivenessProbe: IO[K8sFailure, Probe]
Gets livenessProbe.
Gets livenessProbe.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getName: IO[K8sFailure, String]
Name of the ephemeral container specified as a DNS_LABEL.
Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
This effect always succeeds, it is safe to use the field name directly.
-
def
getPorts: IO[K8sFailure, Vector[ContainerPort]]
Ports are not allowed for ephemeral containers.
Ports are not allowed for ephemeral containers.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getReadinessProbe: IO[K8sFailure, Probe]
Gets readinessProbe.
Gets readinessProbe.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getResources: IO[K8sFailure, ResourceRequirements]
Gets resources.
Gets resources.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getSecurityContext: IO[K8sFailure, SecurityContext]
Gets securityContext.
Gets securityContext.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getStartupProbe: IO[K8sFailure, Probe]
Gets startupProbe.
Gets startupProbe.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getStdin: IO[K8sFailure, Boolean]
Whether this container should allocate a buffer for stdin in the container runtime.
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.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getStdinOnce: IO[K8sFailure, Boolean]
Whether the container runtime should close the stdin channel after it has been opened by a single attach.
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
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getTargetContainerName: IO[K8sFailure, String]
If set, the name of the container from PodSpec that this ephemeral container targets.
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.
The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getTerminationMessagePath: IO[K8sFailure, String]
Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem.
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.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getTerminationMessagePolicy: IO[K8sFailure, String]
Indicate how the termination message should be populated.
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.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getTty: IO[K8sFailure, Boolean]
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getVolumeDevices: IO[K8sFailure, Vector[VolumeDevice]]
volumeDevices is the list of block devices to be used by the container.
volumeDevices is the list of block devices to be used by the container.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getVolumeMounts: IO[K8sFailure, Vector[VolumeMount]]
Pod volumes to mount into the container's filesystem.
Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
def
getWorkingDir: IO[K8sFailure, String]
Container's working directory.
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.
If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
- val image: Optional[String]
- val imagePullPolicy: Optional[String]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val lifecycle: Optional[Lifecycle]
- val livenessProbe: Optional[Probe]
- val name: String
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val ports: Optional[Vector[ContainerPort]]
- val readinessProbe: Optional[Probe]
- val resources: Optional[ResourceRequirements]
- val securityContext: Optional[SecurityContext]
- val startupProbe: Optional[Probe]
- val stdin: Optional[Boolean]
- val stdinOnce: Optional[Boolean]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val targetContainerName: Optional[String]
- val terminationMessagePath: Optional[String]
- val terminationMessagePolicy: Optional[String]
- val tty: Optional[Boolean]
- val volumeDevices: Optional[Vector[VolumeDevice]]
- val volumeMounts: Optional[Vector[VolumeMount]]
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- val workingDir: Optional[String]