Class V1StatefulSetSpec

A StatefulSetSpec is the specification of a StatefulSet.

Inheritance
object
V1StatefulSetSpec
Implements
Inherited Members
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
public record V1StatefulSetSpec : IEquatable<V1StatefulSetSpec>

Constructors

View Source

V1StatefulSetSpec()

Declaration
public V1StatefulSetSpec()
View Source

V1StatefulSetSpec(V1StatefulSetSpec)

Declaration
protected V1StatefulSetSpec(V1StatefulSetSpec original)
Parameters
Type Name Description
V1StatefulSetSpec original

Properties

View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

MinReadySeconds

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)

Declaration
[JsonPropertyName("minReadySeconds")]
public int? MinReadySeconds { get; set; }
Property Value
Type Description
int?
View Source

Ordinals

ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested.

Declaration
[JsonPropertyName("ordinals")]
public V1StatefulSetOrdinals Ordinals { get; set; }
Property Value
Type Description
V1StatefulSetOrdinals
View Source

PersistentVolumeClaimRetentionPolicy

persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down.

Declaration
[JsonPropertyName("persistentVolumeClaimRetentionPolicy")]
public V1StatefulSetPersistentVolumeClaimRetentionPolicy PersistentVolumeClaimRetentionPolicy { get; set; }
Property Value
Type Description
V1StatefulSetPersistentVolumeClaimRetentionPolicy
View Source

PodManagementPolicy

podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is OrderedReady, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is Parallel which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.

Declaration
[JsonPropertyName("podManagementPolicy")]
public string PodManagementPolicy { get; set; }
Property Value
Type Description
string
View Source

Replicas

replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.

Declaration
[JsonPropertyName("replicas")]
public int? Replicas { get; set; }
Property Value
Type Description
int?
View Source

RevisionHistoryLimit

revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.

Declaration
[JsonPropertyName("revisionHistoryLimit")]
public int? RevisionHistoryLimit { get; set; }
Property Value
Type Description
int?
View Source

Selector

selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

Declaration
[JsonPropertyName("selector")]
public V1LabelSelector Selector { get; set; }
Property Value
Type Description
V1LabelSelector
View Source

ServiceName

serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.

Declaration
[JsonPropertyName("serviceName")]
public string ServiceName { get; set; }
Property Value
Type Description
string
View Source

Template

template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format <statefulsetname>-<podindex>. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always".

Declaration
[JsonPropertyName("template")]
public V1PodTemplateSpec Template { get; set; }
Property Value
Type Description
V1PodTemplateSpec
View Source

UpdateStrategy

updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

Declaration
[JsonPropertyName("updateStrategy")]
public V1StatefulSetUpdateStrategy UpdateStrategy { get; set; }
Property Value
Type Description
V1StatefulSetUpdateStrategy
View Source

VolumeClaimTemplates

volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.

Declaration
[JsonPropertyName("volumeClaimTemplates")]
public IList<V1PersistentVolumeClaim> VolumeClaimTemplates { get; set; }
Property Value
Type Description
IList<V1PersistentVolumeClaim>

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
View Source

Equals(V1StatefulSetSpec?)

Declaration
public virtual bool Equals(V1StatefulSetSpec? other)
Parameters
Type Name Description
V1StatefulSetSpec other
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Operators

View Source

operator ==(V1StatefulSetSpec?, V1StatefulSetSpec?)

Declaration
public static bool operator ==(V1StatefulSetSpec? left, V1StatefulSetSpec? right)
Parameters
Type Name Description
V1StatefulSetSpec left
V1StatefulSetSpec right
Returns
Type Description
bool
View Source

operator !=(V1StatefulSetSpec?, V1StatefulSetSpec?)

Declaration
public static bool operator !=(V1StatefulSetSpec? left, V1StatefulSetSpec? right)
Parameters
Type Name Description
V1StatefulSetSpec left
V1StatefulSetSpec right
Returns
Type Description
bool

Implements