红帽全球峰会18.12. Etcd [operator.openshift.io/v1]
- 描述
- etcd 提供配置 Operator 来管理 etcd 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象 - 必填
-
spec
-
18.12.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| |
|
|
|
18.12.1.1. .spec
- 描述
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| failedRevisionLimit 是要保留在磁盘和 api -1 = unlimited, 0 或 unset = 5 （默认）失败的静态 pod 安装程序修订版本的数量 |
|
|
| forceRedeploymentReason 可以用来通过提供唯一字符串来强制重新部署操作对象。这提供了启动之前失败的部署的机制，并提供了您认为该时间将正常工作的原因，而不是在同一配置中再次失败的原因。 |
|
|
| logLevel 是针对整个组件的意图日志。它并不提供精细的控制，但管理操作器必须为其操作对象解释的粒度日志记录选择的简单方法。有效值为："Normal", "Debug", " Trace", " TraceAll"。默认为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该如何管理组件 |
|
| `` | observedConfig 包含控制器从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 级别的输入 |
|
|
| operatorLogLevel 是 Operator 本身的基于日志的意图。它并不提供精细的控制，但是管理操作器必须自行解释的粒度日志记录选择的简单方法。有效值为："Normal", "Debug", " Trace", " TraceAll"。默认为 "Normal"。 |
|
|
| succeededRevisionLimit 是成功静态 pod 安装程序修订版本的数量，用于保存在磁盘上，api -1 = unlimited, 0 或 unset = 5 （默认） |
|
| `` | unsupportedConfigOverrides 包含一个稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖它的字段，它将以以下顺序结束：1。硬编码的默认值 2. observedConfig 3. unsupportedConfigOverrides |
18.12.1.2. .status
- 描述
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定何时需要协调项目，或者以需要反应的方式更改项目。 |
|
|
| GenerationStatus 跟踪给定资源的生成，以便可以做出有关强制更新的决策。 |
|
|
| latestAvailableRevision 是最新部署的 deploymentID |
|
|
| latestAvailableRevisionReason 描述了最新部署的详细原因 |
|
|
| nodeStatuses 跟踪单个节点的部署值和错误 |
|
|
| NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。 |
|
|
| observedGeneration 是您已处理的最后生成变化 |
|
|
| readyReplicas 指示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用于的级别 |
18.12.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
18.12.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
18.12.1.5. .status.generations
- 描述
- 生成用于确定何时需要协调项目，或者以需要反应的方式更改项目。
- 类型
-
array
18.12.1.6. .status.generations[]
- 描述
- GenerationStatus 跟踪给定资源的生成，以便可以做出有关强制更新的决策。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| group 是您要跟踪的项的组 |
|
|
| hash 是为没有生成的资源设置的可选字段，内容敏感，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的项的名称 |
|
|
| 命名空间是您跟踪的事情的位置 |
|
|
| Resource 是您要跟踪的事情的资源类型 |
18.12.1.7. .status.nodeStatuses
- 描述
- nodeStatuses 跟踪单个节点的部署值和错误
- 类型
-
array
18.12.1.8. .status.nodeStatuses[]
- 描述
- NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| currentRevision 是最近成功部署的生成 |
|
|
| lastFailedCount 是最后一次失败的修订版本的安装程序 pod 的频率。 |
|
|
| lastFailedReason 是一个机器可读失败原因字符串。 |
|
|
| lastFailedRevision 是我们尝试和无法部署的部署的生成。 |
|
|
| lastFailedRevisionErrors 是 lastFailedRevision 中引用的失败部署期间人类可读的错误列表。 |
|
|
| lastFailedTime 是最后一次失败的修订版本失败的时间。 |
|
|
| lastFallbackCount 是上一个修订版本的回退频率。 |
|
|
| nodeName 是节点的名称 |
|
|
| targetRevision 是我们尝试应用的部署的生成 |
18.12.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/etcds-
DELETE：删除 Etcd 的集合 -
GET: 列出 Etcd 类型的对象 -
POST：创建 Etcd
-
/apis/operator.openshift.io/v1/etcds/{name}-
DELETE：删除 Etcd -
GET：读取指定的 Etcd -
PATCH：部分更新指定的 Etcd -
PUT：替换指定的 Etcd
-
/apis/operator.openshift.io/v1/etcds/{name}/status-
GET：指定 Etcd 的读取状态 -
PATCH：部分更新指定 Etcd 的状态 -
PUT: 替换指定 Etcd 的状态
-
18.12.2.1. /apis/operator.openshift.io/v1/etcds
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果 'true'，则输出被用户友善。 |
- HTTP 方法
-
DELETE - 描述
- 删除 Etcd 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须在没有 continue 字段的情况下重启其列表。否则，客户端可能会发送另一个列表请求，并带有 410 错误收到的令牌，服务器将通过从下一个密钥开始的列表进行响应，但从最新的快照（从最后一个列表结果中不一致） - 在第一个列表请求后创建、修改或删除的对象将包含在响应中，只要其密钥在"next key"后。 当 watch 为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视，而不丢失任何修改。 |
|
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 continue 字段为空，客户端可能会假设没有更多可用的结果。如果 watch 为 true，则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象，则返回第一次列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。 |
|
|
| 观察对描述的资源的更改，并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 Etcd 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须在没有 continue 字段的情况下重启其列表。否则，客户端可能会发送另一个列表请求，并带有 410 错误收到的令牌，服务器将通过从下一个密钥开始的列表进行响应，但从最新的快照（从最后一个列表结果中不一致） - 在第一个列表请求后创建、修改或删除的对象将包含在响应中，只要其密钥在"next key"后。 当 watch 为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视，而不丢失任何修改。 |
|
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 continue 字段为空，客户端可能会假设没有更多可用的结果。如果 watch 为 true，则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象，则返回第一次列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。 |
|
|
| 观察对描述的资源的更改，并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 Etcd
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
18.12.2.2. /apis/operator.openshift.io/v1/etcds/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Etcd 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果 'true'，则输出被用户友善。 |
- HTTP 方法
-
DELETE - 描述
- 删除 Etcd
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值是 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false，"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置两者。 |
|
|
| 是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为： 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系； 'Foreground' - 一个删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 Etcd
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 Etcd
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 Etcd
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Etcd 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果 'true'，则输出被用户友善。 |
- HTTP 方法
-
GET - 描述
- 指定 Etcd 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 指定 Etcd 的部分更新状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 Etcd 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}