Packages > pkg.pkl-lang.org/pkl-k8s/k8s

k8s.api.core.v1.PodSpec1.2.1

Properties
Methods
Classes
Type Aliases

module k8s.api.core.v1.PodSpec extends k8s.K8sObject

PodSpec is a description of a pod.

Module URI:: package://pkg.pkl-lang.org/pkl-k8s/k8s@1.2.1#/api/core/v1/PodSpec.pkl
Pkl version:: 0.25.0 or higher
Source code:: PodSpec.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

dnsPolicy: ("ClusterFirstWithHostNet"|"ClusterFirst"|"Default"|"None")?Source

Set DNS policy for the pod.

Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
link

nodeName: String?Source

NodeName indicates in which node this pod is scheduled.

If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName. Once this field is set, the kubelet for this node becomes responsible for the lifecycle of this pod. This field should not be used to express a desire for the pod to be scheduled on a specific node. https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodename
link

terminationGracePeriodSeconds: Int?Source

Optional duration in seconds the pod needs to terminate gracefully.

May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
link

dnsConfig: PodDNSConfig?Source

Specifies the DNS parameters of a pod.

Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
link

hostNetwork: Boolean?Source

Host networking requested for this pod.

Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
link

readinessGates: Listing<PodReadinessGate>?Source

If specified, all readiness gates will be evaluated for pod readiness.

A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
link

serviceAccountName: String?Source

ServiceAccountName is the name of the ServiceAccount to use to run this pod.

More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
link

imagePullSecrets: Listing<LocalObjectReference>?Source

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.

If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
link

priorityClassName: String?Source

If specified, indicates the pod's priority.

"system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
link

hostAliases: Listing<HostAlias>(hostNetwork != true)?Source

HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.
link

securityContext: PodSecurityContext?Source

SecurityContext holds pod-level security attributes and common container settings.

Optional: Defaults to empty. See type description for default values of each field.
link

preemptionPolicy: ("Never"|"PreemptLowerPriority")?Source

PreemptionPolicy is the Policy for preempting pods with lower priority.

One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
link

nodeSelector: Mapping<String, String>?Source

NodeSelector is a selector which must be true for the pod to fit on a node.

Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
link

hostname: String?Source

Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
link

runtimeClassName: String?Source

RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod.

If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class
link

tolerations: Listing<Toleration>?Source

If specified, the pod's tolerations.
link

automountServiceAccountToken: Boolean?Source

AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
link

schedulingGates: Listing<PodSchedulingGate>?Source

SchedulingGates is an opaque list of values that if specified will block scheduling the pod.

If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod.

SchedulingGates can only be set at pod creation time, and be removed only afterwards.
link

schedulerName: String?Source

If specified, the pod will be dispatched by specified scheduler.

If not specified, the pod will be dispatched by default scheduler.
link

activeDeadlineSeconds: Int?Source

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers.

Value must be a positive integer.
link

os: PodOS?Source

Specifies the OS of the containers in the pod.

Some pod and container fields are restricted if this is set.

If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions

If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.securityContext.supplementalGroupsPolicy - spec.containers*.securityContext.appArmorProfile - spec.containers*.securityContext.seLinuxOptions - spec.containers*.securityContext.seccompProfile - spec.containers*.securityContext.capabilities - spec.containers*.securityContext.readOnlyRootFilesystem - spec.containers*.securityContext.privileged - spec.containers*.securityContext.allowPrivilegeEscalation - spec.containers*.securityContext.procMount - spec.containers*.securityContext.runAsUser - spec.containers*.securityContext.runAsGroup
link

setHostnameAsFQDN: Boolean?Source

If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default).

In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
link

enableServiceLinks: Boolean?Source

EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links.

Optional: Defaults to true.
link

overhead: Mapping<String, Quantity>?Source

Overhead represents the resource overhead associated with running a pod for a given RuntimeClass.

This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md
link

hostIPC: Boolean?Source

Use the host's ipc namespace.

Optional: Default to false.
link

topologySpreadConstraints: Listing<TopologySpreadConstraint>?Source

TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.

Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
link

volumes: Listing<Volume>?Source

List of volumes that can be mounted by containers belonging to the pod.

More info: https://kubernetes.io/docs/concepts/storage/volumes
link

resources: ResourceRequirements?Source

Resources is the total amount of CPU and Memory resources required by all containers in the pod.

It supports specifying Requests and Limits for "cpu" and "memory" resource names only. ResourceClaims are not supported.

This field enables fine-grained control over resource allocation for the entire pod, allowing resource sharing among containers in a pod.

This is an alpha field and requires enabling the PodLevelResources feature gate.
link

ephemeralContainers: Listing<EphemeralContainer>?Source

List of ephemeral containers run in this pod.

Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource.
link

serviceAccount: String?Source

Deprecated.

DeprecatedServiceAccount is a deprecated alias for ServiceAccountName.
Deprecated: Use serviceAccountName instead.
link

priority: Int32?Source

The priority value.

Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
link

restartPolicy: ("Always"|"OnFailure"|"Never")?Source

Restart policy for all containers within the pod.

One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
link

shareProcessNamespace: Boolean?Source

Share a single process namespace between all of the containers in a pod.

When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
link

hostUsers: Boolean?Source

Use the host's user namespace.

Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.
link

resourceClaims: Listing<PodResourceClaim>?Source

ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start.

The resources will be made available to those containers which consume them by name.

This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

This field is immutable.
link

subdomain: String?Source

If specified, the fully qualified Pod hostname will be "...svc.".

If not specified, the pod will not have a domainname at all.
link

containers: Listing<Container>Source

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
link

initContainers: Listing<Container>?Source

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
link

affinity: Affinity?Source

If specified, the pod's scheduling constraints
link

hostPID: Boolean?Source

Use the host's pid namespace.

Optional: Default to false.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

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

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

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

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

function

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

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

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

hasUniquePortNames(l: Listing): Boolean (k8s.K8sObject)

Tells if every port in l has a unique name. null names are ignored.
link

function

hasNonNullPortNames(l: Listing): Boolean (k8s.K8sObject)

Tells if every port in l has a non-null name, unless l has just a single port.
link

function

exactlyOneSet(a: Any, b: Any, c: Any): unknown (k8s.K8sObject)

Tells if exactly one of the three arguments is non-null.
link

function

exactlyOneSet4(a: Any, b: Any, c: Any, d: Any): unknown (k8s.K8sObject)

Tells if exactly one of the four arguments is non-null.
link

function

onlyAllowedIf(str: String?, cond: Boolean): unknown (k8s.K8sObject)

Tells if str is only set when cond holds.

Classes(show inherited)

link

class

K8sVersion extends Annotation (k8s.K8sObject)

Indicates Kubernetes version information for the annotated member.
link

class

PodDNSConfig Source

PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.
link

class

PodDNSConfigOption Source

PodDNSConfigOption defines DNS resolver options of a pod.
link

class

PodReadinessGate Source

PodReadinessGate contains the reference to a pod condition
link

class

HostAlias Source

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
link

class

PodSecurityContext Source

PodSecurityContext holds pod-level security attributes and common container settings.
link

class

Sysctl Source

Sysctl defines a kernel parameter to be set
link

class

PodSchedulingGate Source

PodSchedulingGate is associated to a Pod to guard its scheduling.
link

class

PodOS Source

PodOS defines the OS parameters of a pod.
link

class

TopologySpreadConstraint Source

TopologySpreadConstraint specifies how to spread matching pods among the given topology.
link

class

PodResourceClaim Source

PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod.
link

class

ClaimSource Source

ClaimSource describes a reference to a ResourceClaim.
link

class

Container Source

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

class

Affinity Source

Affinity is a group of affinity scheduling rules.
link

class

NodeAffinity Source

Node affinity is a group of node affinity scheduling rules.
link

class

PreferredSchedulingTerm Source

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op).
link

class

PodAffinity Source

Pod affinity is a group of inter pod affinity scheduling rules.
link

class

PodAffinityTerm Source

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running
link

class

WeightedPodAffinityTerm Source

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
link

class

PodAntiAffinity Source

Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Type Aliases(show inherited)

link

typealias
Quantity = DataSize|Int|Float|String(matches(Regex(#"[+-]?(\d+(.\d*)?|\.\d+)([eE][+-]?(\d+(.\d*)?|\.\d+)|m|k|Ki|Mi?|Gi?|Ti?|Pi?|Ei?)?"#))) (k8s.K8sObject)

A fixed-point representation of a number.
Examples:
```
12
12e6
12.34
"12Mi" (12 * 2^20)
"12M"  (12 * 10^6)
12.mb (a [DataSize])
```
link

typealias

Time = String (k8s.K8sObject)

An RFC 3339 date and time value.

Example: "2016-04-21T08:47:53Z"
link

typealias

MicroTime = String (k8s.K8sObject)

A version of Time with microsecond level precision.
link

typealias

PortNumber = Int(isBetween(1, 65535)) (k8s.K8sObject)

A port number.
link

typealias

PortName = String(length <= 15, matches(Regex("[a-z0-9]+(-[a-z0-9]+)*")), contains(Regex("[a-z]"))) (k8s.K8sObject)

A port name conforming to RFC 6335 IANA service name syntax.

Contrary to the RFC, Kubernetes does not allow uppercase letters.
link

typealias

Rfc1035Label = String(length <= 63, matches(Regex("[a-z]([-a-z0-9]*[a-z0-9])?"))) (k8s.K8sObject)

An RFC 1035 DNS label.

Contrary to the RFC, Kubernetes does not allow uppercase letters.
link

typealias

Rfc1123Label = String(length <= 63, matches(Regex("[a-z0-9]([-a-z0-9]*[a-z0-9])?"))) (k8s.K8sObject)

An RFC 1123 DNS label.

Contrary to the RFC, Kubernetes does not allow uppercase letters.
link

typealias

Rfc1123Hostname = String(length <= 253, matches(Regex("[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*"))) (k8s.K8sObject)

An RFC 1123 hostname.

Contrary to the RFC, Kubernetes does not allow uppercase letters.
link

typealias

ApiRequestVerb = "get"|"list"|"watch"|"create"|"update"|"patch"|"delete"|"deletecollection"|"*"|"use"|"bind"|"escalate"|"impersonate"|String (k8s.K8sObject)

API verbs like get, list, create, update, patch, watch, delete, and deletecollection are used for resource requests.

To determine the request verb for a resource API endpoint, see Determine the request verb. CRDs may use verbs outside of the predefined set.
link

typealias

HttpRequestVerb = "get"|"post"|"put"|"delete"|"patch"|"head"|"*" (k8s.K8sObject)

Lowercased HTTP methods like get, post, put, and delete are used for non-resource requests.
link

typealias
FieldsV1 = String (k8s.K8sObject)

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats:
- 'f:', where is the name of a field in a struct, or key in a map
- 'v:', where is the exact json formatted value of a list item
- 'i:', where is position of a item in a list
- 'k:', where is a map of a list item's key fields to their unique values
If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff.
link

typealias

RawExtension = Dynamic (k8s.K8sObject)

RawExtension is used to hold extensions in external versions.
link

typealias

SeccompProfile = SeccompProfile Source

Deprecated:
SeccompProfile has been moved into its own module.
Replace with: SeccompProfileModule
link

typealias

WindowsSecurityContextOptions = WindowsSecurityContextOptions Source

Deprecated:
WindowsSecurityContextOptions has been moved into its own module.
Replace with: WindowsSecurityContextOptionsModule
link

typealias

EphemeralContainer = EphemeralContainer Source

Deprecated:
EphemeralContainer has been moved into its own module.
Replace with: EphemeralContainerModule
link

typealias

VolumeDevice = VolumeDevice Source

Deprecated:
VolumeDevice has been moved into its own module.
Replace with: VolumeDeviceModule
link

typealias

Probe = Probe Source

Deprecated:
Probe has been moved into its own module.
Replace with: ProbeModule
link

typealias

SecurityContext = SecurityContext Source

Deprecated:
SecurityContext has been moved into its own module.
Replace with: SecurityContextModule
link

typealias

ContainerPort = ContainerPort Source

Deprecated:
ContainerPort has been moved into its own module.
Replace with: ContainerPortModule
link

typealias

Lifecycle = Lifecycle Source

Deprecated:
Lifecycle has been moved into its own module.
Replace with: LifecycleModule