From f5e9117013f2086dee68f9b6a11668afa5b44e41 Mon Sep 17 00:00:00 2001 From: Michael Date: Sat, 9 Jul 2022 11:55:52 +0800 Subject: [PATCH] [zh-cn] resync workload-resources/replication-controller-v1.md --- .../replication-controller-v1.md | 969 ++++++++++++++++++ 1 file changed, 969 insertions(+) create mode 100644 content/zh-cn/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md diff --git a/content/zh-cn/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md b/content/zh-cn/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md new file mode 100644 index 0000000000..ba4baaccb9 --- /dev/null +++ b/content/zh-cn/docs/reference/kubernetes-api/workload-resources/replication-controller-v1.md @@ -0,0 +1,969 @@ +--- +api_metadata: + apiVersion: "v1" + import: "k8s.io/api/core/v1" + kind: "ReplicationController" +content_type: "api_reference" +description: "ReplicationController 表示一个副本控制器的配置。" +title: "ReplicationController" +weight: 3 +--- + + +`apiVersion: v1` + +`import "k8s.io/api/core/v1"` + +## ReplicationController {#ReplicationController} + + +ReplicationController 表示一个副本控制器的配置。 + +
+ +- **apiVersion**: v1 + +- **kind**: ReplicationController + + +- **metadata** (}}">ObjectMeta) + + 如果 ReplicationController 的标签为空，则这些标签默认为与副本控制器管理的 Pod 相同。 + 标准的对象元数据。更多信息： + https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +- **spec** (}}">ReplicationControllerSpec) + + spec 定义副本控制器预期行为的规约。更多信息： + https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + + +- **status** (}}">ReplicationControllerStatus) + + status 是最近观测到的副本控制器的状态。此数据可能在某个时间窗之后过期。 + 该值由系统填充，只读。更多信息： + https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +## ReplicationControllerSpec {#ReplicationControllerSpec} + + +ReplicationControllerSpec 表示一个副本控制器的规约。 + +
+ + +- **selector** (map[string]string) + + selector 是针对 Pod 的标签查询，符合条件的 Pod 个数应与 replicas 匹配。 + 如果 selector 为空，则默认为出现在 Pod 模板中的标签。 + 如果置空以表示默认使用 Pod 模板中的标签，则标签的主键和取值必须匹配，以便由这个副本控制器进行控制。 + 更多信息： + https://kubernetes.io/zh-cn/docs/concepts/overview/working-with-objects/labels/#label-selectors + +- **template** (}}">PodTemplateSpec) + + template 是描述 Pod 的一个对象，将在检测到副本不足时创建此对象。 + 此字段优先于 templateRef。更多信息： + https://kubernetes.io/zh-cn/docs/concepts/workloads/controllers/replicationcontroller#pod-template + + +- **replicas** (int32) + + replicas 是预期副本的数量。这是一个指针，用于辨别显式零和未指定的值。默认为 1。更多信息： + https://kubernetes.io/zh-cn/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + +- **minReadySeconds** (int32) + + 新建的 Pod 在没有任何容器崩溃的情况下就绪并被系统视为可用的最短秒数。 + 默认为 0（Pod 就绪后即被视为可用）。 + +## ReplicationControllerStatus {#ReplicationControllerStatus} + + +ReplicationControllerStatus 表示一个副本控制器的当前状态。 + +
+ + +- **replicas** (int32)，必需 + + replicas 是最近观测到的副本数量。更多信息： + https://kubernetes.io/zh-cn/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller + +- **availableReplicas** (int32) + + 这个副本控制器可用副本（至少 minReadySeconds 才能就绪）的数量。 + + +- **readyReplicas** (int32) + + 此副本控制器所用的就绪副本的数量。 + +- **fullyLabeledReplicas** (int32) + + 标签与副本控制器的 Pod 模板标签匹配的 Pod 数量。 + + +- **conditions** ([]ReplicationControllerCondition) + + **补丁策略：按照键 `type` 合并** + + 表示副本控制器当前状态的最新可用观测值。 + + + **ReplicationControllerCondition 描述某个点的副本控制器的状态。** + + + + - **conditions.status** (string)，必需 + + 状况的状态，取值为 True、False 或 Unknown 之一。 + + - **conditions.type** (string)，必需 + + 副本控制器状况的类型。 + + + + - **conditions.lastTransitionTime** (Time) + + 状况上次从一个状态转换为另一个状态的时间。 + + + **Time 是对 time.Time 的封装。Time 支持对 YAML 和 JSON 进行正确封包。 + 为 time 包的许多函数方法提供了封装器。** + + + - **conditions.message** (string) + + 这是一条人类可读的消息，指示有关上次转换的详细信息。 + + - **conditions.reason** (string) + + 状况上次转换的原因。 + + +- **observedGeneration** (int64) + + observedGeneration 反映了最近观测到的副本控制器的生成情况。 + +## ReplicationControllerList {#ReplicationControllerList} + +ReplicationControllerList 是副本控制器的集合。 + +
+ +- **apiVersion**: v1 + +- **kind**: ReplicationControllerList + + +- **metadata** (}}">ListMeta) + + 标准的列表元数据。更多信息： + https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + +- **items** ([]}}">ReplicationController)，必需 + + 副本控制器的列表。更多信息： + https://kubernetes.io/zh-cn/docs/concepts/workloads/controllers/replicationcontroller + + +## 操作 {#Operations} + +
+ +### `get` 读取指定的 ReplicationController + +#### HTTP 请求 + +GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name} + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ReplicationController 的名称 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ReplicationController): OK + +401: Unauthorized + + +### `get` 读取指定的 ReplicationController 的状态 + +#### HTTP 请求 + +GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ReplicationController 的名称 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ReplicationController): OK + +401: Unauthorized + + +### `list` 列出或监视 ReplicationController 类别的对象 + +#### HTTP 请求 + +GET /api/v1/namespaces/{namespace}/replicationcontrollers + + +#### 参数 + +- **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 + +- **timeoutSeconds** (**查询参数**): integer + + }}">timeoutSeconds + +- **watch** (**查询参数**): boolean + + }}">watch + + +#### 响应 + +200 (}}">ReplicationControllerList): OK + +401: Unauthorized + + +### `list` 列出或监视 ReplicationController 类别的对象 + +#### HTTP 请求 + +GET /api/v1/replicationcontrollers + + +#### 参数 + +- **allowWatchBookmarks** (**查询参数**): boolean + + }}">allowWatchBookmarks + +- **continue** (**查询参数**): string + + }}">continue + +- **fieldSelector** (**查询参数**): string + + }}">fieldSelector + +- **labelSelector** (**查询参数**): string + + }}">labelSelector + +- **limit** (**查询参数**): integer + + }}">limit + +- **pretty** (**查询参数**): string + + }}">pretty + +- **resourceVersion** (**查询参数**): string + + }}">resourceVersion + +- **resourceVersionMatch** (**查询参数**): string + + }}">resourceVersionMatch + +- **timeoutSeconds** (**查询参数**): integer + + }}">timeoutSeconds + +- **watch** (**查询参数**): boolean + + }}">watch + + +#### 响应 + +200 (}}">ReplicationControllerList): OK + +401: Unauthorized + + +### `create` 创建 ReplicationController + +#### HTTP 请求 + +POST /api/v1/namespaces/{namespace}/replicationcontrollers + + +#### 参数 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">ReplicationController，必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ReplicationController): OK + +201 (}}">ReplicationController): Created + +202 (}}">ReplicationController): Accepted + +401: Unauthorized + + +### `update` 替换指定的 ReplicationController + +#### HTTP 请求 + +PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name} + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ReplicationController 的名称 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">ReplicationController，必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ReplicationController): OK + +201 (}}">ReplicationController): Created + +401: Unauthorized + + +### `update` 替换指定的 ReplicationController 的状态 + +#### HTTP 请求 + +PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ReplicationController 的名称 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">ReplicationController，必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ReplicationController): OK + +201 (}}">ReplicationController): Created + +401: Unauthorized + + +### `patch` 部分更新指定的 ReplicationController + +#### HTTP 请求 + +PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name} + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ReplicationController 的名称 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">Patch，必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **force** (**查询参数**): boolean + + }}">force + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ReplicationController): OK + +201 (}}">ReplicationController): Created + +401: Unauthorized + + +### `patch` 部分更新指定的 ReplicationController 的状态 + +#### HTTP 请求 + +PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ReplicationController 的名称 + +- **namespace** (**路径参数**): string，必需 + + }}">namespace + +- **body**: }}">Patch，必需 + +- **dryRun** (**查询参数**): string + + }}">dryRun + +- **fieldManager** (**查询参数**): string + + }}">fieldManager + +- **fieldValidation** (**查询参数**): string + + }}">fieldValidation + +- **force** (**查询参数**): boolean + + }}">force + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">ReplicationController): OK + +201 (}}">ReplicationController): Created + +401: Unauthorized + + +### `delete` 删除 ReplicationController + +#### HTTP 请求 + +DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name} + + +#### 参数 + +- **name** (**路径参数**): string，必需 + + ReplicationController 的名称 + +- **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` 删除 ReplicationController 的集合 + +#### HTTP 请求 + +DELETE /api/v1/namespaces/{namespace}/replicationcontrollers + + +#### 参数 + +- **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 + +- **timeoutSeconds** (**查询参数**): integer + + }}">timeoutSeconds + + +#### 响应 + +200 (}}">Status): OK + +401: Unauthorized