Interface: KubeContainer
Defined in: lib/k8s/cluster.ts:180
Link
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#container-v1-core
Properties
args?
optional args?: string[];
Defined in: lib/k8s/cluster.ts:192
Arguments to the entrypoint. The container 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.
See
command?
optional command?: string[];
Defined in: lib/k8s/cluster.ts:204
Entrypoint array. Not executed within a shell. The container 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.
See
env?
optional env?: object[];
Defined in: lib/k8s/cluster.ts:207
List of environment variables to set in the container. Cannot be updated.
name
name: string;
Name of the environment variable. Must be a C_IDENTIFIER.
value?
optional value?: string;
Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. 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. Defaults to "".
valueFrom?
optional valueFrom?: object;
Source for the environment variable's value. Cannot be used if value is not empty.
valueFrom.configMapKeyRef?
optional configMapKeyRef?: object;
Selects a key of a ConfigMap.
valueFrom.configMapKeyRef.key
key: string;
The key to select.
valueFrom.configMapKeyRef.name
name: string;
Name of the referent.
valueFrom.configMapKeyRef.optional?
optional optional?: boolean;
Specify whether the ConfigMap or its key must be defined
valueFrom.fieldRef?
optional fieldRef?: object;
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['<KEY>'],
metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP,
status.podIP, status.podIPs.
valueFrom.fieldRef.apiVersion
apiVersion: string;
Version of the schema the FieldPath is written in terms of, defaults to "v1".
valueFrom.fieldRef.fieldPath
fieldPath: string;
Path of the field to select in the specified API version.
valueFrom.resourceFieldRef?
optional resourceFieldRef?: object;
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
valueFrom.resourceFieldRef.containerName?
optional containerName?: string;
Container name: required for volumes, optional for env vars
valueFrom.resourceFieldRef.divisor?
optional divisor?: string;
Specifies the output format of the exposed resources, defaults to "1".
See
valueFrom.resourceFieldRef.resource
resource: string;
Required: resource to select
valueFrom.secretKeyRef?
optional secretKeyRef?: object;
Selects a key of a secret in the pod's namespace
valueFrom.secretKeyRef.key
key: string;
The key of the secret to select from. Must be a valid secret key.
valueFrom.secretKeyRef.name
name: string;
Name of the referent.
valueFrom.secretKeyRef.optional?
optional optional?: boolean;
Specify whether the Secret or its key must be defined
envFrom?
optional envFrom?: object[];
Defined in: lib/k8s/cluster.ts:269
configMapRef?
optional configMapRef?: object;
configMapRef.name
name: string;
Name of the referent.
configMapRef.optional?
optional optional?: boolean;
Specify whether the ConfigMap must be defined
prefix?
optional prefix?: string;
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef?
optional secretRef?: object;
SecretEnvSource The Secret to select from
secretRef.name
name: string;
Name of the referent.
secretRef.optional?
optional optional?: boolean;
Specify whether the Secret must be defined
image
image: string;
Defined in: lib/k8s/cluster.ts:293
Container image name. This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
See
imagePullPolicy
imagePullPolicy: string;
Defined in: lib/k8s/cluster.ts:301
Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated.
See
livenessProbe?
optional livenessProbe?: KubeContainerProbe;
Defined in: lib/k8s/cluster.ts:311
Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated.
See
name
name: string;
Defined in: lib/k8s/cluster.ts:319
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?
optional ports?: object[];
Defined in: lib/k8s/cluster.ts:331
List of ports to expose from the container. 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. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#containerport-v1-core
containerPort
containerPort: number;
Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
hostIP?
optional hostIP?: string;
What host IP to bind the external port to.
hostPort?
optional hostPort?: number;
Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
name?
optional name?: string;
If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
protocol?
optional protocol?: string;
Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".
readinessProbe?
optional readinessProbe?: KubeContainerProbe;
Defined in: lib/k8s/cluster.ts:354
Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails.
Cannot be updated.
See
resizePolicy?
optional resizePolicy?: object[];
Defined in: lib/k8s/cluster.ts:356
Resources resize policy for the container.
resourceName
resourceName: string;
Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
restartPolicy?
optional restartPolicy?: string;
Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.
resources?
optional resources?: object;
Defined in: lib/k8s/cluster.ts:375
Compute Resources required by this container. Cannot be updated.
claims?
optional claims?: object;
claims.name
name: string;
Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
limits?
optional limits?: object;
Limits describes the maximum amount of compute resources allowed.
See
Can also have hugpages like: "hugepages-2Mi": "100Mi" // Requesting 100 Mebibytes of 2 MiB HugePages
limits.cpu?
optional cpu?: string;
example "100m", 100 milliCPU (0.1 CPU core)
limits.memory?
optional memory?: string;
example , "256Mi" 256 Mebibytes
requests?
optional requests?: object;
requests.cpu?
optional cpu?: string;
example "500m", 500 milliCPU (0.5 CPU core)
requests.memory?
optional memory?: string;
example , "1Gi" 1 Gibibyte
See
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcerequirements-v1-core
restartPolicy?
optional restartPolicy?: string;
Defined in: lib/k8s/cluster.ts:417
RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.
stdin?
optional stdin?: boolean;
Defined in: lib/k8s/cluster.ts:457
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?
optional stdinOnce?: boolean;
Defined in: lib/k8s/cluster.ts:469
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?
optional targetContainerName?: string;
Defined in: lib/k8s/cluster.ts:504
If set, the name of the container from the pod spec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc.) of this container. If not set, the ephemeral container uses the namespaces configured in the Pod spec.
The container runtime must support this feature. Only applies to ephemeral containers.
terminationMessagePath?
optional terminationMessagePath?: string;
Defined in: lib/k8s/cluster.ts:432
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?
optional terminationMessagePolicy?: string;
Defined in: lib/k8s/cluster.ts:443
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?
optional tty?: boolean;
Defined in: lib/k8s/cluster.ts:476
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
volumeDevices?
optional volumeDevices?: object[];
Defined in: lib/k8s/cluster.ts:483
volumeDevices is the list of block devices to be used by the container.
patch strategy: merge patch merge key: devicePath
devicePath
devicePath: string;
devicePath is the path inside of the container that the device will be mapped to.
name
name: string;
name must match the name of a persistentVolumeClaim in the pod
volumeMounts?
optional volumeMounts?: object[];
Defined in: lib/k8s/cluster.ts:445
mountPath
mountPath: string;
name
name: string;
readOnly
readOnly: boolean;
workingDir?
optional workingDir?: string;
Defined in: lib/k8s/cluster.ts:494
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.