Struct PodSpec 

pub struct PodSpec {

    pub volumes: Vec<Volume>,
    pub init_containers: Vec<Container>,
    pub containers: Vec<Container>,
    pub ephemeral_containers: Vec<EphemeralContainer>,
    pub restart_policy: Option<String>,
    pub termination_grace_period_seconds: Option<i64>,
    pub active_deadline_seconds: Option<i64>,
    pub dns_policy: Option<String>,
    pub node_selector: BTreeMap<String, String>,
    pub service_account_name: Option<String>,
    pub service_account: Option<String>,
    pub automount_service_account_token: Option<bool>,
    pub node_name: Option<String>,
    pub host_network: Option<bool>,
    pub host_pid: Option<bool>,
    pub host_ipc: Option<bool>,
    pub share_process_namespace: Option<bool>,
    pub security_context: Option<PodSecurityContext>,
    pub image_pull_secrets: Vec<LocalObjectReference>,
    pub hostname: Option<String>,
    pub subdomain: Option<String>,
    pub affinity: Option<Affinity>,
    pub scheduler_name: Option<String>,
    pub tolerations: Vec<Toleration>,
    pub host_aliases: Vec<HostAlias>,
    pub priority_class_name: Option<String>,
    pub priority: Option<i32>,
    pub dns_config: Option<PodDnsConfig>,
    pub readiness_gates: Vec<PodReadinessGate>,
    pub runtime_class_name: Option<String>,
    pub enable_service_links: Option<bool>,
    pub preemption_policy: Option<String>,
    pub overhead: BTreeMap<String, Quantity>,
    pub topology_spread_constraints: Vec<TopologySpreadConstraint>,
    pub set_hostname_as_fqdn: Option<bool>,
    pub os: Option<PodOs>,
    pub host_users: Option<bool>,
    pub scheduling_gates: Vec<PodSchedulingGate>,
    pub resource_claims: Vec<PodResourceClaim>,
    pub resources: Option<ResourceRequirements>,
}

PodSpec is a description of a pod.

Fields

volumes: Vec<Volume>

List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes +optional +patchMergeKey=name +patchStrategy=merge,retainKeys +listType=map +listMapKey=name

init_containers: Vec<Container>

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/ +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name

containers: Vec<Container>

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. +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name

ephemeral_containers: Vec<EphemeralContainer>

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. +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name

restart_policy: Option<String>

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 +optional

termination_grace_period_seconds: Option<i64>

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. +optional

active_deadline_seconds: Option<i64>

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. +optional

dns_policy: Option<String>

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’. +optional

node_selector: BTreeMap<String, String>

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/ +optional +mapType=atomic

service_account_name: Option<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/ +optional

service_account: Option<String>

DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. +k8s:conversion-gen=false +optional

automount_service_account_token: Option<bool>

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

node_name: Option<String>

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 +optional

host_network: Option<bool>

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. +k8s:conversion-gen=false +optional

host_pid: Option<bool>

Use the host’s pid namespace. Optional: Default to false. +k8s:conversion-gen=false +optional

host_ipc: Option<bool>

Use the host’s ipc namespace. Optional: Default to false. +k8s:conversion-gen=false +optional

share_process_namespace: Option<bool>

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. +k8s:conversion-gen=false +optional

security_context: Option<PodSecurityContext>

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. +optional

image_pull_secrets: Vec<LocalObjectReference>

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 +optional +patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name

hostname: Option<String>

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

subdomain: Option<String>

If specified, the fully qualified Pod hostname will be “...svc.”. If not specified, the pod will not have a domainname at all. +optional

affinity: Option<Affinity>

If specified, the pod’s scheduling constraints +optional

scheduler_name: Option<String>

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

tolerations: Vec<Toleration>

If specified, the pod’s tolerations. +optional +listType=atomic

host_aliases: Vec<HostAlias>

HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. +optional +patchMergeKey=ip +patchStrategy=merge +listType=map +listMapKey=ip

priority_class_name: Option<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. +optional

priority: Option<i32>

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. +optional

dns_config: Option<PodDnsConfig>

Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. +optional

readiness_gates: Vec<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/580-pod-readiness-gates +optional +listType=atomic

runtime_class_name: Option<String>

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 +optional

enable_service_links: Option<bool>

EnableServiceLinks indicates whether information about services should be injected into pod’s environment variables, matching the syntax of Docker links. Optional: Defaults to true. +optional

preemption_policy: Option<String>

PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. +optional

overhead: BTreeMap<String, Quantity>

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 +optional

topology_spread_constraints: Vec<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. +optional +patchMergeKey=topologyKey +patchStrategy=merge +listType=map +listMapKey=topologyKey +listMapKey=whenUnsatisfiable

set_hostname_as_fqdn: Option<bool>

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. +optional

os: Option<PodOs>

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 +optional

host_users: Option<bool>

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. +k8s:conversion-gen=false +optional

scheduling_gates: Vec<PodSchedulingGate>

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.

+patchMergeKey=name +patchStrategy=merge +listType=map +listMapKey=name +optional

resource_claims: Vec<PodResourceClaim>

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.

+patchMergeKey=name +patchStrategy=merge,retainKeys +listType=map +listMapKey=name +featureGate=DynamicResourceAllocation +optional

resources: Option<ResourceRequirements>

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. TODO: For beta graduation, expand this comment with a detailed explanation.

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

+featureGate=PodLevelResources +optional

Implementations

impl PodSpec

pub fn restart_policy(&self) -> &str

Returns the value of restart_policy, or the default value if restart_policy is unset.

pub fn termination_grace_period_seconds(&self) -> i64

Returns the value of termination_grace_period_seconds, or the default value if termination_grace_period_seconds is unset.

pub fn active_deadline_seconds(&self) -> i64

Returns the value of active_deadline_seconds, or the default value if active_deadline_seconds is unset.

pub fn dns_policy(&self) -> &str

Returns the value of dns_policy, or the default value if dns_policy is unset.

pub fn service_account_name(&self) -> &str

Returns the value of service_account_name, or the default value if service_account_name is unset.

pub fn service_account(&self) -> &str

Returns the value of service_account, or the default value if service_account is unset.

pub fn node_name(&self) -> &str

Returns the value of node_name, or the default value if node_name is unset.

pub fn host_network(&self) -> bool

Returns the value of host_network, or the default value if host_network is unset.

pub fn host_pid(&self) -> bool

Returns the value of host_pid, or the default value if host_pid is unset.

pub fn host_ipc(&self) -> bool

Returns the value of host_ipc, or the default value if host_ipc is unset.

pub fn hostname(&self) -> &str

Returns the value of hostname, or the default value if hostname is unset.

pub fn subdomain(&self) -> &str

Returns the value of subdomain, or the default value if subdomain is unset.

pub fn scheduler_name(&self) -> &str

Returns the value of scheduler_name, or the default value if scheduler_name is unset.

pub fn automount_service_account_token(&self) -> bool

Returns the value of automount_service_account_token, or the default value if automount_service_account_token is unset.

pub fn priority_class_name(&self) -> &str

Returns the value of priority_class_name, or the default value if priority_class_name is unset.

pub fn priority(&self) -> i32

Returns the value of priority, or the default value if priority is unset.

pub fn share_process_namespace(&self) -> bool

Returns the value of share_process_namespace, or the default value if share_process_namespace is unset.

pub fn runtime_class_name(&self) -> &str

Returns the value of runtime_class_name, or the default value if runtime_class_name is unset.

pub fn enable_service_links(&self) -> bool

Returns the value of enable_service_links, or the default value if enable_service_links is unset.

pub fn preemption_policy(&self) -> &str

Returns the value of preemption_policy, or the default value if preemption_policy is unset.

pub fn set_hostname_as_fqdn(&self) -> bool

Returns the value of set_hostname_as_fqdn, or the default value if set_hostname_as_fqdn is unset.

pub fn host_users(&self) -> bool

Returns the value of host_users, or the default value if host_users is unset.

Trait Implementations

impl Clone for PodSpec

fn clone(&self) -> PodSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PodSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PodSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for PodSpec

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PodSpec

fn eq(&self, other: &PodSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PodSpec