Interface: IPodContainer#

Main.K8sApi.IPodContainer

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

Table of contents#

Properties#

args#

• Optional args: 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. 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#

• Optional command: 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. 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#

• Optional env: EnvVar[]

List of environment variables to set in the container. Cannot be updated.

envFrom#

• Optional envFrom: 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.

image#

• Optional image: string

Docker image name.

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

imagePullPolicy#

• Optional imagePullPolicy: "Always" | "Never" | "IfNotPresent"

Image pull policy. 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#

• Optional lifecycle: Lifecycle

livenessProbe#

• Optional livenessProbe: Probe

name#

• name: string

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

ports#

• Optional ports: 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.

readinessProbe#

• Optional readinessProbe: Probe

resources#

• Optional resources: ResourceRequirements

securityContext#

• Optional securityContext: SecurityContext

startupProbe#

• Optional startupProbe: Probe

stdin#

• Optional stdin: 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

false

stdinOnce#

• Optional stdinOnce: 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

false

terminationMessagePath#

• Optional terminationMessagePath: string

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. Cannot be updated.

Default

"/dev/termination-log"

terminationMessagePolicy#

• Optional terminationMessagePolicy: "File" | "FallbackToLogsOnError"

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. Cannot be updated.

Default

"File"

tty#

• Optional tty: boolean

Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.

Default

false

volumeDevices#

• Optional volumeDevices: VolumeDevice[]

volumeDevices is the list of block devices to be used by the container.

volumeMounts#

• Optional volumeMounts: VolumeMount[]

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

workingDir#

• Optional workingDir: 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.