API Ref v1.22 alpha.3
This commit is contained in:
@@ -6,7 +6,7 @@ api_metadata:
|
||||
content_type: "api_reference"
|
||||
description: "StatefulSet represents a set of pods with consistent identities."
|
||||
title: "StatefulSet"
|
||||
weight: 7
|
||||
weight: 6
|
||||
auto_generated: true
|
||||
---
|
||||
|
||||
@@ -43,6 +43,7 @@ The StatefulSet guarantees that a given network identity will always map to the
|
||||
|
||||
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
|
||||
|
||||
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
- **spec** (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSetSpec" >}}">StatefulSetSpec</a>)
|
||||
|
||||
@@ -112,6 +113,10 @@ A StatefulSetSpec is the specification of a StatefulSet.
|
||||
|
||||
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) This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -138,6 +143,10 @@ StatefulSetStatus represents the current state of a StatefulSet.
|
||||
|
||||
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. This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate. Remove omitempty when graduating to beta
|
||||
|
||||
- **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.
|
||||
@@ -204,9 +213,11 @@ StatefulSetList is a collection of StatefulSets.
|
||||
|
||||
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
|
||||
|
||||
Standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
|
||||
|
||||
- **items** ([]<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>), required
|
||||
|
||||
Items is the list of stateful sets.
|
||||
|
||||
|
||||
|
||||
@@ -627,6 +638,8 @@ PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
|
||||
|
||||
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Created
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
@@ -680,6 +693,8 @@ PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
|
||||
|
||||
200 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): OK
|
||||
|
||||
201 (<a href="{{< ref "../workload-resources/stateful-set-v1#StatefulSet" >}}">StatefulSet</a>): Created
|
||||
|
||||
401: Unauthorized
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user