---
api_metadata:
apiVersion: "apps/v1"
import: "k8s.io/api/apps/v1"
kind: "StatefulSet"
content_type: "api_reference"
description: "StatefulSet 表示一组具有一致身份的 Pod"
title: "StatefulSet"
weight: 6
auto_generated: true
---
`apiVersion: apps/v1`
`import "k8s.io/api/apps/v1"`
## StatefulSet {#StatefulSet}
StatefulSet 表示一组具有一致身份的 Pod。身份定义为：
- 网络：一个稳定的 DNS 和主机名。
- 存储：根据要求提供尽可能多的 VolumeClaim。
StatefulSet 保证给定的网络身份将始终映射到相同的存储身份。
- **apiVersion**: apps/v1
- **kind**: StatefulSet
- **metadata** (}}">ObjectMeta)
标准的对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata。
- **spec** (}}">StatefulSetSpec)
spec 定义集合中 Pod 的预期身份。
- **status** (}}">StatefulSetStatus)
status 是 StatefulSet 中 Pod 的当前状态，此数据可能会在某个时间窗口内过时。
## StatefulSetSpec {#StatefulSetSpec}
StatefulSetSpec 是 StatefulSet 的规约。
- **serviceName** (string), 必需
serviceName 是管理此 StatefulSet 服务的名称。
该服务必须在 StatefulSet 之前即已存在，并负责该集合的网络标识。
Pod 会获得符合以下模式的 DNS/主机名： pod-specific-string.serviceName.default.svc.cluster.local。
其中 “pod-specific-string” 由 StatefulSet 控制器管理。
- **selector** (}}">LabelSelector), 必需
selector 是对 Pod 的标签查询，查询结果应该匹配副本个数。
此选择算符必须与 Pod 模板中的 label 匹配。
更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
- **template** (}}">PodTemplateSpec), 必需
template 是用来描述 Pod 的对象，检测到副本不足时将创建所描述的 Pod。
经由 StatefulSet 创建的每个 Pod 都将满足这个模板，但与 StatefulSet 的其余 Pod 相比，每个 Pod 具有唯一的标识。
每个 Pod 将以 \-\ 格式命名。
例如，名为 "web" 且索引号为 "3" 的 StatefulSet 中的 Pod 将被命名为 "web-3"。
`template.spec.restartPolicy` 唯一被允许的值是 `Always`。
- **replicas** (int32)
replicas 是给定模板的所需的副本数。之所以称作副本，是因为它们是相同模板的实例，
不过各个副本也具有一致的身份。如果未指定，则默认为 1。
- **updateStrategy** (StatefulSetUpdateStrategy)
updateStrategy 是一个 StatefulSetUpdateStrategy，表示当对 template 进行修订时，用何种策略更新 StatefulSet 中的 Pod 集合。
**StatefulSetUpdateStrategy 表示 StatefulSet 控制器将用于执行更新的策略。其中包括为指定策略执行更新所需的额外参数。**
- **updateStrategy.type** (string)
type 表示 StatefulSetUpdateStrategy 的类型，默认为 RollingUpdate。
- **updateStrategy.rollingUpdate** (RollingUpdateStatefulSetStrategy)
当 type 为 RollingUpdate 时，使用 rollingUpdate 来传递参数。
**RollingUpdateStatefulSetStrategy 用于为 rollingUpdate 类型的更新传递参数。**
- **updateStrategy.rollingUpdate.maxUnavailable** (IntOrString)
更新期间不可用的 Pod 个数上限。取值可以是绝对数量（例如：5）或所需 Pod 的百分比（例如：10%）。
绝对数是通过四舍五入的百分比计算得出的。不能为 0，默认为 1。
此字段为 Alpha 级别，仅被启用 MaxUnavailableStatefulSet 特性的服务器支持。
此字段适用于 0 到 replicas-1 范围内的所有 Pod。这意味着如果在 0 到 replicas-1 范围内有任何不可用的 Pod，
这些 Pod 将被计入 maxUnavailable 中。
**IntOrString 是一种可以包含 int32 或字符串数值的类型。在 JSON 或 YAML 编组和解组时，**
**会生成或使用内部类型。例如，此类型允许你定义一个可以接受名称或数字的 JSON 字段。**
- **updateStrategy.rollingUpdate.partition** (int32)
partition 表示 StatefulSet 应该被分区进行更新时的序数。
在滚动更新期间，序数在 replicas-1 和 partition 之间的所有 Pod 都会被更新。
序数在 partition-1 和 0 之间的所有 Pod 保持不变。
这一属性有助于进行金丝雀部署。默认值为 0。
- **podManagementPolicy** (string)
podManagementPolicy 控制在初始规模扩展期间、替换节点上的 Pod 或缩减集合规模时如何创建 Pod。
默认策略是 “OrderedReady”，各个 Pod 按升序创建的（pod-0，然后是pod-1 等），
控制器将等到每个 Pod 都准备就绪后再继续。缩小集合规模时，Pod 会以相反的顺序移除。
另一种策略是 “Parallel”，意味着并行创建 Pod 以达到预期的规模而无需等待，并且在缩小规模时将立即删除所有 Pod。
- **revisionHistoryLimit** (int32)
revisionHistoryLimit 是在 StatefulSet 的修订历史中维护的修订个数上限。
修订历史中包含并非由当前所应用的 StatefulSetSpec 版本未表示的所有修订版本。默认值为 10。
- **volumeClaimTemplates** ([]}}">PersistentVolumeClaim)
volumeClaimTemplates 是允许 Pod 引用的申领列表。
StatefulSet controller 负责以维持 Pod 身份不变的方式将网络身份映射到申领之上。
此列表中的每个申领至少必须在模板的某个容器中存在匹配的（按 name 匹配）volumeMount。
此列表中的申领优先于模板中具有相同名称的所有卷。
- **minReadySeconds** (int32)
新创建的 Pod 应准备就绪（其任何容器都未崩溃）的最小秒数，以使其被视为可用。
默认为 0（Pod 准备就绪后将被视为可用）。
- **persistentVolumeClaimRetentionPolicy** (StatefulSetPersistentVolumeClaimRetentionPolicy)
persistentVolumeClaimRetentionPolicy 描述从 VolumeClaimTemplates 创建的持久卷申领的生命周期。
默认情况下，所有持久卷申领都根据需要创建并被保留到手动删除。
此策略允许更改申领的生命周期，例如在 StatefulSet 被删除或其中 Pod 集合被缩容时删除持久卷申领。
此属性需要启用 StatefulSetAutoDeletePVC 特性门控。特性处于 Alpha 阶段。可选。
**StatefulSetPersistentVolumeClaimRetentionPolicy 描述了用于从 StatefulSet VolumeClaimTemplate 创建的 PVC 的策略**
- **persistentVolumeClaimRetentionPolicy.whenDeleted** (string)
whenDeleted 指定当 StatefulSet 被删除时，基于 StatefulSet VolumeClaimTemplates 所创建的 PVC 会发生什么。
默认策略 `Retain` 使 PVC 不受 StatefulSet 被删除的影响。`Delete` 策略会导致这些 PVC 也被删除。
- **persistentVolumeClaimRetentionPolicy.whenScaled** (string)
whenScaled 指定当 StatefulSet 缩容时，基于 StatefulSet volumeClaimTemplates 创建的 PVC 会发生什么。
默认策略 `Retain` 使 PVC 不受缩容影响。 `Delete` 策略会导致超出副本个数的所有的多余 Pod 所关联的 PVC 被删除。
- **ordinals** (StatefulSetOrdinals)
ordinals 控制 StatefulSet 中副本索引的编号。
默认序数行为是将索引 "0" 设置给第一个副本，对于每个额外请求的副本，该索引加一。
使用 ordinals 字段需要启用 Beta 级别的 StatefulSetStartOrdinal 特性门控。
**StatefulSetOrdinals 描述此 StatefulSet 中用于副本序数赋值的策略。**
- **ordinals.start** (int32)
start 是代表第一个副本索引的数字。它可用于从替代索引（例如：从 1 开始索引）而非默认的从 0 索引来为副本设置编号，
还可用于编排从一个 StatefulSet 到另一个 StatefulSet 的渐进式副本迁移动作。如果设置了此值，副本索引范围为
[.spec.ordinals.start, .spec.ordinals.start + .spec.replicas)。如果不设置，则默认为 0。
副本索引范围为 [0, .spec.replicas)。
## StatefulSetStatus {#StatefulSetStatus}
StatefulSetStatus 表示 StatefulSet 的当前状态。
- **replicas** (int32), 必需
replicas 是 StatefulSet 控制器创建的 Pod 个数。
- **readyReplicas** (int32)
readyReplicas 是为此 StatefulSet 创建的、状况为 Ready 的 Pod 个数。
- **currentReplicas** (int32)
currentReplicas 是 StatefulSet 控制器根据 currentReplicas 所指的 StatefulSet 版本创建的 Pod 个数。
- **updatedReplicas** (int32)
updatedReplicas 是 StatefulSet 控制器根据 updateRevision 所指的 StatefulSet 版本创建的 Pod 个数。
- **availableReplicas** (int32)
此 StatefulSet 所对应的可用 Pod 总数（就绪时长至少为 minReadySeconds）。
- **collisionCount** (int32)
collisionCount 是 StatefulSet 的哈希冲突计数。
StatefulSet controller 在需要为最新的 controllerRevision 创建名称时使用此字段作为避免冲突的机制。
- **conditions** ([]StatefulSetCondition)
**补丁策略：根据 `type` 键执行合并操作**
表示 StatefulSet 当前状态的最新可用观察结果。
**StatefulSetCondition 描述了 StatefulSet 在某个点的状态。**
- **conditions.status** (string), 必需
状况的状态为 True、False、Unknown 之一。
- **conditions.type** (string), 必需
StatefulSet 状况的类型。
- **conditions.lastTransitionTime** (Time)
最近一次状况从一种状态转换到另一种状态的时间。
**Time 是 time.Time 的包装器，它支持对 YAML 和 JSON 的正确编组。**
**time 包的许多工厂方法提供了包装器。**
- **conditions.message** (string)
一条人类可读的消息，指示有关转换的详细信息。
- **conditions.reason** (string)
状况最后一次转换的原因。
- **currentRevision** (string)
currentRevision，如果不为空，表示用于在序列 [0,currentReplicas) 之间生成 Pod 的 StatefulSet 的版本。
- **updateRevision** (string)
updateRevision，如果不为空，表示用于在序列 [replicas-updatedReplicas,replicas) 之间生成 Pod 的 StatefulSet 的版本。
- **observedGeneration** (int64)
observedGeneration 是 StatefulSet 的最新一代。它对应于 StatefulSet 的代数，由 API 服务器在变更时更新。
## StatefulSetList {#StatefulSetList}
StatefulSetList 是 StatefulSet 的集合。
- **apiVersion**: apps/v1
- **kind**: StatefulSetList
- **metadata** (}}">ListMeta)
标准的对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- **items** ([]}}">StatefulSet), 必需
items 是 StatefulSet 的列表。
## 操作 {#operations}
### `get` 读取指定的 StatefulSet
#### HTTP 请求
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### 参数
- **name** (**路径参数**): string, 必需
StatefulSet 的名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">StatefulSet): OK
401: Unauthorized
### `get` 读取指定 StatefulSet 的状态
#### HTTP 请求
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### 参数
- **name** (**路径参数**): string, 必需
StatefulSet 的名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">StatefulSet): OK
401: Unauthorized
### `list` 列出或监视 StatefulSet 类型的对象
#### HTTP 请求
GET /apis/apps/v1/namespaces/{namespace}/statefulsets
#### 参数
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **allowWatchBookmarks** (**查询参数**): boolean
}}">allowWatchBookmarks
- **continue** (**查询参数**): string
}}">continue
- **fieldSelector** (**查询参数**): string
}}">fieldSelector
- **labelSelector** (**查询参数**): string
}}">labelSelector
- **limit** (**查询参数**): integer
}}">limit
- **pretty** (**查询参数**): string
}}">pretty
- **resourceVersion** (**查询参数**): string
}}">resourceVersion
- **resourceVersionMatch** (**查询参数**): string
}}">resourceVersionMatch
- **sendInitialEvents** (**查询参数**): boolean
}}">sendInitialEvents
- **timeoutSeconds** (**查询参数**): integer
}}">timeoutSeconds
- **watch** (**查询参数**): boolean
}}">watch
#### 响应
200 (}}">StatefulSetList): OK
401: Unauthorized
### `list` 列出或监视 StatefulSet 类型的对象
#### HTTP 请求
GET /apis/apps/v1/statefulsets
#### 参数
- **allowWatchBookmarks** (**查询参数**): boolean
}}">allowWatchBookmarks
- **continue** (**查询参数**): string
}}">continue
- **fieldSelector** (**查询参数**): string
}}">fieldSelector
- **labelSelector** (**查询参数**): string
}}">labelSelector
- **limit** (**查询参数**): integer
}}">limit
- **pretty** (**查询参数**): string
}}">pretty
- **resourceVersion** (**查询参数**): string
}}">resourceVersion
- **resourceVersionMatch** (**查询参数**): string
}}">resourceVersionMatch
- **sendInitialEvents** (**查询参数**): boolean
}}">sendInitialEvents
- **timeoutSeconds** (**查询参数**): integer
}}">timeoutSeconds
- **watch** (**查询参数**): boolean
}}">watch
#### 响应
200 (}}">StatefulSetList): OK
401: Unauthorized
### `create` 创建一个 StatefulSet
#### HTTP 请求
POST /apis/apps/v1/namespaces/{namespace}/statefulsets
#### 参数
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">StatefulSet, 必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">StatefulSet): OK
201 (}}">StatefulSet): Created
202 (}}">StatefulSet): Accepted
401: Unauthorized
### `update` 替换指定的 StatefulSet
#### HTTP 请求
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### 参数
- **name** (**路径参数**): string, 必需
StatefulSet 的名称 。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">StatefulSet, 必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">StatefulSet): OK
201 (}}">StatefulSet): Created
401: Unauthorized
### `update` 替换指定 StatefulSet 的状态
#### HTTP 请求
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### 参数
- **name** (**路径参数**): string, 必需
StatefulSet 的名称。
- **namespace** (**路径参数**): string, required
}}">namespace
- **body**: }}">StatefulSet, 必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">StatefulSet): OK
201 (}}">StatefulSet): Created
401: Unauthorized
### `patch` 部分更新指定的 StatefulSet
#### HTTP 请求
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### 参数
- **name** (**路径参数**): string, 必需
StatefulSet 的名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">Patch, 必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **force** (**查询参数**): boolean
}}">force
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">StatefulSet): OK
201 (}}">StatefulSet): Created
401: Unauthorized
### `patch` 部分更新指定 StatefulSet 的状态
#### HTTP 请求
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
#### 参数
- **name** (**路径参数**): string, 必需
StatefulSet 的名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">Patch, 必需
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldManager** (**查询参数**): string
}}">fieldManager
- **fieldValidation** (**查询参数**): string
}}">fieldValidation
- **force** (**查询参数**): boolean
}}">force
- **pretty** (**查询参数**): string
}}">pretty
#### 响应
200 (}}">StatefulSet): OK
201 (}}">StatefulSet): Created
401: Unauthorized
### `delete` 删除一个 StatefulSet
#### HTTP 请求
DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
#### 参数
- **name** (**路径参数**): string, 必需
StatefulSet 的名称。
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">DeleteOptions
- **dryRun** (**查询参数**): string
}}">dryRun
- **gracePeriodSeconds** (**查询参数**): integer
}}">gracePeriodSeconds
- **pretty** (**查询参数**): string
}}">pretty
- **propagationPolicy** (**查询参数**): string
}}">propagationPolicy
#### 响应
200 (}}">Status): OK
202 (}}">Status): Accepted
401: Unauthorized
### `deletecollection` 删除 StatefulSet 的集合
#### HTTP 请求
DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets
#### 参数
- **namespace** (**路径参数**): string, 必需
}}">namespace
- **body**: }}">DeleteOptions
- **continue** (**查询参数**): string
}}">continue
- **dryRun** (**查询参数**): string
}}">dryRun
- **fieldSelector** (**查询参数**): string
}}">fieldSelector
- **gracePeriodSeconds** (**查询参数**): integer
}}">gracePeriodSeconds
- **labelSelector** (**查询参数**): string
}}">labelSelector
- **limit** (**查询参数**): integer
}}">limit
- **pretty** (**查询参数**): string
}}">pretty
- **propagationPolicy** (**查询参数**): string
}}">propagationPolicy
- **resourceVersion** (**查询参数**): string
}}">resourceVersion
- **resourceVersionMatch** (**查询参数**): string
}}">resourceVersionMatch
- **sendInitialEvents** (**查询参数**): boolean
}}">sendInitialEvents
- **timeoutSeconds** (**查询参数**): integer
}}">timeoutSeconds
#### 响应
200 (}}">Status): OK
401: Unauthorized