Packages > pkg.pkl-lang.org/pkl-k8s/k8s > k8s.api.core.v1.Pod

PodStatus1.4.0

Overview
Properties
Methods

class PodStatus

PodStatus represents information about the status of a pod.

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

phase: String?Source

The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle.

The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase
link

resourceClaimStatuses: Listing<PodResourceClaimStatus>?Source

Status of resource claims.
link

reason: String?Source

A brief CamelCase message indicating details about why the pod is in this state.

e.g. 'Evicted'
link

containerStatuses: Listing<ContainerStatus>?Source

Statuses of containers in this pod.

Each container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
link

hostIP: String?Source

hostIP holds the IP address of the host to which the pod is assigned.

Empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns mean that HostIP will not be updated even if there is a node is assigned to pod
link

extendedResourceClaimStatus: PodExtendedResourceClaimStatus?Source

Status of extended resource claim backed by DRA.
link

resources: ResourceRequirements?Source

Resources represents the compute resource requests and limits that have been applied at the pod level if pod-level requests or limits are set in PodSpec.Resources
link

nominatedNodeName: String?Source

nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods.

This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled.
link

message: String?Source

A human readable message indicating details about why the pod is in this condition.
link

podIPs: Listing<PodIP>?Source

podIPs holds the IP addresses allocated to the pod.

If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet.
link

allocatedResources: Mapping<String, Quantity>?Source

AllocatedResources is the total requests allocated for this pod by the node.

If pod-level requests are not set, this will be the total requests aggregated across containers in the pod.
link

podIP: String?Source

podIP address allocated to the pod.

Routable at least within the cluster. Empty if not yet allocated.
link

ephemeralContainerStatuses: Listing<ContainerStatus>?Source

Statuses for any ephemeral containers that have run in this pod.

Each ephemeral container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status
link

hostIPs: Listing<HostIP>?Source

hostIPs holds the IP addresses allocated to the host.

If this field is specified, the first entry must match the hostIP field. This list is empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns means that HostIPs will not be updated even if there is a node is assigned to this pod.
link

resize: String?Source

Deprecated.

Status of resources resize desired for pod's containers.
It is empty if no resources resize is pending. Any changes to container resources will automatically set this to "Proposed" Deprecated: Resize status is moved to two pod conditions PodResizePending and PodResizeInProgress. PodResizePending will track states where the spec has been resized, but the Kubelet has not yet allocated the resources. PodResizeInProgress will track in-progress resizes, and should be present whenever allocated resources != acknowledged resources.
link

startTime: Time?Source

RFC 3339 date and time at which the object was acknowledged by the Kubelet.

This is before the Kubelet pulled the container image(s) for the pod.
link

qosClass: String?Source

The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#quality-of-service-classes
link

conditions: Listing<PodCondition>?Source

Current service state of pod.

More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
link

initContainerStatuses: Listing<ContainerStatus>?Source

Statuses of init containers in this pod.

The most recent successful non-restartable init container will have ready = true, the most recently started container will have startTime set. Each init container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a status for a non-existent container is present in the list, or the list has duplicate names, the behavior of various Kubernetes components is not defined and those statuses might be ignored. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-and-container-status
link

observedGeneration: Int?Source

If set, this represents the .metadata.generation that the pod status was set based upon.

The PodObservedGenerationTracking feature gate must be enabled to use this field.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.