Class V1PodSpec
PodSpec is a description of a pod.
Assembly: KubernetesClient.dll
Syntax
public record V1PodSpec : IEquatable<V1PodSpec>
Constructors
View Source
V1PodSpec()
Declaration
View Source
V1PodSpec(V1PodSpec)
Declaration
protected V1PodSpec(V1PodSpec original)
Parameters
Properties
View Source
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.
Declaration
[JsonPropertyName("activeDeadlineSeconds")]
public long? ActiveDeadlineSeconds { get; set; }
Property Value
View Source
Affinity
If specified, the pod's scheduling constraints
Declaration
[JsonPropertyName("affinity")]
public V1Affinity Affinity { get; set; }
Property Value
View Source
AutomountServiceAccountToken
AutomountServiceAccountToken indicates whether a service account token should be
automatically mounted.
Declaration
[JsonPropertyName("automountServiceAccountToken")]
public bool? AutomountServiceAccountToken { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("containers")]
public IList<V1Container> Containers { get; set; }
Property Value
View Source
DnsConfig
Specifies the DNS parameters of a pod. Parameters specified here will be merged
to the generated DNS configuration based on DNSPolicy.
Declaration
[JsonPropertyName("dnsConfig")]
public V1PodDNSConfig DnsConfig { get; set; }
Property Value
View Source
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'.
Declaration
[JsonPropertyName("dnsPolicy")]
public string DnsPolicy { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("enableServiceLinks")]
public bool? EnableServiceLinks { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("ephemeralContainers")]
public IList<V1EphemeralContainer> EphemeralContainers { get; set; }
Property Value
View Source
EqualityContract
Declaration
protected virtual Type EqualityContract { get; }
Property Value
View Source
HostAliases
HostAliases is an optional list of hosts and IPs that will be injected into the
pod's hosts file if specified.
Declaration
[JsonPropertyName("hostAliases")]
public IList<V1HostAlias> HostAliases { get; set; }
Property Value
View Source
HostIPC
Use the host's ipc namespace. Optional: Default to false.
Declaration
[JsonPropertyName("hostIPC")]
public bool? HostIPC { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("hostNetwork")]
public bool? HostNetwork { get; set; }
Property Value
View Source
HostPID
Use the host's pid namespace. Optional: Default to false.
Declaration
[JsonPropertyName("hostPID")]
public bool? HostPID { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("hostUsers")]
public bool? HostUsers { get; set; }
Property Value
View Source
Hostname
Specifies the hostname of the Pod If not specified, the pod's hostname will be
set to a system-defined value.
Declaration
[JsonPropertyName("hostname")]
public string Hostname { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("hostnameOverride")]
public string HostnameOverride { get; set; }
Property Value
View Source
ImagePullSecrets
Declaration
[JsonPropertyName("imagePullSecrets")]
public IList<V1LocalObjectReference> ImagePullSecrets { get; set; }
Property Value
View Source
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/
Declaration
[JsonPropertyName("initContainers")]
public IList<V1Container> InitContainers { get; set; }
Property Value
View Source
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
Declaration
[JsonPropertyName("nodeName")]
public string NodeName { get; set; }
Property Value
View Source
NodeSelector
Declaration
[JsonPropertyName("nodeSelector")]
public IDictionary<string, string> NodeSelector { get; set; }
Property Value
View Source
Os
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.resources -
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
Declaration
[JsonPropertyName("os")]
public V1PodOS Os { get; set; }
Property Value
View Source
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
Declaration
[JsonPropertyName("overhead")]
public IDictionary<string, ResourceQuantity> Overhead { get; set; }
Property Value
View Source
PreemptionPolicy
PreemptionPolicy is the Policy for preempting pods with lower priority. One of
Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
Declaration
[JsonPropertyName("preemptionPolicy")]
public string PreemptionPolicy { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("priority")]
public int? Priority { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("priorityClassName")]
public string PriorityClassName { get; set; }
Property Value
View Source
ReadinessGates
Declaration
[JsonPropertyName("readinessGates")]
public IList<V1PodReadinessGate> ReadinessGates { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("resourceClaims")]
public IList<V1PodResourceClaim> ResourceClaims { get; set; }
Property Value
View Source
Resources
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",
"memory" and "hugepages-" 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.
Declaration
[JsonPropertyName("resources")]
public V1ResourceRequirements Resources { get; set; }
Property Value
View Source
RestartPolicy
Declaration
[JsonPropertyName("restartPolicy")]
public string RestartPolicy { get; set; }
Property Value
View Source
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
Declaration
[JsonPropertyName("runtimeClassName")]
public string RuntimeClassName { get; set; }
Property Value
View Source
SchedulerName
If specified, the pod will be dispatched by specified scheduler. If not
specified, the pod will be dispatched by default scheduler.
Declaration
[JsonPropertyName("schedulerName")]
public string SchedulerName { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("schedulingGates")]
public IList<V1PodSchedulingGate> SchedulingGates { get; set; }
Property Value
View Source
SecurityContext
SecurityContext holds pod-level security attributes and common container
settings. Optional: Defaults to empty. See type description for default values
of each field.
Declaration
[JsonPropertyName("securityContext")]
public V1PodSecurityContext SecurityContext { get; set; }
Property Value
View Source
ServiceAccount
DeprecatedServiceAccount is a deprecated alias for ServiceAccountName.
Deprecated: Use serviceAccountName instead.
Declaration
[JsonPropertyName("serviceAccount")]
public string ServiceAccount { get; set; }
Property Value
View Source
ServiceAccountName
Declaration
[JsonPropertyName("serviceAccountName")]
public string ServiceAccountName { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("setHostnameAsFQDN")]
public bool? SetHostnameAsFQDN { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("shareProcessNamespace")]
public bool? ShareProcessNamespace { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("subdomain")]
public string Subdomain { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("terminationGracePeriodSeconds")]
public long? TerminationGracePeriodSeconds { get; set; }
Property Value
View Source
Tolerations
If specified, the pod's tolerations.
Declaration
[JsonPropertyName("tolerations")]
public IList<V1Toleration> Tolerations { get; set; }
Property Value
View Source
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.
Declaration
[JsonPropertyName("topologySpreadConstraints")]
public IList<V1TopologySpreadConstraint> TopologySpreadConstraints { get; set; }
Property Value
View Source
Volumes
Declaration
[JsonPropertyName("volumes")]
public IList<V1Volume> Volumes { get; set; }
Property Value
Methods
View Source
Equals(object?)
Declaration
public override bool Equals(object? obj)
Parameters
| Type |
Name |
Description |
| object |
obj |
|
Returns
Overrides
View Source
Equals(V1PodSpec?)
Declaration
public virtual bool Equals(V1PodSpec? other)
Parameters
Returns
View Source
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
View Source
PrintMembers(StringBuilder)
Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Returns
View Source
ToString()
Declaration
public override string ToString()
Returns
Overrides
Operators
View Source
operator ==(V1PodSpec?, V1PodSpec?)
Declaration
public static bool operator ==(V1PodSpec? left, V1PodSpec? right)
Parameters
Returns
View Source
operator !=(V1PodSpec?, V1PodSpec?)
Declaration
public static bool operator !=(V1PodSpec? left, V1PodSpec? right)
Parameters
Returns
Implements