Package io.fabric8.kubernetes.api.model

Class PodSpec

    • Method Detail

      • getActiveDeadlineSeconds

        public Long getActiveDeadlineSeconds()
        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.

      • setActiveDeadlineSeconds

        public void setActiveDeadlineSeconds​(Long activeDeadlineSeconds)
        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.

      • getAffinity

        public Affinity getAffinity()
        PodSpec is a description of a pod.

      • setAffinity

        public void setAffinity​(Affinity affinity)
        PodSpec is a description of a pod.

      • getAutomountServiceAccountToken

        public Boolean getAutomountServiceAccountToken()
        AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

      • setAutomountServiceAccountToken

        public void setAutomountServiceAccountToken​(Boolean automountServiceAccountToken)
        AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.

      • getContainers

        public List<Container> getContainers()
        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.

      • setContainers

        public void setContainers​(List<Container> containers)
        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.

      • getDnsConfig

        public PodDNSConfig getDnsConfig()
        PodSpec is a description of a pod.

      • setDnsConfig

        public void setDnsConfig​(PodDNSConfig dnsConfig)
        PodSpec is a description of a pod.

      • getDnsPolicy

        public String getDnsPolicy()
        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'.

      • setDnsPolicy

        public void setDnsPolicy​(String dnsPolicy)
        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'.

      • getEnableServiceLinks

        public Boolean getEnableServiceLinks()
        EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.

      • setEnableServiceLinks

        public void setEnableServiceLinks​(Boolean enableServiceLinks)
        EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.

      • getEphemeralContainers

        public List<EphemeralContainer> getEphemeralContainers()
        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.

      • setEphemeralContainers

        public void setEphemeralContainers​(List<EphemeralContainer> ephemeralContainers)
        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.

      • getHostAliases

        public List<HostAlias> getHostAliases()
        HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.

      • setHostAliases

        public void setHostAliases​(List<HostAlias> hostAliases)
        HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.

      • getHostIPC

        public Boolean getHostIPC()
        Use the host's ipc namespace. Optional: Default to false.

      • setHostIPC

        public void setHostIPC​(Boolean hostIPC)
        Use the host's ipc namespace. Optional: Default to false.

      • getHostNetwork

        public Boolean getHostNetwork()
        Host networking requested for this pod. Use the host's network namespace. When using HostNetwork you should specify ports so the scheduler is aware. When `hostNetwork` is true, specified `hostPort` fields in port definitions must match `containerPort`, and unspecified `hostPort` fields in port definitions are defaulted to match `containerPort`. Default to false.

      • setHostNetwork

        public void setHostNetwork​(Boolean hostNetwork)
        Host networking requested for this pod. Use the host's network namespace. When using HostNetwork you should specify ports so the scheduler is aware. When `hostNetwork` is true, specified `hostPort` fields in port definitions must match `containerPort`, and unspecified `hostPort` fields in port definitions are defaulted to match `containerPort`. Default to false.

      • getHostPID

        public Boolean getHostPID()
        Use the host's pid namespace. Optional: Default to false.

      • setHostPID

        public void setHostPID​(Boolean hostPID)
        Use the host's pid namespace. Optional: Default to false.

      • getHostUsers

        public Boolean getHostUsers()
        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.

      • setHostUsers

        public void setHostUsers​(Boolean hostUsers)
        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.

      • getHostname

        public String getHostname()
        Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

      • setHostname

        public void setHostname​(String hostname)
        Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.

      • getHostnameOverride

        public String getHostnameOverride()
        HostnameOverride specifies an explicit override for the pod's hostname as perceived by the pod. This field only specifies the pod's hostname and does not affect its DNS records. When this field is set to a non-empty string: - It takes precedence over the values set in `hostname` and `subdomain`. - The Pod's hostname will be set to this value. - `setHostnameAsFQDN` must be nil or set to false. - `hostNetwork` must be set to false.


        This field must be a valid DNS subdomain as defined in RFC 1123 and contain at most 64 characters. Requires the HostnameOverride feature gate to be enabled.

      • setHostnameOverride

        public void setHostnameOverride​(String hostnameOverride)
        HostnameOverride specifies an explicit override for the pod's hostname as perceived by the pod. This field only specifies the pod's hostname and does not affect its DNS records. When this field is set to a non-empty string: - It takes precedence over the values set in `hostname` and `subdomain`. - The Pod's hostname will be set to this value. - `setHostnameAsFQDN` must be nil or set to false. - `hostNetwork` must be set to false.


        This field must be a valid DNS subdomain as defined in RFC 1123 and contain at most 64 characters. Requires the HostnameOverride feature gate to be enabled.

      • getImagePullSecrets

        public List<LocalObjectReference> getImagePullSecrets()
        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

      • setImagePullSecrets

        public void setImagePullSecrets​(List<LocalObjectReference> imagePullSecrets)
        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

      • getInitContainers

        public List<Container> getInitContainers()
        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 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/

      • setInitContainers

        public void setInitContainers​(List<Container> initContainers)
        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 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/

      • getNodeName

        public String getNodeName()
        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

      • setNodeName

        public void setNodeName​(String nodeName)
        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

      • getNodeSelector

        public Map<String,​String> getNodeSelector()
        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/

      • setNodeSelector

        public void setNodeSelector​(Map<String,​String> nodeSelector)
        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/

      • getOs

        public PodOS getOs()
        PodSpec is a description of a pod.

      • setOs

        public void setOs​(PodOS os)
        PodSpec is a description of a pod.

      • getOverhead

        public Map<String,​Quantity> getOverhead()
        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

      • setOverhead

        public void setOverhead​(Map<String,​Quantity> overhead)
        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

      • getPreemptionPolicy

        public String getPreemptionPolicy()
        PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.

      • setPreemptionPolicy

        public void setPreemptionPolicy​(String preemptionPolicy)
        PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.

      • getPriority

        public Integer getPriority()
        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.

      • setPriority

        public void setPriority​(Integer priority)
        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.

      • getPriorityClassName

        public String getPriorityClassName()
        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.

      • setPriorityClassName

        public void setPriorityClassName​(String priorityClassName)
        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.

      • getReadinessGates

        public List<PodReadinessGate> getReadinessGates()
        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

      • setReadinessGates

        public void setReadinessGates​(List<PodReadinessGate> readinessGates)
        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

      • getResourceClaims

        public List<PodResourceClaim> getResourceClaims()
        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.

      • setResourceClaims

        public void setResourceClaims​(List<PodResourceClaim> resourceClaims)
        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.

      • setResources

        public void setResources​(ResourceRequirements resources)
        PodSpec is a description of a pod.

      • getRestartPolicy

        public String getRestartPolicy()
        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

      • setRestartPolicy

        public void setRestartPolicy​(String restartPolicy)
        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

      • getRuntimeClassName

        public String getRuntimeClassName()
        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

      • setRuntimeClassName

        public void setRuntimeClassName​(String runtimeClassName)
        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

      • getSchedulerName

        public String getSchedulerName()
        If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

      • setSchedulerName

        public void setSchedulerName​(String schedulerName)
        If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.

      • getSchedulingGates

        public List<PodSchedulingGate> getSchedulingGates()
        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.

      • setSchedulingGates

        public void setSchedulingGates​(List<PodSchedulingGate> schedulingGates)
        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.

      • getSecurityContext

        public PodSecurityContext getSecurityContext()
        PodSpec is a description of a pod.

      • setSecurityContext

        public void setSecurityContext​(PodSecurityContext securityContext)
        PodSpec is a description of a pod.

      • getServiceAccount

        public String getServiceAccount()
        DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

      • setServiceAccount

        public void setServiceAccount​(String serviceAccount)
        DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

      • getServiceAccountName

        public String getServiceAccountName()
        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/

      • setServiceAccountName

        public void setServiceAccountName​(String serviceAccountName)
        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/

      • getSetHostnameAsFQDN

        public Boolean getSetHostnameAsFQDN()
        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.

      • setSetHostnameAsFQDN

        public void setSetHostnameAsFQDN​(Boolean setHostnameAsFQDN)
        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.

      • getShareProcessNamespace

        public Boolean getShareProcessNamespace()
        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.

      • setShareProcessNamespace

        public void setShareProcessNamespace​(Boolean shareProcessNamespace)
        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.

      • getSubdomain

        public String getSubdomain()
        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.

      • setSubdomain

        public void setSubdomain​(String subdomain)
        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.

      • getTerminationGracePeriodSeconds

        public Long getTerminationGracePeriodSeconds()
        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.

      • setTerminationGracePeriodSeconds

        public void setTerminationGracePeriodSeconds​(Long terminationGracePeriodSeconds)
        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.

      • getTolerations

        public List<Toleration> getTolerations()
        If specified, the pod's tolerations.

      • setTolerations

        public void setTolerations​(List<Toleration> tolerations)
        If specified, the pod's tolerations.

      • getTopologySpreadConstraints

        public List<TopologySpreadConstraint> getTopologySpreadConstraints()
        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.

      • setTopologySpreadConstraints

        public void setTopologySpreadConstraints​(List<TopologySpreadConstraint> topologySpreadConstraints)
        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.

      • getVolumes

        public List<Volume> getVolumes()
        List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

      • setVolumes

        public void setVolumes​(List<Volume> volumes)
        List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)