Container

case class Container(args: Optional[Vector[String]], command: Optional[Vector[String]], env: Optional[Vector[EnvVar]], envFrom: Optional[Vector[EnvFromSource]], image: Optional[String], imagePullPolicy: Optional[String], lifecycle: Optional[Lifecycle], livenessProbe: Optional[Probe], name: String, ports: Optional[Vector[ContainerPort]], readinessProbe: Optional[Probe], resources: Optional[ResourceRequirements], securityContext: Optional[SecurityContext], startupProbe: Optional[Probe], stdin: Optional[Boolean], stdinOnce: Optional[Boolean], terminationMessagePath: Optional[String], terminationMessagePolicy: Optional[String], tty: Optional[Boolean], volumeDevices: Optional[Vector[VolumeDevice]], volumeMounts: Optional[Vector[VolumeMount]], workingDir: Optional[String])

A single application container that you want to run within a pod.

A single application container that you want to run within a pod.

Value Params
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. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(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. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(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 This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

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 container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

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

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. 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.

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getArgs: IO[K8sFailure, Vector[String]]

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. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(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

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. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(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 getCommand: IO[K8sFailure, Vector[String]]

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. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(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

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. The $$(VAR_NAME) syntax can be escaped with a double $$$$, ie: $$$$(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. Cannot be updated.

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.

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.

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. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getImagePullPolicy: IO[K8sFailure, 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

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.

Gets lifecycle.

Gets lifecycle.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

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 container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

This effect always succeeds, it is safe to use the field name directly.

def getPorts: IO[K8sFailure, Vector[ContainerPort]]

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Gets readinessProbe.

Gets readinessProbe.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Gets resources.

Gets resources.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Gets securityContext.

Gets securityContext.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

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. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

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. 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

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.

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: 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.

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.

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. Default is false.

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.

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.

Pod volumes to mount into the container's filesystem. Cannot be updated.

Pod volumes to mount into the container's filesystem. 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. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.

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.

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product