StatefulSet

apiVersion: apps/v1

import "k8s.io/api/apps/v1"

StatefulSet represents a set of pods with consistent identities. Identities are defined as:

• Network: A single stable DNS and hostname.
• Storage: As many VolumeClaims as requested.

The StatefulSet guarantees that a given network identity will always map to the same storage identity.

• apiVersion: apps/v1

• kind: StatefulSet

• metadata ()

  Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• spec ()

  Spec defines the desired identities of pods in this set.

• status (StatefulSetStatus)

  Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time.

A StatefulSetSpec is the specification of a StatefulSet.

• serviceName (string), required

  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.

• selector (LabelSelector), required

  selector is a label query over pods that should match the replica count. It must match the pod template’s labels. More info:

• template (PodTemplateSpec), required

  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”.

• updateStrategy (StatefulSetUpdateStrategy)

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

  StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

  • updateStrategy.type (string)

    Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.

  • updateStrategy.rollingUpdate (RollingUpdateStatefulSetStrategy)

    RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType.

    RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

    • updateStrategy.rollingUpdate.maxUnavailable (IntOrString)

      The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable.

      IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number.

    • updateStrategy.rollingUpdate.partition (int32)

      Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0.

• podManagementPolicy (string)

  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.

• revisionHistoryLimit (int32)

  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.

• 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.

• minReadySeconds (int32)

  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)

• persistentVolumeClaimRetentionPolicy (StatefulSetPersistentVolumeClaimRetentionPolicy)

  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. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha. +optional

  StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.

  • persistentVolumeClaimRetentionPolicy.whenDeleted (string)

    WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of Retain causes PVCs to not be affected by StatefulSet deletion. The Delete policy causes those PVCs to be deleted.

  • persistentVolumeClaimRetentionPolicy.whenScaled (string)

    WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of Retain causes PVCs to not be affected by a scaledown. The Delete policy causes the associated PVCs for any excess pods above the replica count to be deleted.

• ordinals (StatefulSetOrdinals)

  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. Using the ordinals field requires the StatefulSetStartOrdinal feature gate to be enabled, which is beta.

  StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet.

  • ordinals.start (int32)

    start is the number representing the first replica’s index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range: [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas). If unset, defaults to 0. Replica indices will be in the range: [0, .spec.replicas).

StatefulSetStatus represents the current state of a StatefulSet.

• replicas (int32), required

  replicas is the number of Pods created by the StatefulSet controller.

• readyReplicas (int32)

  readyReplicas is the number of pods created for this StatefulSet with a Ready Condition.

• currentReplicas (int32)

  currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.

• updatedReplicas (int32)

  updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

• availableReplicas (int32)

  Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset.

• collisionCount (int32)

  collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

• conditions ([]StatefulSetCondition)

  Patch strategy: merge on key type

  Represents the latest available observations of a statefulset’s current state.

  StatefulSetCondition describes the state of a statefulset at a certain point.

  • conditions.status (string), required

    Status of the condition, one of True, False, Unknown.

  • conditions.type (string), required

    Type of statefulset condition.

  • conditions.lastTransitionTime (Time)

    Last time the condition transitioned from one status to another.

    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

  • conditions.message (string)

    A human readable message indicating details about the transition.

  • conditions.reason (string)

    The reason for the condition’s last transition.

• currentRevision (string)

  currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).

• updateRevision (string)

  updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)

• observedGeneration (int64)

  observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet’s generation, which is updated on mutation by the API Server.

StatefulSetList is a collection of StatefulSets.

• apiVersion: apps/v1

• kind: StatefulSetList

• metadata (ListMeta)

  Standard list’s metadata. More info:

• items ([]StatefulSet), required

  Items is the list of stateful sets.

HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}

Parameters

• name (in path): string, required

  name of the StatefulSet

• namespace (in path): string, required

• pretty (in query): string

Response

200 (): OK

401: Unauthorized

get read status of the specified StatefulSet

HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status

Parameters

• name (in path): string, required

  name of the StatefulSet

• namespace (in path): string, required

• pretty (in query): string

  pretty

Response

200 (StatefulSet): OK

401: Unauthorized

list list or watch objects of kind StatefulSet

HTTP Request

GET /apis/apps/v1/namespaces/{namespace}/statefulsets

Parameters

• namespace (in path): string, required

  namespace

• allowWatchBookmarks (in query): boolean

• continue (in query): string

  continue

• fieldSelector (in query): string

• labelSelector (in query): string

  labelSelector

• limit (in query): integer

• pretty (in query): string

  pretty

• resourceVersion (in query): string

• resourceVersionMatch (in query): string

  resourceVersionMatch

• sendInitialEvents (in query): boolean

• timeoutSeconds (in query): integer

  timeoutSeconds

• watch (in query): boolean

Response

200 (): OK

401: Unauthorized

HTTP Request

GET /apis/apps/v1/statefulsets

Parameters

• allowWatchBookmarks (in query): boolean

• continue (in query): string

  continue

• fieldSelector (in query): string

• labelSelector (in query): string

  labelSelector

• limit (in query): integer

• pretty (in query): string

  pretty

• resourceVersion (in query): string

• resourceVersionMatch (in query): string

  resourceVersionMatch

• timeoutSeconds (in query): integer

• watch (in query): boolean

  watch

Response

200 (StatefulSetList): OK

401: Unauthorized

create create a StatefulSet

HTTP Request

POST /apis/apps/v1/namespaces/{namespace}/statefulsets

Parameters

• namespace (in path): string, required

  namespace

• body: , required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

• fieldValidation (in query): string

  fieldValidation

• pretty (in query): string

Response

200 (): OK

201 (StatefulSet): Created

202 (): Accepted

401: Unauthorized

update replace the specified StatefulSet

HTTP Request

PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}

Parameters

• name (in path): string, required

  name of the StatefulSet

• namespace (in path): string, required

• body: StatefulSet, required

• dryRun (in query): string

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

• pretty (in query): string

  pretty

Response

200 (StatefulSet): OK

201 (): Created

401: Unauthorized

HTTP Request

PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status

Parameters

• name of the StatefulSet

• namespace (in path): string, required

• body: StatefulSet, required

• dryRun (in query): string

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

• pretty (in query): string

  pretty

Response

200 (StatefulSet): OK

201 (): Created

401: Unauthorized

patch partially update the specified StatefulSet

HTTP Request

PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}

Parameters

• name (in path): string, required

  name of the StatefulSet

• namespace (in path): string, required

• body: Patch, required

• dryRun (in query): string

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

• force (in query): boolean

  force

• pretty (in query): string

Response

200 (): OK

201 (StatefulSet): Created

401: Unauthorized

patch partially update status of the specified StatefulSet

HTTP Request

PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status

Parameters

• name (in path): string, required

  name of the StatefulSet

• namespace (in path): string, required

  namespace

• body: , required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

• fieldValidation (in query): string

  fieldValidation

• force (in query): boolean

• pretty (in query): string

  pretty

Response

200 (StatefulSet): OK

201 (): Created

401: Unauthorized

HTTP Request

DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}

Parameters

• name (in path): string, required

  name of the StatefulSet

• namespace (in path): string, required

• body: DeleteOptions

• dryRun (in query): string

• gracePeriodSeconds (in query): integer

  gracePeriodSeconds

• pretty (in query): string

• propagationPolicy (in query): string

  propagationPolicy

Response

200 (Status): OK

202 (): Accepted

401: Unauthorized

delete collection of StatefulSet

HTTP Request

DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets

Parameters

• namespace (in path): string, required

• body: DeleteOptions

• continue (in query): string

• dryRun (in query): string

  dryRun

• fieldSelector (in query): string

• gracePeriodSeconds (in query): integer

  gracePeriodSeconds

• labelSelector (in query): string

• limit (in query): integer

  limit

• pretty (in query): string

• propagationPolicy (in query): string

  propagationPolicy

• resourceVersion (in query): string

• resourceVersionMatch (in query): string

  resourceVersionMatch

• sendInitialEvents (in query): boolean

• timeoutSeconds (in query): integer

  timeoutSeconds

Response

200 (Status): OK