Cloud API Overview > @adpt/cloud > k8s > PodProps
k8s.PodProps interface
Props for the k8s.Pod component
Signature:
export interface PodProps extends WithChildren
Properties
| Property | Type | Description |
|---|---|---|
| activeDeadlineSeconds | number | 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. |
| affinity | Affinity | If specified, the pod's scheduling constraints |
| automountServiceAccountToken | boolean | AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
| config | ClusterInfo | Information about the k8s cluster (ip address, auth info, etc.) |
| dnsConfig | PodDNSConfig | Specifies the DNS parameters of a pod.Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
| dnsPolicy | "ClusterFirstWithHostNet" |"ClusterFirst" |"Default" |"None" | Set DNS policy for the pod.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'. |
| enableServiceLinks | boolean | Indicates whether information about services should be injected into pod's environment variables matching the syntax of Docker links. |
| hostAliases | HostAlias[] | An optional list of hosts and IPs that will be injected into the pod's hosts file if specified.This is only valid for non-hostNetwork pods. |
| hostIPC | boolean | Use the host's ipc namespace. |
| hostname | string | Specifies the hostname of the Pod.If not specified, the pod's hostname will be set to a system-defined value. |
| hostNetwork | boolean | 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. |
| hostPID | boolean | Use the host's pid namespace. |
| imagePullSecrets | LocalObjectReference[] | 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. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
| isTemplate | boolean | True is this is a template for use in a controller, false otherwise |
| metadata | Metadata | k8s metadata |
| nodeName | string | A request to schedule this pod onto a specific node.If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. |
| nodeSelector | { [label: string]: boolean |string; } | 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/ |
| preemptionPolicy | "Never" |"PreemptLowerPriority" | (BETA) PreemptionPolicy is the Policy for preempting pods with lower priority.This field is beta-level, gated by the NonPreemptingPriority feature-gate. |
| priority | number | The priority 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. |
| priorityClassName | string | 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. |
| readinessGates | PodReadinessGate[] | 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/0007-pod-ready%2B%2B.md |
| restartPolicy | "Always" |"OnFailure" |"Never" | Restart policy for all containers within the pod.One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy |
| runtimeClassName | string | 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://kubernetes.io/docs/concepts/containers/runtime-class/This is a beta feature as of Kubernetes v1.14. |
| schedulerName | string | If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. |
| securityContext | PodSecurityContext | SecurityContext holds pod-level security attributes and common container settings. See type description for default values of each field. |
| serviceAccountName | string | 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/ |
| setHostnameAsFQDN | boolean | 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. |
| shareProcessNamespace | boolean | 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. |
| subdomain | string | If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. |
| terminationGracePeriodSeconds | number | 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 delete immediately. 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. |
| tolerations | Toleration[] | If specified, the pod's tolerations. |
| topologySpreadConstraints | TopologySpreadConstraint[] | 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. |
| volumes | Volume[] | List of volumes that can be mounted by containers belonging to the pod.More info: https://kubernetes.io/docs/concepts/storage/volumes |