红帽全球峰会Operator API
Operator API 的参考指南
摘要
第 1 章 Operator API
1.1. Authentication [operator.openshift.io/v1]
- 描述
- 身份验证提供配置操作器以管理身份验证的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.2. CloudCredential [operator.openshift.io/v1]
- 描述
- CloudCredential 提供了配置 Operator 来管理 CredentialsRequest 的方法。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.3. ClusterCSIDriver [operator.openshift.io/v1]
- 描述
- ClusterCSIDriver 对象允许在 OpenShift 中默认安装的 CSI 驱动程序 Operator 管理和配置。对象的名称必须是它所运行的 CSI 驱动程序的名称。如需允许的值列表，请参阅 CSIDriverName 类型。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.4. Console [operator.openshift.io/v1]
- 描述
- 控制台提供了一种方法来配置操作器来管理控制台。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.5. Config [operator.openshift.io/v1]
- 描述
- config 指定 config operator 的行为，它负责在集群中创建其他组件的初始配置。Operator 还处理 AWS 和基于 Azure 云的集群兼容性等级 1 的安装、迁移或同步云配置：在主发行版本中至少需要 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.6. Config [imageregistry.operator.openshift.io/v1]
- 描述
- config 是 registry operator 兼容性级别 1 管理的 registry 实例的配置对象：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.7. Config [samples.operator.openshift.io/v1]
- 描述
- config 包含 Samples Operator 的配置和详细条件状态。
- 类型
-
对象
1.8. CSISnapshotController [operator.openshift.io/v1]
- 描述
-
CSISnapshotController 提供了配置 Operator 来管理 CSI 快照的方法。
Cluster是规范名称。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。 - 类型
-
对象
1.9. DNS [operator.openshift.io/v1]
- 描述
- DNS 管理 CoreDNS 组件，为集群中的 pod 和服务提供名称解析服务。这支持基于 DNS 的服务发现规格： https://github.com/kubernetes/dns/blob/master/docs/specification.md 更多详情： https://kubernetes.io/docs/tasks/administer-cluster/coredns 兼容性级别 1: 在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.10. DNSRecord [ingress.operator.openshift.io/v1]
- 描述
- dnsrecord 是 dns.config.openshift.io/cluster .spec.publicZone 和 .spec.privateZone 定义的区域管理的 DNS 记录。不支持此资源的集群管理员操作。此资源仅用于 OpenShift 操作器的内部通信。如果 DNSManagementPolicy 为 "Unmanaged"，Operator 将无法管理云供应商上的 DNS 记录。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.11. Etcd [operator.openshift.io/v1]
- 描述
- etcd 提供配置 Operator 来管理 etcd 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.12. ImageContentSourcePolicy [operator.openshift.io/v1alpha1]
- 描述
- ImageContentSourcePolicy 包含有关如何处理 registry 镜像规则的集群范围信息。定义了多个策略时，会在每个字段中定义行为的结果。兼容性级别 4：不提供兼容性，API 可能会因为任何原因而有所变化。这些功能不应由需要长期支持的应用程序使用。
- 类型
-
对象
1.13. ImagePruner [imageregistry.operator.openshift.io/v1]
- 描述
- ImagePruner 是由 registry 操作器管理的镜像 registry 修剪器的配置对象。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.14. IngressController [operator.openshift.io/v1]
- 描述
- IngressController 描述了集群的受管入口控制器。控制器可以服务 OpenShift Route 和 Kubernetes Ingress 资源。创建 IngressController 时，会创建一个新的入口控制器部署，以允许外部流量访问公开 Ingress 或 Route 资源的服务。更新此资源可能会导致出现面向公共的网络连接中断，因为可能会推出新的入口控制器修订版本。https://kubernetes.io/docs/concepts/services-networking/ingress-controllers 尽可能减少平台的默认值。如需了解更多详细信息，请参阅每个字段。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object
1.15. InsightsOperator [operator.openshift.io/v1]
- 描述
- InsightsOperator 包含有关 Insights Operator 的集群范围信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.16. KubeAPIServer [operator.openshift.io/v1]
- 描述
- kubeapiserver 提供配置 Operator 来管理 kube-apiserver 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.17. KubeControllerManager [operator.openshift.io/v1]
- 描述
- kubecontrollermanager 提供配置 Operator 以管理 kube-controller-manager 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.18. KubeScheduler [operator.openshift.io/v1]
- 描述
- kubescheduler 提供配置操作器以管理调度程序的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.19. KubeStorageVersionMigrator [operator.openshift.io/v1]
- 描述
- KubeStorageVersionMigrator 提供配置 Operator 的信息来管理 kube-storage-version-migrator。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.20. Network [operator.openshift.io/v1]
- 描述
- network 描述了集群所需的网络配置。它被 cluster-network-operator 使用。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.21. OpenShiftAPIServer [operator.openshift.io/v1]
- 描述
- OpenShiftapiserver 提供配置 Operator 来管理 openshift-apiserver 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.22. OpenShiftControllerManager [operator.openshift.io/v1]
- 描述
- OpenShiftControllerManager 提供配置操作器以管理 openshift-controller-manager 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.23. OperatorPKI [network.operator.openshift.io/v1]
- 描述
- OperatorPKI 是一个简单的证书颁发机构。它不适用于外部使用 - 相反，它是网络操作器的内部。CNO 创建一个 CA 和由该 CA 签名的证书。证书同时启用了 ClientAuth 和 ServerAuth 扩展使用。更具体地说，如果一个 OperatorPKI 带有 <name>，则 CNO 将管理： - 名为 <name>-ca 的 Secret，带有两个数据键： - tls.key - 私钥 - tls.crt - 一个名为 <name>-ca 的 ConfigMap，带有单个数据键： - cabundle.crt - CA 证书(s)- CA 证书名为 <name>-cert，它有两个数据键： - tls.key - private key - tls.crt, certificate, tls.crt, certificate CA 证书签名的有效期为 10 年，在 9 后轮转。目标证书的有效期为 6 个月，在 3 后轮转，CA 证书将有一个 CommonName 为 "<namespace>_<name>-ca@<timestamp>"，其中 <timestamp> 是最后一次轮转时间。
- 类型
-
对象
1.24. ServiceCA [operator.openshift.io/v1]
- 描述
- ServiceCA 提供配置 Operator 以管理服务证书控制器兼容性级别 1 的信息：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
1.25. Storage [operator.openshift.io/v1]
- 描述
-
存储提供了配置操作器以管理集群存储操作器的方法。
Cluster是规范名称。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。 - 类型
-
对象
第 2 章 Authentication [operator.openshift.io/v1]
- 描述
- 身份验证提供配置操作器以管理身份验证的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
2.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 | |
|
|
| |
|
|
|
2.1.1. .spec
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
2.1.2. .status
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| oauthAPIServer 只保存特定于 oauth-apiserver 的状态 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
2.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
2.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
2.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
2.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
2.1.7. .status.oauthAPIServer
- 描述
- oauthAPIServer 只保存特定于 oauth-apiserver 的状态
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| LatestAvailableRevision 是最新的修订版本，用作 encryption-config 等修订 secret 的后缀。新修订版本会导致 pod 的新部署。 |
2.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/authentications-
DELETE：删除身份验证的集合 -
GET: 列出身份验证类型的对象 -
POST：创建身份验证
-
/apis/operator.openshift.io/v1/authentications/{name}-
DELETE：删除身份验证 -
GET：读取指定的身份验证 -
PATCH: 部分更新指定的身份验证 -
PUT：替换指定的身份验证
-
/apis/operator.openshift.io/v1/authentications/{name}/status-
GET：指定身份验证的读取状态 -
PATCH: 部分更新指定身份验证的状态 -
PUT：替换指定身份验证的状态
-
2.2.1. /apis/operator.openshift.io/v1/authentications
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除身份验证集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出身份验证类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建身份验证
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
2.2.2. /apis/operator.openshift.io/v1/authentications/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 身份验证的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除身份验证
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的身份验证
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的身份验证
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的身份验证
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
2.2.3. /apis/operator.openshift.io/v1/authentications/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 身份验证的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定身份验证的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定身份验证的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定身份验证的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 3 章 CloudCredential [operator.openshift.io/v1]
- 描述
- CloudCredential 提供了配置 Operator 来管理 CredentialsRequest 的方法。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
3.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 | |
|
|
| CloudCredentialSpec 是 cloud-credential-operator 所需的行为的规格。 |
|
|
| CloudCredentialStatus 定义 cloud-credential-operator 的观察状态。 |
3.1.1. .spec
- 描述
- CloudCredentialSpec 是 cloud-credential-operator 所需的行为的规格。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| credentialsMode 允许通知 CCO，它不应该尝试动态确定 root 云凭证功能，它应该只在指定模式下运行。如果需要，它还允许将操作器置于"手动"模式。默认模式中的字段运行 CCO，以便集群的云凭证将动态探测到功能（在支持的云/平台中）。支持的模式：AWS/Azure/GCP: "" (Default), "Mint", "Passthrough", "Manual" Others: 不设置值，因为其他平台只支持在"Passthrough"中运行。 |
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
3.1.2. .status
- 描述
- CloudCredentialStatus 定义 cloud-credential-operator 的观察状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
3.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
3.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
3.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
3.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
3.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/cloudcredentials-
DELETE：删除 CloudCredential 集合 -
GET: 列出类型为 CloudCredential 的对象 -
POST：创建 CloudCredential
-
/apis/operator.openshift.io/v1/cloudcredentials/{name}-
DELETE：删除 CloudCredential -
GET：读取指定的 CloudCredential -
PATCH: 部分更新指定的 CloudCredential -
PUT：替换指定的 CloudCredential
-
/apis/operator.openshift.io/v1/cloudcredentials/{name}/status-
GET：指定 CloudCredential 的读取状态 -
PATCH: 部分更新指定 CloudCredential 的状态 -
PUT：替换指定 CloudCredential 的状态
-
3.2.1. /apis/operator.openshift.io/v1/cloudcredentials
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CloudCredential 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 CloudCredential 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 CloudCredential
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
3.2.2. /apis/operator.openshift.io/v1/cloudcredentials/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CloudCredential 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CloudCredential
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 阅读指定的 CloudCredential
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 CloudCredential
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 CloudCredential
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
3.2.3. /apis/operator.openshift.io/v1/cloudcredentials/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CloudCredential 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 CloudCredential 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 CloudCredential 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 CloudCredential 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 4 章 ClusterCSIDriver [operator.openshift.io/v1]
- 描述
- ClusterCSIDriver 对象允许在 OpenShift 中默认安装的 CSI 驱动程序 Operator 管理和配置。对象的名称必须是它所运行的 CSI 驱动程序的名称。如需允许的值列表，请参阅 CSIDriverName 类型。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
4.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 | |
|
|
| spec 包含用于配置的用户可设置值 |
|
|
| status 包含从集群中观察到的值。它们可能无法被覆盖。 |
4.1.1. .spec
- 描述
- spec 包含用于配置的用户可设置值
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| driverConfig 可以用来指定平台特定的驱动程序配置。省略时，这意味着没有建议，平台将保留选择合理的默认值。这些默认值可能会随时间变化。 |
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| storageClassState 决定 CSI 操作器是否应该创建和管理存储类。如果此字段值为空或 Managed - CSI operator 将持续协调存储类并创建（如果需要）。如果此字段值是 Unmanaged - CSI operator 不会协调任何之前创建的存储类。如果此字段值为 Removed - CSI operator 将删除之前创建的存储类。省略时，这意味着用户没有建议，平台会选择合理的默认值，这可能会随时间变化。当前的默认值是 Managed。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
4.1.2. .spec.driverConfig
- 描述
- driverConfig 可以用来指定平台特定的驱动程序配置。省略时，这意味着没有建议，平台将保留选择合理的默认值。这些默认值可能会随时间变化。
- 类型
-
object - 必填
-
driverType
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| AWS 用于配置 AWS CSI 驱动程序。 |
|
|
| Azure 用于配置 Azure CSI 驱动程序。 |
|
|
| driverType 表示将 driverConfig 应用到的 CSI 驱动程序类型。有效值为： AWS、Azure、GCP、vSphere 和 omitted。消费者应将未知值视为 NO-OP。 |
|
|
| GCP 用于配置 GCP CSI 驱动程序。 |
|
|
| vSphere 用于配置 vsphere CSI 驱动程序。 |
4.1.3. .spec.driverConfig.aws
- 描述
- AWS 用于配置 AWS CSI 驱动程序。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| kmsKeyARN 将集群默认存储类设置为使用用户定义的 KMS 密钥加密卷，而不是 AWS 使用的默认 KMS 密钥。该值可以是 KMS 密钥的 ARN 或 Alias ARN。 |
4.1.4. .spec.driverConfig.azure
- 描述
- Azure 用于配置 Azure CSI 驱动程序。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| DiskEncryptionSet 将集群默认存储类设置为使用客户管理的加密集加密卷，而不是默认的平台管理的密钥。 |
4.1.5. .spec.driverConfig.azure.diskEncryptionSet
- 描述
- DiskEncryptionSet 将集群默认存储类设置为使用客户管理的加密集加密卷，而不是默认的平台管理的密钥。
- 类型
-
object - 必填
-
名称 -
resourceGroup -
subscriptionID
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是要在默认存储类上设置的磁盘加密集的名称。该值应仅包含字母字符、下划线(_)、连字符，长度最多为 80 个字符。 |
|
|
| ResourceGroup 定义包含磁盘加密集的 Azure 资源组。该值应仅包含字母字符、下划线(_)、括号、连字符和句点。该值不应以句点结尾，且长度最多为 90 个字符。 |
|
|
| subscriptionId 定义包含磁盘加密集的 Azure 订阅。该值应满足以下条件：1.它应该是 128 位数字。2.长度应该为 36 个字符(32 个十六进制字符和 4 个连字符)。3.它应显示在五个以连字符(-)分隔的组中。4.第一个组长度应为 8 个字符。5.第二、第三和第四个组应长度为 4 个字符。6.第五个组长度应为 12 个字符。一个示例 SubscrionID: f2007bbf-f802-4a47-9336-cf7c6b89b378 |
4.1.6. .spec.driverConfig.gcp
- 描述
- GCP 用于配置 GCP CSI 驱动程序。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| kmsKey 将集群默认存储类设置为使用客户提供的加密密钥加密卷，而不是由 GCP 管理的默认密钥。 |
4.1.7. .spec.driverConfig.gcp.kmsKey
- 描述
- kmsKey 将集群默认存储类设置为使用客户提供的加密密钥加密卷，而不是由 GCP 管理的默认密钥。
- 类型
-
object - 必填
-
keyRing -
名称 -
projectID
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| keyring 是 KMS 密钥所属的 KMS 密钥的名称。该值应对应于现有的 KMS 密钥环，且应仅包含字母数字字符、连字符(-)和下划线(_)，长度最多为 63 个字符。 |
|
|
| 位置是密钥 Ring 所在的 GCP 位置。该值必须与现有的 GCP 位置或 "global" 匹配。如果没有设置，则默认为 global。 |
|
|
| name 是用于磁盘加密的客户管理的加密密钥名称。该值应对应于现有的 KMS 密钥，应仅包含字母数字字符、连字符(-)和下划线(_)，长度最多为 63 个字符。 |
|
|
| projectID 是存在 KMS Key Ring 的项目 ID。它必须是 6 到 30 个小写字母、数字或连字符。它必须以字母开头。禁止结尾连字符。 |
4.1.8. .spec.driverConfig.vSphere
- 描述
- vSphere 用于配置 vsphere CSI 驱动程序。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| topologyCategories 表示带有哪些 vcenter 资源（如 hostcluster 或 datacenter）的标签类别。如果集群基础架构对象具有拓扑，则使用 Infrastructure 对象中指定的值并对 topologyCategories 的修改将被拒绝。 |
4.1.9. .status
- 描述
- status 包含从集群中观察到的值。它们可能无法被覆盖。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
4.1.10. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
4.1.11. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
4.1.12. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
4.1.13. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
4.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/clustercsidrivers-
DELETE：删除 ClusterCSIDriver 集合 -
GET: 列出 ClusterCSIDriver 类型的对象 -
POST：创建 ClusterCSIDriver
-
/apis/operator.openshift.io/v1/clustercsidrivers/{name}-
DELETE：删除 ClusterCSIDriver -
GET：读取指定的 ClusterCSIDriver -
PATCH: 部分更新指定的 ClusterCSIDriver -
PUT：替换指定的 ClusterCSIDriver
-
/apis/operator.openshift.io/v1/clustercsidrivers/{name}/status-
GET：指定 ClusterCSIDriver 的读取状态 -
PATCH: 部分更新指定 ClusterCSIDriver 的状态 -
PUT：替换指定 ClusterCSIDriver 的状态
-
4.2.1. /apis/operator.openshift.io/v1/clustercsidrivers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ClusterCSIDriver 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 ClusterCSIDriver 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 ClusterCSIDriver
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
4.2.2. /apis/operator.openshift.io/v1/clustercsidrivers/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ClusterCSIDriver 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ClusterCSIDriver
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 ClusterCSIDriver
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 ClusterCSIDriver
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 ClusterCSIDriver
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
4.2.3. /apis/operator.openshift.io/v1/clustercsidrivers/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ClusterCSIDriver 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 ClusterCSIDriver 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 ClusterCSIDriver 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 ClusterCSIDriver 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 5 章 Console [operator.openshift.io/v1]
- 描述
- 控制台提供了一种方法来配置操作器来管理控制台。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
5.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 | |
|
|
| ConsoleSpec 是控制台所需行为的规格。 |
|
|
| ConsoleStatus 定义 Console 的观察状态。 |
5.1.1. .spec
- 描述
- ConsoleSpec 是控制台所需行为的规格。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 自定义用于选择性地为 web 控制台提供一组较小的自定义选项。 |
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| 插件定义启用的控制台插件名称列表。 |
|
|
| 提供程序包含使用特定服务提供商的配置。 |
|
|
| 路由包含包含服务证书的主机名和 secret 引用。如果指定了自定义路由，则会使用提供的主机名创建新路由，该主机名下提供控制台。如果自定义主机名使用集群的默认路由后缀，则不需要服务证书的 Secret 规格。如果自定义主机名指向任意域，则需要手动 DNS 配置步骤。如果删除了自定义路由，则会维护默认控制台路由，以便为控制台保留默认主机名。如果没有指定，则使用默认路由。弃用 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
5.1.2. .spec.customization
- 描述
- 自定义用于选择性地为 web 控制台提供一组较小的自定义选项。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| addPage 允许在 Developer 视角中的 Add 页面中自定义操作。 |
|
|
| brand 是 Web 控制台的默认品牌，可通过提供品牌字段来覆盖。有有限的特定品牌选项。此字段控制控制台的元素，如徽标。无效的值将导致控制台推出部署。 |
|
|
| customLogoFile 替换 masthead 和 about 对话框中的默认 OpenShift 徽标。它是对 openshift-config 命名空间中的 ConfigMap 的引用。这可以通过 'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config' 等命令来创建。由于 ConfigMap 大小的限制，镜像大小必须小于 1 MB。ConfigMap 键应包含文件扩展名，以便控制台提供具有正确 MIME 类型的文件。推荐的徽标规格：Dimensions: Max height of 68px，首选最大宽度 200px SVG |
|
|
| customProductName 是页面标题、徽标 alt 文本以及有关对话框而不是普通的 OpenShift 产品名称显示的名称。 |
|
|
| developerCatalog 允许配置显示的开发人员目录类别(filters)和类型(sub-catalogs)。 |
|
|
| Web 控制台的各种部分中显示了到外部文档的 DocumentationBaseURL 链接。提供 DocumentationBaseURL 将覆盖默认文档 URL。无效的值将导致控制台推出部署。 |
|
|
| 透视图允许启用/禁用用户在视角切换器下拉菜单中可见的视角。 |
|
|
| 视角定义了集群管理员要在视角切换器下拉菜单中显示/隐藏的视角 |
|
|
| ProjectAccess 允许在 Developer 视角 Project 访问页面中自定义可用 ClusterRole 列表，供项目 admin 用于指定角色到其他用户，并限制项目中的访问。如果设置，列表将替换默认的 ClusterRole 选项。 |
|
|
| Quickstarts 允许在控制台中自定义可用的 ConsoleQuickStart 资源。 |
5.1.3. .spec.customization.addPage
- 描述
- addPage 允许在 Developer 视角中的 Add 页面中自定义操作。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| disabledActions 是未向用户显示的操作列表。列表中的每个操作都由其 ID 表示。 |
5.1.4. .spec.customization.customLogoFile
- 描述
- customLogoFile 替换 masthead 和 about 对话框中的默认 OpenShift 徽标。它是对 openshift-config 命名空间中的 ConfigMap 的引用。这可以通过 'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config' 等命令来创建。由于 ConfigMap 大小的限制，镜像大小必须小于 1 MB。ConfigMap 键应包含文件扩展名，以便控制台提供具有正确 MIME 类型的文件。推荐的徽标规格：Dimensions: Max height of 68px，首选最大宽度 200px SVG
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 键允许指向 configmap 中的特定键/值。这对逻辑文件引用非常有用。 |
|
|
|
5.1.5. .spec.customization.developerCatalog
- 描述
- developerCatalog 允许配置显示的开发人员目录类别(filters)和类型(sub-catalogs)。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 开发人员目录中显示的类别。 |
|
|
| DeveloperConsoleCatalogCategory 用于开发人员控制台目录。 |
|
|
| Type 允许启用或禁用用户可以在 Developer 目录中看到的子目录类型。如果省略时，将显示所有子目录类型。 |
5.1.6. .spec.customization.developerCatalog.categories
- 描述
- 开发人员目录中显示的类别。
- 类型
-
array
5.1.7. .spec.customization.developerCatalog.categories[]
- 描述
- DeveloperConsoleCatalogCategory 用于开发人员控制台目录。
- 类型
-
object - 必填
-
id -
label
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| ID 是 URL 中用来在控制台中启用深度链接的标识符。ID 是必需的，且必须具有 1-32 URL 安全(A-Z、a-z、0-9、- 和 _)。 |
|
|
| 标签定义类别显示标签。它是必需的，且必须具有 1-64 个字符。 |
|
|
| subcategories 定义子类别列表。 |
|
|
| DeveloperConsoleCatalogCategoryMeta 是开发人员目录类别的密钥标识符。 |
|
|
| tags 是与类别匹配的字符串列表。所选类别显示所有在类别和项目之间至少有一个重叠标签的项目。 |
5.1.8. .spec.customization.developerCatalog.categories[].subcategories
- 描述
- subcategories 定义子类别列表。
- 类型
-
array
5.1.9. .spec.customization.developerCatalog.categories[].subcategories[]
- 描述
- DeveloperConsoleCatalogCategoryMeta 是开发人员目录类别的密钥标识符。
- 类型
-
object - 必填
-
id -
label
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| ID 是 URL 中用来在控制台中启用深度链接的标识符。ID 是必需的，且必须具有 1-32 URL 安全(A-Z、a-z、0-9、- 和 _)。 |
|
|
| 标签定义类别显示标签。它是必需的，且必须具有 1-64 个字符。 |
|
|
| tags 是与类别匹配的字符串列表。所选类别显示所有在类别和项目之间至少有一个重叠标签的项目。 |
5.1.10. .spec.customization.developerCatalog.types
- 描述
- Type 允许启用或禁用用户可以在 Developer 目录中看到的子目录类型。如果省略时，将显示所有子目录类型。
- 类型
-
object - 必填
-
state
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| disabled 是未向用户显示的开发人员目录类型(sub-catalogs ID)列表。通过控制台插件添加类型(sub-catalogs)，可用的类型(sub-catalog ID)可在集群配置页面上提供，或在控制台中编辑 YAML 时。示例："Devfile", "HelmChart", "BuilderImage"，如果列表为空，或添加了所有可用的子目录类型，则应隐藏完整的开发人员目录。 |
|
|
| enabled 是开发人员目录类型(sub-catalogs ID)的列表，它将向用户显示。通过控制台插件添加类型(sub-catalogs)，可用的类型(sub-catalog ID)可在集群配置页面上提供，或在控制台中编辑 YAML 时。示例："Devfile", "HelmChart", "BuilderImage"，如果列表不是空的，则不会向用户显示一个新的类型，直到它添加到列表为止。如果列表为空，则会显示完整的开发人员目录。 |
|
|
| State 定义是否应启用或禁用目录类型列表。 |
5.1.11. .spec.customization.perspectives
- 描述
- 透视图允许启用/禁用用户在视角切换器下拉菜单中可见的视角。
- 类型
-
array
5.1.12. .spec.customization.perspectives[]
- 描述
- 视角定义了集群管理员要在视角切换器下拉菜单中显示/隐藏的视角
- 类型
-
object - 必填
-
id -
可见性
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| id 定义视角的 id。示例："dev", "admin"。可用的视角 id 可以在 yaml 编辑器旁边的代码片段部分找到。不正确的或未知 ID 将被忽略。 |
|
|
|
pinnedResources 定义默认固定资源列表，如果用户没有自定义这些固定资源本身，用户会在视角导航中看到这些固定资源。可以通过 |
|
|
| PinnedResourceReference 包括组、版本和资源类型 |
|
|
| 可见性定义了视角的状态，以及该视角是否需要访问检查。 |
5.1.13. .spec.customization.perspectives[].pinnedResources
- 描述
-
pinnedResources 定义默认固定资源列表，如果用户没有自定义这些固定资源本身，用户会在视角导航中看到这些固定资源。可以通过
kubectl api-resources读取可用的 Kubernetes 资源列表。控制台还会提供一个配置 UI 和 YAML 片断，用于列出可固定到导航的可用资源。不正确的或未知资源将被忽略。 - 类型
-
数组
5.1.14. .spec.customization.perspectives[].pinnedResources[]
- 描述
- PinnedResourceReference 包括组、版本和资源类型
- 类型
-
object - 必填
-
group -
resource -
version
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Group 是资源的 API 组。为 core 组输入空字符串。这个值应该只包含小写字母数字字符、连字符和句点。示例： ""、"apps"、"build.openshift.io"等。 |
|
|
| resource 是被引用的类型。它通常是小写的资源类型的复数形式。这个值应该只包含小写字母数字字符和连字符。示例："deployments", "deploymentconfigs", "pods" 等。 |
|
|
| version 是资源的 API 版本。这个值应该只包含小写字母数字字符。示例："v1", "v1beta1", 等。 |
5.1.15. .spec.customization.perspectives[].visibility
- 描述
- 可见性定义了视角的状态，以及该视角是否需要访问检查。
- 类型
-
object - 必填
-
state
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accessReview 定义 required 和 missing access review 检查。 |
|
|
| State 定义透视图为 enabled 或 disabled 或 access review check。 |
5.1.16. .spec.customization.perspectives[].visibility.accessReview
- 描述
- accessReview 定义 required 和 missing access review 检查。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| missing 定义权限检查列表。只有在至少有一个检查失败时，才会显示视角。省略时，会跳过访问审核，并且不会显示视角，除非需要根据所需访问查看列表的配置进行配置。 |
|
|
| ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性 |
|
|
| 必需定义权限检查列表。只有在所有检查都成功时才会显示视角。省略时，会跳过访问审核，并且不会显示视角，除非需要根据缺少访问查看列表的配置进行配置。 |
|
|
| ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性 |
5.1.17. .spec.customization.perspectives[].visibility.accessReview.missing
- 描述
- missing 定义权限检查列表。只有在至少有一个检查失败时，才会显示视角。省略时，会跳过访问审核，并且不会显示视角，除非需要根据所需访问查看列表的配置进行配置。
- 类型
-
数组
5.1.18. .spec.customization.perspectives[].visibility.accessReview.missing[]
- 描述
- ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Group 是 Resource 的 API 组。"*"代表所有。 |
|
|
| Name 是为"get"请求的资源的名称，或删除"delete"。"" （空）表示全部。 |
|
|
| namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）之间的差别，对于集群范围的资源 "" （空）代表"all"表示来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源 |
|
|
| 资源是现有资源类型之一。"*"表示全部。 |
|
|
| 子资源是现有资源类型之一。""表示 none。 |
|
|
| verb 是一个 kubernetes 资源 API 动词，如： get, list, watch, create, update, delete, proxy. "*" 表示所有。 |
|
|
| version 是资源的 API 版本。"*"表示所有。 |
5.1.19. .spec.customization.perspectives[].visibility.accessReview.required
- 描述
- 必需定义权限检查列表。只有在所有检查都成功时才会显示视角。省略时，会跳过访问审核，并且不会显示视角，除非需要根据缺少访问查看列表的配置进行配置。
- 类型
-
数组
5.1.20. .spec.customization.perspectives[].visibility.accessReview.required[]
- 描述
- ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Group 是 Resource 的 API 组。"*"代表所有。 |
|
|
| Name 是为"get"请求的资源的名称，或删除"delete"。"" （空）表示全部。 |
|
|
| namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）之间的差别，对于集群范围的资源 "" （空）代表"all"表示来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源 |
|
|
| 资源是现有资源类型之一。"*"表示全部。 |
|
|
| 子资源是现有资源类型之一。""表示 none。 |
|
|
| verb 是一个 kubernetes 资源 API 动词，如： get, list, watch, create, update, delete, proxy. "*" 表示所有。 |
|
|
| version 是资源的 API 版本。"*"表示所有。 |
5.1.21. .spec.customization.projectAccess
- 描述
- ProjectAccess 允许在 Developer 视角 Project 访问页面中自定义可用 ClusterRole 列表，供项目 admin 用于指定角色到其他用户，并限制项目中的访问。如果设置，列表将替换默认的 ClusterRole 选项。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| availableClusterRoles 是 ClusterRole 名称列表，可通过项目访问标签页分配给用户。 |
5.1.22. .spec.customization.quickStarts
- 描述
- Quickstarts 允许在控制台中自定义可用的 ConsoleQuickStart 资源。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| disabled 是用户未显示的 ConsoleQuickStart 资源名称的列表。 |
5.1.23. .spec.providers
- 描述
- 提供程序包含使用特定服务提供商的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 状态页面包含 statuspage.io 页面的 ID，其中提供了状态信息。 |
5.1.24. .spec.providers.statuspage
- 描述
- 状态页面包含 statuspage.io 页面的 ID，其中提供了状态信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| pageID 是页面的 Statuspage 分配的唯一 ID。这必须是公共页面。 |
5.1.25. .spec.route
- 描述
- 路由包含包含服务证书的主机名和 secret 引用。如果指定了自定义路由，则会使用提供的主机名创建新路由，该主机名下提供控制台。如果自定义主机名使用集群的默认路由后缀，则不需要服务证书的 Secret 规格。如果自定义主机名指向任意域，则需要手动 DNS 配置步骤。如果删除了自定义路由，则会维护默认控制台路由，以便为控制台保留默认主机名。如果没有指定，则使用默认路由。弃用
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| hostname 是所需的自定义域，控制台将在其中可用。 |
|
|
| secret 指向 openshift-config 命名空间中的 secret，其中包含自定义证书和密钥，需要由集群管理员手动创建。引用的 Secret 需要包含以下键值对： - "tls.crt" - 指定自定义证书 - "tls.key" - 指定自定义证书的私钥（如果自定义主机名使用集群的默认路由后缀），则不需要服务证书的 Secret 规格。 |
5.1.26. .spec.route.secret
- 描述
- secret 指向 openshift-config 命名空间中的 secret，其中包含自定义证书和密钥，需要由集群管理员手动创建。引用的 Secret 需要包含以下键值对： - "tls.crt" - 指定自定义证书 - "tls.key" - 指定自定义证书的私钥（如果自定义主机名使用集群的默认路由后缀），则不需要服务证书的 Secret 规格。
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是引用的 secret 的 metadata.name |
5.1.27. .status
- 描述
- ConsoleStatus 定义 Console 的观察状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
5.1.28. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
5.1.29. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
5.1.30. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
5.1.31. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
5.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/consoles-
DELETE：删除控制台集合 -
GET: 列出类型为 Console 的对象 -
POST：创建控制台
-
/apis/operator.openshift.io/v1/consoles/{name}-
DELETE：删除控制台 -
GET：读取指定的控制台 -
PATCH: 部分更新指定的控制台 -
PUT：替换指定的控制台
-
/apis/operator.openshift.io/v1/consoles/{name}/status-
GET：指定控制台的读取状态 -
PATCH: 部分更新指定控制台的状态 -
PUT：替换指定控制台的状态
-
5.2.1. /apis/operator.openshift.io/v1/consoles
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除控制台集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出控制台的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建控制台
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
5.2.2. /apis/operator.openshift.io/v1/consoles/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 控制台名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除控制台
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的控制台
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的控制台
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的控制台
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
5.2.3. /apis/operator.openshift.io/v1/consoles/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 控制台名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定控制台的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定控制台的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定控制台的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 6 章 config [operator.openshift.io/v1]
- 描述
- config 指定 config operator 的行为，它负责在集群中创建其他组件的初始配置。Operator 还处理 AWS 和基于 Azure 云的集群兼容性等级 1 的安装、迁移或同步云配置：在主发行版本中至少需要 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
6.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 | |
|
|
| spec 是 Config Operator 所需的行为的规格。 |
|
|
| Status 定义 Config Operator 的观察状态。 |
6.1.1. .spec
- 描述
- spec 是 Config Operator 所需的行为的规格。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
6.1.2. .status
- 描述
- Status 定义 Config Operator 的观察状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
6.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
6.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
6.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
6.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
6.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/configs-
DELETE：删除配置集合 -
GET: 列出类型为 Config 的对象 -
POST：创建配置
-
/apis/operator.openshift.io/v1/configs/{name}-
DELETE：删除配置 -
GET：读取指定的配置 -
PATCH: 部分更新指定的配置 -
PUT：替换指定的 Config
-
/apis/operator.openshift.io/v1/configs/{name}/status-
GET：指定配置的读取状态 -
PATCH: 部分更新指定配置的状态 -
PUT：替换指定配置的状态
-
6.2.1. /apis/operator.openshift.io/v1/configs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除配置集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 Config 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
6.2.2. /apis/operator.openshift.io/v1/configs/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Config 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 Config
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 Config
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
6.2.3. /apis/operator.openshift.io/v1/configs/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Config 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定配置的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定配置的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定配置的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 7 章 Config [imageregistry.operator.openshift.io/v1]
- 描述
- config 是 registry operator 兼容性级别 1 管理的 registry 实例的配置对象：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
metadata -
spec
-
7.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 | |
|
|
| ImageRegistrySpec 定义正在运行的 registry 的 spec。 |
|
|
| ImageRegistryStatus 报告镜像 registry 操作状态。 |
7.1.1. .spec
- 描述
- ImageRegistrySpec 定义正在运行的 registry 的 spec。
- 类型
-
object - 必填
-
replicas
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| affinity 是一组节点关联性调度规则，用于镜像 registry pod。 |
|
|
| defaultRoute 表示是否应使用默认生成的主机名创建面向外部的路由。 |
|
|
| disableRedirect 控制是否通过 Registry 路由所有数据，而不是重定向到后端。 |
|
|
| httpSecret 是 registry 安全上传所需的值，默认生成。 |
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| Logging 已被弃用，使用 logLevel 替代。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
|
| nodeSelector 为 registry pod 定义节点选择限制。 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| 代理定义调用 master api、上游 registry 等时使用的代理。 |
|
|
| readonly 表示 registry 实例是否应该拒绝推送新镜像或删除现有镜像的尝试。 |
|
|
| replicas 决定要运行的 registry 实例的数量。 |
|
|
| 请求控制给定 registry 实例在排队额外请求前可以处理多少个并行请求。 |
|
|
| 资源定义 registry Pod 的资源请求+limits。 |
|
|
| rolloutStrategy 为镜像 registry 部署定义 rollout 策略。 |
|
|
| 路由定义应该为 registry 创建的其他面向外部的路由。 |
|
|
| ImageRegistryConfigRoute 包含有关对镜像 registry 的外部路由访问的信息。 |
|
|
| 配置 registry 存储的存储详情，如 S3 存储桶协调。 |
|
|
| 容限(toleration)定义了 registry pod 的容限。 |
|
|
| 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。 |
|
|
| topologySpreadConstraints 指定如何在给定的拓扑中分布匹配的 pod。 |
|
|
| TopologySpreadConstraint 指定如何在给定的拓扑中分布匹配的 pod。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
7.1.2. .spec.affinity
- 描述
- affinity 是一组节点关联性调度规则，用于镜像 registry pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 描述 pod 的节点关联性调度规则。 |
|
|
| 描述 pod 关联性调度规则（例如，将这个 pod 位于同一个节点、区等）中。 |
|
|
| 描述 pod 反关联性调度规则（例如，避免将此 pod 放置到同一个节点、区等）。 |
7.1.3. .spec.affinity.nodeAffinity
- 描述
- 描述 pod 的节点关联性调度规则。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 调度程序更喜欢将 pod 调度到满足此字段指定的关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、必需关联表达式等）的每个节点，计算出一个总和总和总和总和（如果节点与相应的 matchExpressions 匹配），则计算总和最高的节点是最首选的。 |
|
|
| 空白的首选调度术语与带有隐式权重 0 （例如，它的一个 no-op）的所有对象匹配。空首选调度术语不匹配任何对象（例如，也是 no-op）。 |
|
|
| 如果在调度时没有满足此字段指定的关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的关联性要求在 pod 执行期间某一点满足（例如，由于更新），则系统可能或可能无法最终从其节点驱除 pod。 |
7.1.4. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 描述
- 调度程序更喜欢将 pod 调度到满足此字段指定的关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、必需关联表达式等）的每个节点，计算出一个总和总和总和总和（如果节点与相应的 matchExpressions 匹配），则计算总和最高的节点是最首选的。
- 类型
-
array
7.1.5. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 空白的首选调度术语与带有隐式权重 0 （例如，它的一个 no-op）的所有对象匹配。空首选调度术语不匹配任何对象（例如，也是 no-op）。
- 类型
-
object - 必填
-
preference -
weight
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 与对应权重关联的节点选择器术语。 |
|
|
| 与对应 nodeSelectorTerm 关联的权重，范围为 1-100。 |
7.1.6. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference
- 描述
- 与对应权重关联的节点选择器术语。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 按节点标签划分的节点选择器要求列表。 |
|
|
| 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| 按节点字段划分的节点选择器要求列表。 |
|
|
| 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
7.1.7. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions
- 描述
- 按节点标签划分的节点选择器要求列表。
- 类型
-
array
7.1.8. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]
- 描述
- 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt. |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果运算符是 Gt 或 Lt，则值数组必须具有单个元素，它将解释为整数。这个数组会在策略性合并补丁中被替换。 |
7.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields
- 描述
- 按节点字段划分的节点选择器要求列表。
- 类型
-
array
7.1.10. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]
- 描述
- 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt. |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果运算符是 Gt 或 Lt，则值数组必须具有单个元素，它将解释为整数。这个数组会在策略性合并补丁中被替换。 |
7.1.11. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 描述
- 如果在调度时没有满足此字段指定的关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的关联性要求在 pod 执行期间某一点满足（例如，由于更新），则系统可能或可能无法最终从其节点驱除 pod。
- 类型
-
object - 必填
-
nodeSelectorTerms
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 必需。节点选择器术语列表。术语为 ORed。 |
|
|
| null 或空节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。 |
7.1.12. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
- 描述
- 必需。节点选择器术语列表。术语为 ORed。
- 类型
-
array
7.1.13. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]
- 描述
- null 或空节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 按节点标签划分的节点选择器要求列表。 |
|
|
| 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| 按节点字段划分的节点选择器要求列表。 |
|
|
| 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
7.1.14. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions
- 描述
- 按节点标签划分的节点选择器要求列表。
- 类型
-
array
7.1.15. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]
- 描述
- 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt. |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果运算符是 Gt 或 Lt，则值数组必须具有单个元素，它将解释为整数。这个数组会在策略性合并补丁中被替换。 |
7.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields
- 描述
- 按节点字段划分的节点选择器要求列表。
- 类型
-
array
7.1.17. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]
- 描述
- 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt. |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果运算符是 Gt 或 Lt，则值数组必须具有单个元素，它将解释为整数。这个数组会在策略性合并补丁中被替换。 |
7.1.18. .spec.affinity.podAffinity
- 描述
- 描述 pod 关联性调度规则（例如，将这个 pod 位于同一个节点、区等）中。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 调度程序更喜欢将 pod 调度到满足此字段指定的关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选的节点是具有最大权重总和的节点（即，对于满足所有调度要求的节点(resource request、requiredDuringScheduling 关联性表达式等)的每个节点，计算并迭代此字段元素，并在节点具有与对应 podAffinityTerm 匹配的 pod 时，将"weight"添加到总和（如果节点具有最高 podAffinityTerm）、具有最高总和最高的节点是首选。 |
|
|
| 所有匹配的 WeightedPodAffinityTerm 字段的权重添加到每个节点，以查找最首选节点。 |
|
|
| 如果在调度时没有满足此字段指定的关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的关联性要求在 pod 执行期间某一点满足（例如，由于 pod 标签更新），则系统可能或可能无法最终从其节点驱除 pod。当有多个元素时，与每个 podAffinityTerm 对应的节点列表都会被交集，例如必须满足所有术语。 |
|
|
| 定义一组 pod （即，与给定命名空间相对 labelSelector 匹配的 labelSelector ），该 pod 应该与 pod 共同定位（反关联性）或没有共同定位（反关联性）的节点上运行，其中 co-located 在具有键 <topologyKey> 标签的节点上运行，它与其上运行一组 pod 的 pod 匹配。 |
7.1.19. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 描述
- 调度程序更喜欢将 pod 调度到满足此字段指定的关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选的节点是具有最大权重总和的节点（即，对于满足所有调度要求的节点(resource request、requiredDuringScheduling 关联性表达式等)的每个节点，计算并迭代此字段元素，并在节点具有与对应 podAffinityTerm 匹配的 pod 时，将"weight"添加到总和（如果节点具有最高 podAffinityTerm）、具有最高总和最高的节点是首选。
- 类型
-
array
7.1.20. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 所有匹配的 WeightedPodAffinityTerm 字段的权重添加到每个节点，以查找最首选节点。
- 类型
-
object - 必填
-
podAffinityTerm -
weight
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 必需。与对应权重关联的 pod 关联性术语。 |
|
|
| 与对应的 podAffinityTerm 关联的权重，范围为 1-100。 |
7.1.21. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
- 描述
- 必需。与对应权重关联的 pod 关联性术语。
- 类型
-
object - 必填
-
topologyKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 对一组资源进行标签查询，本例中为 pod。 |
|
|
| 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。 |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用到此字段中列出的命名空间的 union，namespaceSelector 选择的命名空间列表和 null namespaceSelector 表示 " this pod 的命名空间"。 |
|
|
| 此 pod 应该在指定命名空间中与 labelSelector 匹配的 pod 共存（反关联性），其中 co-located 定义为在运行所选 pod 的节点的值为 running 的节点上运行。不允许为空 topologyKey。 |
7.1.22. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
- 描述
- 对一组资源进行标签查询，本例中为 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.23. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.24. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- 描述
- 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.26. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.27. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.28. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 描述
- 如果在调度时没有满足此字段指定的关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的关联性要求在 pod 执行期间某一点满足（例如，由于 pod 标签更新），则系统可能或可能无法最终从其节点驱除 pod。当有多个元素时，与每个 podAffinityTerm 对应的节点列表都会被交集，例如必须满足所有术语。
- 类型
-
array
7.1.29. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 定义一组 pod （即，与给定命名空间相对 labelSelector 匹配的 labelSelector ），该 pod 应该与 pod 共同定位（反关联性）或没有共同定位（反关联性）的节点上运行，其中 co-located 在具有键 <topologyKey> 标签的节点上运行，它与其上运行一组 pod 的 pod 匹配。
- 类型
-
object - 必填
-
topologyKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 对一组资源进行标签查询，本例中为 pod。 |
|
|
| 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。 |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用到此字段中列出的命名空间的 union，namespaceSelector 选择的命名空间列表和 null namespaceSelector 表示 " this pod 的命名空间"。 |
|
|
| 此 pod 应该在指定命名空间中与 labelSelector 匹配的 pod 共存（反关联性），其中 co-located 定义为在运行所选 pod 的节点的值为 running 的节点上运行。不允许为空 topologyKey。 |
7.1.30. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
- 描述
- 对一组资源进行标签查询，本例中为 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.31. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.32. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.33. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- 描述
- 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.34. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.35. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.36. .spec.affinity.podAntiAffinity
- 描述
- 描述 pod 反关联性调度规则（例如，避免将此 pod 放置到同一个节点、区等）。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 调度程序更喜欢将 pod 调度到满足此字段指定的反关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选的节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、requiredDuringScheduling 反关联性表达式等）的每个节点，计算通过此字段元素来计算总和总和（如果节点具有与对应的 podAffinityTerm 匹配的 pod）的总和。 |
|
|
| 所有匹配的 WeightedPodAffinityTerm 字段的权重添加到每个节点，以查找最首选节点。 |
|
|
| 如果在调度时没有满足此字段指定的反关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的反关联性要求在 Pod 执行期间某一点满足（例如，由于 pod 标签更新），则系统可能或可能无法最终从其节点驱除 pod。当有多个元素时，与每个 podAffinityTerm 对应的节点列表都会被交集，例如必须满足所有术语。 |
|
|
| 定义一组 pod （即，与给定命名空间相对 labelSelector 匹配的 labelSelector ），该 pod 应该与 pod 共同定位（反关联性）或没有共同定位（反关联性）的节点上运行，其中 co-located 在具有键 <topologyKey> 标签的节点上运行，它与其上运行一组 pod 的 pod 匹配。 |
7.1.37. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 描述
- 调度程序更喜欢将 pod 调度到满足此字段指定的反关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选的节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、requiredDuringScheduling 反关联性表达式等）的每个节点，计算通过此字段元素来计算总和总和（如果节点具有与对应的 podAffinityTerm 匹配的 pod）的总和。
- 类型
-
array
7.1.38. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 所有匹配的 WeightedPodAffinityTerm 字段的权重添加到每个节点，以查找最首选节点。
- 类型
-
object - 必填
-
podAffinityTerm -
weight
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 必需。与对应权重关联的 pod 关联性术语。 |
|
|
| 与对应的 podAffinityTerm 关联的权重，范围为 1-100。 |
7.1.39. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
- 描述
- 必需。与对应权重关联的 pod 关联性术语。
- 类型
-
object - 必填
-
topologyKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 对一组资源进行标签查询，本例中为 pod。 |
|
|
| 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。 |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用到此字段中列出的命名空间的 union，namespaceSelector 选择的命名空间列表和 null namespaceSelector 表示 " this pod 的命名空间"。 |
|
|
| 此 pod 应该在指定命名空间中与 labelSelector 匹配的 pod 共存（反关联性），其中 co-located 定义为在运行所选 pod 的节点的值为 running 的节点上运行。不允许为空 topologyKey。 |
7.1.40. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
- 描述
- 对一组资源进行标签查询，本例中为 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.41. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.42. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- 描述
- 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.44. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.45. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.46. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 描述
- 如果在调度时没有满足此字段指定的反关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的反关联性要求在 Pod 执行期间某一点满足（例如，由于 pod 标签更新），则系统可能或可能无法最终从其节点驱除 pod。当有多个元素时，与每个 podAffinityTerm 对应的节点列表都会被交集，例如必须满足所有术语。
- 类型
-
array
7.1.47. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 定义一组 pod （即，与给定命名空间相对 labelSelector 匹配的 labelSelector ），该 pod 应该与 pod 共同定位（反关联性）或没有共同定位（反关联性）的节点上运行，其中 co-located 在具有键 <topologyKey> 标签的节点上运行，它与其上运行一组 pod 的 pod 匹配。
- 类型
-
object - 必填
-
topologyKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 对一组资源进行标签查询，本例中为 pod。 |
|
|
| 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。 |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用到此字段中列出的命名空间的 union，namespaceSelector 选择的命名空间列表和 null namespaceSelector 表示 " this pod 的命名空间"。 |
|
|
| 此 pod 应该在指定命名空间中与 labelSelector 匹配的 pod 共存（反关联性），其中 co-located 定义为在运行所选 pod 的节点的值为 running 的节点上运行。不允许为空 topologyKey。 |
7.1.48. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
- 描述
- 对一组资源进行标签查询，本例中为 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.49. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.50. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.51. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- 描述
- 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.53. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.54. .spec.proxy
- 描述
- 代理定义调用 master api、上游 registry 等时使用的代理。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 定义镜像 registry 在访问 HTTP 端点时使用的代理。 |
|
|
| HTTPS 定义镜像 registry 在访问 HTTPS 端点时使用的代理。 |
|
|
| noProxy 定义不应通过任何代理的主机名的逗号分隔列表。 |
7.1.55. .spec.requests
- 描述
- 请求控制给定 registry 实例在排队额外请求前可以处理多少个并行请求。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 读取定义镜像 registry 读取的限制。 |
|
|
| write 定义镜像 registry 的写入限制。 |
7.1.56. .spec.requests.read
- 描述
- 读取定义镜像 registry 读取的限制。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| maxInQueue 将的最大排队的 api 请求设置为 registry。 |
|
|
| maxRunning 将 flight api 请求的最大值设置为 registry。 |
|
|
| maxWaitInQueue 设置请求在被拒绝前可在队列中等待的最长时间。 |
7.1.57. .spec.requests.write
- 描述
- write 定义镜像 registry 的写入限制。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| maxInQueue 将的最大排队的 api 请求设置为 registry。 |
|
|
| maxRunning 将 flight api 请求的最大值设置为 registry。 |
|
|
| maxWaitInQueue 设置请求在被拒绝前可在队列中等待的最长时间。 |
7.1.58. .spec.resources
- 描述
- 资源定义 registry Pod 的资源请求+limits。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门。此字段不可变。 |
|
|
| ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。 |
|
|
| 限制描述了允许的最大计算资源量。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests 描述了所需的最少计算资源。如果容器省略了 Requests，则默认为 Limits （如果明确指定），否则默认为实现定义的值。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
7.1.59. .spec.resources.claims
- 描述
- claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门。此字段不可变。
- 类型
-
数组
7.1.60. .spec.resources.claims[]
- 描述
- ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中的一个条目的名称匹配。它允许容器内部使用该资源。 |
7.1.61. .spec.routes
- 描述
- 路由定义应该为 registry 创建的其他面向外部的路由。
- 类型
-
array
7.1.62. .spec.routes[]
- 描述
- ImageRegistryConfigRoute 包含有关对镜像 registry 的外部路由访问的信息。
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 路由的主机名。 |
|
|
| 要创建的路由的名称。 |
|
|
| secretName 指向包含路由要使用的证书的 secret。 |
7.1.63. .spec.storage
- 描述
- 配置 registry 存储的存储详情，如 S3 存储桶协调。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Azure 代表使用 Azure Blob Storage 的配置。 |
|
|
| emptyDir 代表 pod 的主机节点上的临时存储。警告：此存储不能与超过 1 个副本一起使用，不适合生产用途。当因为某种原因从节点中删除 pod 时，emptyDir 中的数据会永久删除。 |
|
|
| GCS 代表使用 Google Cloud Storage 的配置。 |
|
|
| ibmcos 代表使用 IBM Cloud Object Storage 的配置。 |
|
|
| managementState 表示操作器是否管理底层存储单元。如果 Managed，Operator 会在此 Operator 被 Removed时删除存储。 |
|
|
| OSS 代表使用 Alibaba Cloud Object Storage Service 的配置。 |
|
|
| PVC 代表使用 PersistentVolumeClaim 的配置。 |
|
|
| s3 代表使用 Amazon Simple Storage Service 的配置。 |
|
|
| Swift 代表使用 OpenStack 对象存储的配置。 |
7.1.64. .spec.storage.azure
- 描述
- Azure 代表使用 Azure Blob Storage 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accountName 定义 registry 使用的帐户。 |
|
|
| cloudName 是 registry 使用的 Azure 云环境的名称。如果为空，Operator 将基于 infrastructure 对象进行设置。 |
|
|
| 容器定义 registry 使用的 Azure 容器。 |
7.1.65. .spec.storage.emptyDir
- 描述
- emptyDir 代表 pod 的主机节点上的临时存储。警告：此存储不能与超过 1 个副本一起使用，不适合生产用途。当因为某种原因从节点中删除 pod 时，emptyDir 中的数据会永久删除。
- 类型
-
对象
7.1.66. .spec.storage.gcs
- 描述
- GCS 代表使用 Google Cloud Storage 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| bucket 是您要在其中存储 registry 数据的存储桶名称。可选，如果没有提供，则会生成。 |
|
|
| keyID 是用于加密的 KMS 密钥 ID。可选，在 GCP 上默认加密存储桶。这将允许使用一个自定义加密密钥。 |
|
|
| projectID 是此存储桶应与之关联的 GCP 项目的项目 ID。 |
|
|
| 存储桶所在的 GCS 位置。可选，将根据安装的 GCS 区域来设置。 |
7.1.67. .spec.storage.ibmcos
- 描述
- ibmcos 代表使用 IBM Cloud Object Storage 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| bucket 是您要在其中存储 registry 数据的存储桶名称。可选，如果没有提供，则会生成。 |
|
|
| 位置是存储桶所在的 IBM Cloud 位置。可选，将根据安装的 IBM Cloud 位置进行设置。 |
|
|
| resourceGroupName 是此存储桶及其服务实例关联的 IBM Cloud 资源组的名称。可选，将根据安装的 IBM Cloud 资源组设置。 |
|
|
| resourceKeyCRN 是为服务实例创建的 IBM Cloud 资源密钥的 CRN。通常被称为服务凭证，必须包含 HMAC 类型凭证。可选，如果没有提供，则会计算。 |
|
|
| serviceInstanceCRN 是此存储桶关联的 IBM Cloud Object Storage 服务实例的 CRN。可选，如果没有提供，则会计算。 |
7.1.68. .spec.storage.oss
- 描述
- OSS 代表使用 Alibaba Cloud Object Storage Service 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要在其中存储 registry 数据的存储桶名称。关于 Bucket 命名，您可以查看 [official 文档]（https://www.alibabacloud.com/help/doc-detail/257087.htmEmpty 值意味着没有建议，平台会选择默认值，这可能会随时间变化。目前，默认值将以 <clusterid>-image-registry-<region>-<random 字符串 27 chars> 的形式自动生成 |
|
|
| encryption 指定是否想在服务器端加密数据。如需了解更多详细信息，您可以查看 [official 文档](https://www.alibabacloud.com/help/doc-detail/117914.htm) |
|
|
|
EndpointAccessibility 指定 registry 是否使用 OSS VPC 内部端点 Empty 值，意味着没有建议，平台会选择默认值，可能会随时间变化。目前，默认为 |
|
|
| 区域是存在存储桶的 Alibaba Cloud 区域。如需区域列表，您可以查看[官方文档](https://www.alibabacloud.com/help/doc-detail/31837.html)。空值表示没有建议，平台会选择默认值，这可能会随时间变化。目前，默认值将基于安装的 Alibaba Cloud 区域。 |
7.1.69. .spec.storage.oss.encryption
- 描述
- encryption 指定是否想在服务器端加密数据。如需了解更多详细信息，您可以查看 [official 文档](https://www.alibabacloud.com/help/doc-detail/117914.htm)
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| KMS （密钥管理服务）是一个加密类型，其中包含 KMS KeyID 的结构 |
|
|
|
method 定义可用的 Empty 值的不同保护模式意味着没有建议，平台会选择默认值，这可能会随时间变化。目前，默认为 |
7.1.70. .spec.storage.oss.encryption.kms
- 描述
- KMS （密钥管理服务）是一个加密类型，其中包含 KMS KeyID 的结构
- 类型
-
object - 必填
-
keyID
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| keyID 包含 KMS 加密密钥 ID |
7.1.71. .spec.storage.pvc
- 描述
- PVC 代表使用 PersistentVolumeClaim 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 声明定义要使用的永久卷声明的名称。 |
7.1.72. .spec.storage.s3
- 描述
- s3 代表使用 Amazon Simple Storage Service 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| bucket 是您要在其中存储 registry 数据的存储桶名称。可选，如果没有提供，则会生成。 |
|
|
| CloudFront 将 Amazon Cloudfront 配置为 registry 中的存储中间件。 |
|
|
| encrypt 指定 registry 是否以加密格式存储镜像。可选，默认为 false。 |
|
|
| keyID 是用于加密的 KMS 密钥 ID。可选，Encrypt 必须为 true，否则此参数将被忽略。 |
|
|
| 存储桶所在的 AWS 区域。可选，将根据安装的 AWS 区域来设置。 |
|
|
| regionendpoint 是 S3 兼容存储服务的端点。它应该是带有 方案 的有效 URL，例如 https://s3.example.com。可选，基于提供的 Region。 |
|
|
| trustedCA 是包含 CA 捆绑包的配置映射的引用。镜像 registry 及其 Operator 使用此捆绑包中的证书来验证 S3 服务器证书。被 trustedCA 引用的配置映射的命名空间为 "openshift-config"。配置映射中捆绑包的密钥为 "ca-bundle.crt"。 |
|
|
| virtualHostedStyle 启用 S3 虚拟主机风格存储桶路径以及自定义 RegionEndpoint 可选，默认为 false。 |
7.1.73. .spec.storage.s3.cloudFront
- 描述
- CloudFront 将 Amazon Cloudfront 配置为 registry 中的存储中间件。
- 类型
-
object - 必填
-
baseURL -
keypairID -
privateKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| baseurl 包含 SCHEME://HOST[/PATH]，在其中提供 Cloudfront。 |
|
|
| duration 是 Cloudfront 会话的持续时间。 |
|
|
| keypairID 是 AWS 提供的密钥对 ID。 |
|
|
| Privatekey 指向包含 AWS 提供的私钥的 secret。 |
7.1.74. .spec.storage.s3.cloudFront.privateKey
- 描述
- Privatekey 指向包含 AWS 提供的私钥的 secret。
- 类型
-
object - 必填
-
key
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。 |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？ |
|
|
| 指定是否需要定义 Secret 还是其密钥 |
7.1.75. .spec.storage.s3.trustedCA
- 描述
- trustedCA 是包含 CA 捆绑包的配置映射的引用。镜像 registry 及其 Operator 使用此捆绑包中的证书来验证 S3 服务器证书。被 trustedCA 引用的配置映射的命名空间为 "openshift-config"。配置映射中捆绑包的密钥为 "ca-bundle.crt"。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是引用的配置映射的 metadata.name。此字段必须遵循标准配置映射命名限制。名称只能包含字母数字字符、连字符(-)和句点(.)。它的最大长度为 253 个字符。如果没有指定此字段或为空字符串，则会使用默认信任捆绑包。 |
7.1.76. .spec.storage.swift
- 描述
- Swift 代表使用 OpenStack 对象存储的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| authURL 定义用于获取身份验证令牌的 URL。 |
|
|
| authVersion 指定 OpenStack Auth 的版本。 |
|
|
| 容器定义用于存储 registry 数据的 Swift 容器的名称。 |
|
|
| domain 指定 Identity v3 API 的 Openstack 的域名。 |
|
|
| domainID 为 Identity v3 API 指定 Openstack 的 domain id。 |
|
|
| regionName 定义容器所在的 Openstack 区域。 |
|
|
| 租户定义 registry 使用的 Openstack 租户名称。 |
|
|
| 租户定义 registry 使用的 Openstack 租户 id。 |
7.1.77. .spec.tolerations
- 描述
- 容限(toleration)定义了 registry pod 的容限。
- 类型
-
array
7.1.78. .spec.tolerations[]
- 描述
- 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| effect 表示要匹配的污点效果。空意味着匹配所有污点效果。指定后，允许的值为 NoSchedule，PreferNoSchedule 和 NoExecute。 |
|
|
| key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空，则必须存在运算符；组合意味着匹配所有值和所有键。 |
|
|
| Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认值为 Equal。exists 等同于值的通配符，以便 pod 可以容忍特定类别的所有污点。 |
|
|
| tolerationSeconds 代表容限的期间（必须生效 NoExecute，否则此字段将被忽略）可以容忍污点。默认情况下，它不会被设置，这意味着容许任何污点（不要驱除）。零值和负值将被视为 0 （立即删除）。 |
|
|
| value 是容限匹配的污点值。如果运算符是 Exists，则该值应该为空，否则仅是一个常规字符串。 |
7.1.79. .spec.topologySpreadConstraints
- 描述
- topologySpreadConstraints 指定如何在给定的拓扑中分布匹配的 pod。
- 类型
-
array
7.1.80. .spec.topologySpreadConstraints[]
- 描述
- TopologySpreadConstraint 指定如何在给定的拓扑中分布匹配的 pod。
- 类型
-
object - 必填
-
maxSkew -
topologyKey -
whenUnsatisfiable
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| labelSelector 用于查找匹配的 pod。与此标签选择器匹配的 Pod 被计算，以确定其对应拓扑域中的 pod 数量。 |
|
|
| matchLabelKeys 是一组 pod 标签键，用于选择要在其中计算分布的 pod。这些键用于从传入的 pod 标签中查找值，这些键值标签由 labelSelector 匹配，以选择现有 pod 的组，用于为传入的 pod 计算。传入的 pod 标签中不存在的键将被忽略。null 或空列表表示仅与 labelSelector 匹配。 |
|
|
|
maxSkew 描述了 pod 可能没有被均匀分布的程度。当 |
|
|
| MinDomains 表示合格的域数量。当具有匹配拓扑键的合格域数量小于 minDomains 时，Pod Topology Spread 会将"global minimum"视为 0，然后执行 Skew 的计算。当匹配拓扑键等于或大于 minDomains 的合格域数量时，这个值不会影响调度。因此，当有资格的域数量小于 minDomains 时，调度程序不会将超过 maxSkew Pod 的调度到这些域。如果值为 nil，则约束的行为就像 MinDomains 等于 1 一样。有效值为大于 0 的整数。如果值不是 nil，WhenUnsatisfiable 必须是 DoNotSchedule。例如，在一个 3 个区集群中，MaxSkew 设置为 2，MinDomains 被设置为 5，且带有与 2/2/2: | zone1 | zone2 | zone2 | zone2 | zone3 | P P | P | P P | P P | P P | P P | 数量的域的数量小于 5 (MinDomains)，因此"global minimum"被视为 0。在这种情况下，如果新 Pod 调度到任何三个区域，则无法调度具有相同 labelSelector 的新 pod，因为 computed skew 将为 3 (3 - 0)，它将违反 MaxSkew。这是一个 beta 字段，需要启用 MinDomainsInPodTopologySpread 功能门（默认启用）。 |
|
|
| NodeAffinityPolicy 表示在计算 pod 拓扑分布偏移时，我们将如何处理 Pod 的 nodeAffinity/nodeSelector。选项为：- Honor：只有与 nodeAffinity/nodeSelector 匹配的节点才会包含在计算中。- Ignore: nodeAffinity/nodeSelector 会被忽略。所有节点都包含在计算中。如果这个值是 nil，则行为等同于 Honor 策略。这是 NodeInclusionPolicyInPodTopologySpread 功能默认启用的 beta 级别功能。 |
|
|
| NodeTaintsPolicy 指示在计算 pod 拓扑分布偏移时如何对待节点污点。选项为：- Honor: 没有污点的节点，以及传入的 pod 具有容限的污点节点。- Ignore: node taint are ignored.所有节点都包括在内。如果这个值是 nil，则行为等同于 Ignore 策略。这是 NodeInclusionPolicyInPodTopologySpread 功能默认启用的 beta 级别功能。 |
|
|
| topologyKey 是节点标签的密钥。带有具有此键和相同值标签的节点被视为在同一拓扑中。我们把每个 <key, value> 视为 "bucket"，并尝试将均衡的 pod 数量放在每个存储桶中。我们将域定义为拓扑的特定实例。另外，我们将一个有资格的域定义为节点满足 nodeAffinityPolicy 和 nodeTaintsPolicy 的要求的域。例如，如果 TopologyKey 为 "kubernetes.io/hostname"，则每个节点都是该拓扑的域。如果 TopologyKey 是 "topology.kubernetes.io/zone"，每个区都是该拓扑的域。这是必填字段。 |
|
|
| whenUnsatisfiable 表示如何在不满足分散约束的情况下处理 pod。- DoNotSchedule (default)告知调度程序不调度它。- ScheduleAnyway 告知调度程序将 pod 调度到任何位置，但为拓扑赋予更高优先级，有助于减少偏差。如果每个可能的节点分配都会在某些拓扑上违反"MaxSkew"，则约束被视为"不satisfiable"。例如，在一个 3 区集群中，MaxSkew 设置为 1，而具有与 3/1/1: | zone1 | zone2 | zone2 | zone3 | P P | P | P | P | P | P | P | P | P | WhenUnsatisfiable 设置为 DoNotSchedule 的 pod 只能调度到 zone2 (zone3)要成为 3/2/1 (3/1/2)，在 zone2 (zone3)中以 ActualSkew (2-1)满足 MaxSkew (1)。换句话说，集群仍然可以实现平衡，但调度程序不会使其更不平衡。这是必填字段。 |
7.1.81. .spec.topologySpreadConstraints[].labelSelector
- 描述
- labelSelector 用于查找匹配的 pod。与此标签选择器匹配的 Pod 被计算，以确定其对应拓扑域中的 pod 数量。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
7.1.82. .spec.topologySpreadConstraints[].labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
7.1.83. .spec.topologySpreadConstraints[].labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
7.1.84. .status
- 描述
- ImageRegistryStatus 报告镜像 registry 操作状态。
- 类型
-
object - 必填
-
storage -
storageManaged
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 存储指示 registry 的当前应用存储配置。 |
|
|
| StorageManaged 已被弃用，请参阅 Storage.managementState |
|
|
| 版本是此可用性适用的级别 |
7.1.85. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
7.1.86. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
7.1.87. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
7.1.88. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
7.1.89. .status.storage
- 描述
- 存储指示 registry 的当前应用存储配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Azure 代表使用 Azure Blob Storage 的配置。 |
|
|
| emptyDir 代表 pod 的主机节点上的临时存储。警告：此存储不能与超过 1 个副本一起使用，不适合生产用途。当因为某种原因从节点中删除 pod 时，emptyDir 中的数据会永久删除。 |
|
|
| GCS 代表使用 Google Cloud Storage 的配置。 |
|
|
| ibmcos 代表使用 IBM Cloud Object Storage 的配置。 |
|
|
| managementState 表示操作器是否管理底层存储单元。如果 Managed，Operator 会在此 Operator 被 Removed时删除存储。 |
|
|
| OSS 代表使用 Alibaba Cloud Object Storage Service 的配置。 |
|
|
| PVC 代表使用 PersistentVolumeClaim 的配置。 |
|
|
| s3 代表使用 Amazon Simple Storage Service 的配置。 |
|
|
| Swift 代表使用 OpenStack 对象存储的配置。 |
7.1.90. .status.storage.azure
- 描述
- Azure 代表使用 Azure Blob Storage 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accountName 定义 registry 使用的帐户。 |
|
|
| cloudName 是 registry 使用的 Azure 云环境的名称。如果为空，Operator 将基于 infrastructure 对象进行设置。 |
|
|
| 容器定义 registry 使用的 Azure 容器。 |
7.1.91. .status.storage.emptyDir
- 描述
- emptyDir 代表 pod 的主机节点上的临时存储。警告：此存储不能与超过 1 个副本一起使用，不适合生产用途。当因为某种原因从节点中删除 pod 时，emptyDir 中的数据会永久删除。
- 类型
-
对象
7.1.92. .status.storage.gcs
- 描述
- GCS 代表使用 Google Cloud Storage 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| bucket 是您要在其中存储 registry 数据的存储桶名称。可选，如果没有提供，则会生成。 |
|
|
| keyID 是用于加密的 KMS 密钥 ID。可选，在 GCP 上默认加密存储桶。这将允许使用一个自定义加密密钥。 |
|
|
| projectID 是此存储桶应与之关联的 GCP 项目的项目 ID。 |
|
|
| 存储桶所在的 GCS 位置。可选，将根据安装的 GCS 区域来设置。 |
7.1.93. .status.storage.ibmcos
- 描述
- ibmcos 代表使用 IBM Cloud Object Storage 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| bucket 是您要在其中存储 registry 数据的存储桶名称。可选，如果没有提供，则会生成。 |
|
|
| 位置是存储桶所在的 IBM Cloud 位置。可选，将根据安装的 IBM Cloud 位置进行设置。 |
|
|
| resourceGroupName 是此存储桶及其服务实例关联的 IBM Cloud 资源组的名称。可选，将根据安装的 IBM Cloud 资源组设置。 |
|
|
| resourceKeyCRN 是为服务实例创建的 IBM Cloud 资源密钥的 CRN。通常被称为服务凭证，必须包含 HMAC 类型凭证。可选，如果没有提供，则会计算。 |
|
|
| serviceInstanceCRN 是此存储桶关联的 IBM Cloud Object Storage 服务实例的 CRN。可选，如果没有提供，则会计算。 |
7.1.94. .status.storage.oss
- 描述
- OSS 代表使用 Alibaba Cloud Object Storage Service 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要在其中存储 registry 数据的存储桶名称。关于 Bucket 命名，您可以查看 [official 文档]（https://www.alibabacloud.com/help/doc-detail/257087.htmEmpty 值意味着没有建议，平台会选择默认值，这可能会随时间变化。目前，默认值将以 <clusterid>-image-registry-<region>-<random 字符串 27 chars> 的形式自动生成 |
|
|
| encryption 指定是否想在服务器端加密数据。如需了解更多详细信息，您可以查看 [official 文档](https://www.alibabacloud.com/help/doc-detail/117914.htm) |
|
|
|
EndpointAccessibility 指定 registry 是否使用 OSS VPC 内部端点 Empty 值，意味着没有建议，平台会选择默认值，可能会随时间变化。目前，默认为 |
|
|
| 区域是存在存储桶的 Alibaba Cloud 区域。如需区域列表，您可以查看[官方文档](https://www.alibabacloud.com/help/doc-detail/31837.html)。空值表示没有建议，平台会选择默认值，这可能会随时间变化。目前，默认值将基于安装的 Alibaba Cloud 区域。 |
7.1.95. .status.storage.oss.encryption
- 描述
- encryption 指定是否想在服务器端加密数据。如需了解更多详细信息，您可以查看 [official 文档](https://www.alibabacloud.com/help/doc-detail/117914.htm)
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| KMS （密钥管理服务）是一个加密类型，其中包含 KMS KeyID 的结构 |
|
|
|
method 定义可用的 Empty 值的不同保护模式意味着没有建议，平台会选择默认值，这可能会随时间变化。目前，默认为 |
7.1.96. .status.storage.oss.encryption.kms
- 描述
- KMS （密钥管理服务）是一个加密类型，其中包含 KMS KeyID 的结构
- 类型
-
object - 必填
-
keyID
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| keyID 包含 KMS 加密密钥 ID |
7.1.97. .status.storage.pvc
- 描述
- PVC 代表使用 PersistentVolumeClaim 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 声明定义要使用的永久卷声明的名称。 |
7.1.98. .status.storage.s3
- 描述
- s3 代表使用 Amazon Simple Storage Service 的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| bucket 是您要在其中存储 registry 数据的存储桶名称。可选，如果没有提供，则会生成。 |
|
|
| CloudFront 将 Amazon Cloudfront 配置为 registry 中的存储中间件。 |
|
|
| encrypt 指定 registry 是否以加密格式存储镜像。可选，默认为 false。 |
|
|
| keyID 是用于加密的 KMS 密钥 ID。可选，Encrypt 必须为 true，否则此参数将被忽略。 |
|
|
| 存储桶所在的 AWS 区域。可选，将根据安装的 AWS 区域来设置。 |
|
|
| regionendpoint 是 S3 兼容存储服务的端点。它应该是带有 方案 的有效 URL，例如 https://s3.example.com。可选，基于提供的 Region。 |
|
|
| trustedCA 是包含 CA 捆绑包的配置映射的引用。镜像 registry 及其 Operator 使用此捆绑包中的证书来验证 S3 服务器证书。被 trustedCA 引用的配置映射的命名空间为 "openshift-config"。配置映射中捆绑包的密钥为 "ca-bundle.crt"。 |
|
|
| virtualHostedStyle 启用 S3 虚拟主机风格存储桶路径以及自定义 RegionEndpoint 可选，默认为 false。 |
7.1.99. .status.storage.s3.cloudFront
- 描述
- CloudFront 将 Amazon Cloudfront 配置为 registry 中的存储中间件。
- 类型
-
object - 必填
-
baseURL -
keypairID -
privateKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| baseurl 包含 SCHEME://HOST[/PATH]，在其中提供 Cloudfront。 |
|
|
| duration 是 Cloudfront 会话的持续时间。 |
|
|
| keypairID 是 AWS 提供的密钥对 ID。 |
|
|
| Privatekey 指向包含 AWS 提供的私钥的 secret。 |
7.1.100. .status.storage.s3.cloudFront.privateKey
- 描述
- Privatekey 指向包含 AWS 提供的私钥的 secret。
- 类型
-
object - 必填
-
key
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。 |
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？ |
|
|
| 指定是否需要定义 Secret 还是其密钥 |
7.1.101. .status.storage.s3.trustedCA
- 描述
- trustedCA 是包含 CA 捆绑包的配置映射的引用。镜像 registry 及其 Operator 使用此捆绑包中的证书来验证 S3 服务器证书。被 trustedCA 引用的配置映射的命名空间为 "openshift-config"。配置映射中捆绑包的密钥为 "ca-bundle.crt"。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是引用的配置映射的 metadata.name。此字段必须遵循标准配置映射命名限制。名称只能包含字母数字字符、连字符(-)和句点(.)。它的最大长度为 253 个字符。如果没有指定此字段或为空字符串，则会使用默认信任捆绑包。 |
7.1.102. .status.storage.swift
- 描述
- Swift 代表使用 OpenStack 对象存储的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| authURL 定义用于获取身份验证令牌的 URL。 |
|
|
| authVersion 指定 OpenStack Auth 的版本。 |
|
|
| 容器定义用于存储 registry 数据的 Swift 容器的名称。 |
|
|
| domain 指定 Identity v3 API 的 Openstack 的域名。 |
|
|
| domainID 为 Identity v3 API 指定 Openstack 的 domain id。 |
|
|
| regionName 定义容器所在的 Openstack 区域。 |
|
|
| 租户定义 registry 使用的 Openstack 租户名称。 |
|
|
| 租户定义 registry 使用的 Openstack 租户 id。 |
7.2. API 端点
可用的 API 端点如下：
/apis/imageregistry.operator.openshift.io/v1/configs-
DELETE：删除配置集合 -
GET: 列出类型为 Config 的对象 -
POST：创建配置
-
/apis/imageregistry.operator.openshift.io/v1/configs/{name}-
DELETE：删除配置 -
GET：读取指定的配置 -
PATCH: 部分更新指定的配置 -
PUT：替换指定的 Config
-
/apis/imageregistry.operator.openshift.io/v1/configs/{name}/status-
GET：指定配置的读取状态 -
PATCH: 部分更新指定配置的状态 -
PUT：替换指定配置的状态
-
7.2.1. /apis/imageregistry.operator.openshift.io/v1/configs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除配置集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 Config 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
7.2.2. /apis/imageregistry.operator.openshift.io/v1/configs/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Config 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 Config
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 Config
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
7.2.3. /apis/imageregistry.operator.openshift.io/v1/configs/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Config 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定配置的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定配置的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定配置的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 8 章 config [samples.operator.openshift.io/v1]
- 描述
- config 包含 Samples Operator 的配置和详细条件状态。
- 类型
-
object - 必填
-
metadata -
spec
-
8.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 | |
|
|
| ConfigSpec 包含 Samples Operator 所需的配置和状态，控制其在 openshift 命名空间中创建/updates 的镜像流和模板的各种行为。 |
|
|
| ConfigStatus 包含实际有效的配置，以及描述 Samples Operator 状态的各种详细信息。 |
8.1.1. .spec
- 描述
- ConfigSpec 包含 Samples Operator 所需的配置和状态，控制其在 openshift 命名空间中创建/updates 的镜像流和模板的各种行为。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 架构决定了安装哪些硬件架构，其中 x86_64、ppc64le 和 s390x 目前是唯一受支持的选择。 |
|
|
| managementState 是所有 Operator 的交换机上/关闭类型的顶级。当"管理"时，此操作器会处理配置并相应地操作示例。当"Unmanaged"时，此操作器会忽略它监视的资源的任何更新。当"Removed"时，它会像删除 Config 对象一样做出反应，这意味着它管理的任何 ImageStreams 或模板（例如，它遵循跳过的列表），并且 registry secret 被删除，以及 Operator 命名空间中的 ConfigMap 来表示用于操作示例的最后一个配置， |
|
|
| samplesRegistry 允许指定由 ImageStreams 访问其镜像内容的 registry。默认为 https://github.com/openshift/library 中拉取到这个 github 存储库的内容，但基于拉取只拉取的 ocp 内容，它通常默认为 registry.redhat.io。 |
|
|
| skippedImagestreams 指定不应创建/更新的镜像流的名称。管理员可以使用此方法删除他们不希望的内容。它们仍需要手动删除内容，但 Operator 不会在此处重新创建（或更新）任何列出的内容。 |
|
|
| skippedTemplates 指定不应创建/更新的模板的名称。管理员可以使用此方法删除他们不希望的内容。它们仍需要手动删除内容，但 Operator 不会在此处重新创建（或更新）任何列出的内容。 |
8.1.2. .status
- 描述
- ConfigStatus 包含实际有效的配置，以及描述 Samples Operator 状态的各种详细信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 架构决定要安装的硬件架构，其中 x86_64 和 ppc64le 是支持的选择。 |
|
|
| conditions 代表示例镜像流和模板的可用维护状态。 |
|
|
| ConfigCondition 会在处理条目时捕获配置的各种条件。 |
|
|
| managementState 反映了 Operator 的 on/off 开关的当前状态。该运算符将 ManagementState 作为确定我们重新打开 Operator 的一部分（例如，"受管"）之前是"Unmanaged"的时候。 |
|
|
| samplesRegistry 允许指定由 ImageStreams 访问其镜像内容的 registry。默认为 https://github.com/openshift/library 中拉取到这个 github 存储库的内容，但基于拉取只拉取的 ocp 内容，它通常默认为 registry.redhat.io。 |
|
|
| skippedImagestreams 指定不应创建/更新的镜像流的名称。管理员可以使用此方法删除他们不希望的内容。它们仍需要手动删除内容，但 Operator 不会在此处重新创建（或更新）任何列出的内容。 |
|
|
| skippedTemplates 指定不应创建/更新的模板的名称。管理员可以使用此方法删除他们不希望的内容。它们仍需要手动删除内容，但 Operator 不会在此处重新创建（或更新）任何列出的内容。 |
|
|
| version 是基于 Operator 有效负载的版本指示符的值，在最后一次成功处理时 |
8.1.3. .status.conditions
- 描述
- conditions 代表示例镜像流和模板的可用维护状态。
- 类型
-
array
8.1.4. .status.conditions[]
- 描述
- ConfigCondition 会在处理条目时捕获配置的各种条件。
- 类型
-
object - 必填
-
status -
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。 |
|
|
| lastUpdateTime 是此条件最后一次更新的时间。 |
|
|
| Message 是人类可读的消息，指示有关转换的详细信息。 |
|
|
| 原因是导致条件最后一次转换的原因。 |
|
|
| 条件的状态，True, False, Unknown 之一。 |
|
|
| 条件类型。 |
8.2. API 端点
可用的 API 端点如下：
/apis/samples.operator.openshift.io/v1/configs-
DELETE：删除配置集合 -
GET: 列出类型为 Config 的对象 -
POST：创建配置
-
/apis/samples.operator.openshift.io/v1/configs/{name}-
DELETE：删除配置 -
GET：读取指定的配置 -
PATCH: 部分更新指定的配置 -
PUT：替换指定的 Config
-
/apis/samples.operator.openshift.io/v1/configs/{name}/status-
GET：指定配置的读取状态 -
PATCH: 部分更新指定配置的状态 -
PUT：替换指定配置的状态
-
8.2.1. /apis/samples.operator.openshift.io/v1/configs
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除配置集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 Config 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
8.2.2. /apis/samples.operator.openshift.io/v1/configs/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Config 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 Config
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的配置
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 Config
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
8.2.3. /apis/samples.operator.openshift.io/v1/configs/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Config 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定配置的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定配置的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定配置的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 9 章 CSISnapshotController [operator.openshift.io/v1]
- 描述
-
CSISnapshotController 提供了配置 Operator 来管理 CSI 快照的方法。
Cluster是规范名称。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。 - 类型
-
object - 必填
-
spec
-
9.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 | |
|
|
| spec 包含用于配置的用户可设置值 |
|
|
| status 包含从集群中观察到的值。它们可能无法被覆盖。 |
9.1.1. .spec
- 描述
- spec 包含用于配置的用户可设置值
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
9.1.2. .status
- 描述
- status 包含从集群中观察到的值。它们可能无法被覆盖。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
9.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
9.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
9.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
9.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
9.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/csisnapshotcontrollers-
DELETE: 删除 CSISnapshotController 集合 -
GET: 列出类型为 CSISnapshotController 的对象 -
POST：创建一个 CSISnapshotController
-
/apis/operator.openshift.io/v1/csisnapshotcontrollers/{name}-
DELETE: 删除 CSISnapshotController -
GET: 读取指定的 CSISnapshotController -
PATCH: 部分更新指定的 CSISnapshotController -
PUT：替换指定的 CSISnapshotController
-
/apis/operator.openshift.io/v1/csisnapshotcontrollers/{name}/status-
GET：指定 CSISnapshotController 的读取状态 -
PATCH: 部分更新指定 CSISnapshotController 的状态 -
PUT：替换指定 CSISnapshotController 的状态
-
9.2.1. /apis/operator.openshift.io/v1/csisnapshotcontrollers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CSISnapshotController 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 CSISnapshotController 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 CSISnapshotController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
9.2.2. /apis/operator.openshift.io/v1/csisnapshotcontrollers/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CSISnapshotController 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 CSISnapshotController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 阅读指定的 CSISnapshotController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 CSISnapshotController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 CSISnapshotController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
9.2.3. /apis/operator.openshift.io/v1/csisnapshotcontrollers/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| CSISnapshotController 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 CSISnapshotController 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 CSISnapshotController 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 CSISnapshotController 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 10 章 DNS [operator.openshift.io/v1]
- 描述
- DNS 管理 CoreDNS 组件，为集群中的 pod 和服务提供名称解析服务。这支持基于 DNS 的服务发现规格： https://github.com/kubernetes/dns/blob/master/docs/specification.md 更多详情： https://kubernetes.io/docs/tasks/administer-cluster/coredns 兼容性级别 1: 在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
10.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 | |
|
|
| spec 是 DNS 所需的行为的规格。 |
|
|
| Status 是 DNS 最近观察到的状态。 |
10.1.1. .spec
- 描述
- spec 是 DNS 所需的行为的规格。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| cache 描述了适用于 Corefile 中列出的所有服务器块的缓存配置。此字段允许集群管理员选择性地配置：* positiveTTL，它是一个应缓存正响应的持续时间。* 负TTL，这是应缓存负响应的持续时间。如果没有配置，OpenShift 将使用可能会更改的默认值配置正和负缓存。在编写本文时，默认的 positiveTTL 是 900 秒，默认的负TTL 为 30 秒，或者在您的 OpenShift 版本对应的 Corefile 中记录。 |
|
|
| Loglevel 描述了 CoreDNS 所需的日志详细程度。可以指定以下值之一： 上游解析器中的普通日志错误。* 调试日志错误、NXDOMAIN 响应和 NODATA 响应。* 跟踪日志错误和所有响应。设置 logLevel: Trace 将生成非常详细的日志。有效值为："Normal", "Debug", "Trace"。默认值为 "Normal"。 |
|
|
| managementState 指明 DNS 操作器是否应该管理集群 DNS |
|
|
| nodePlacement 提供对 DNS pod 调度的明确控制。通常，在每个节点上运行 DNS pod，以便 DNS 查询始终由本地 DNS pod 处理，而不是通过网络传输到另一个节点上的 DNS pod。但是，安全策略可能需要将 DNS pod 的放置限制到特定的节点。例如，如果安全策略禁止任意节点上的 pod 与 API 通信，则可以指定节点选择器，将 DNS pod 限制到允许与 API 通信的节点。相反，如果需要在具有特定污点的节点上运行 DNS pod，可以为该污点指定容限。如果未设置，则使用默认值。如需了解更多详细信息，请参阅 nodePlacement。 |
|
|
| operatorLogLevel 控制 DNS Operator 的日志记录级别。有效值为："Normal", "Debug", "Trace"。默认为 "Normal"。设置 operatorLogLevel: Trace 将生成非常详细的日志。 |
|
|
| 服务器是 DNS 解析器列表，它为集群域范围之外的一个或多个子域提供名称查询委托。如果服务器由多个服务器组成，则将使用最长后缀匹配来确定服务器。例如，如果有两个服务器，一个用于 "foo.com"，另一个用于 "a.foo.com"，名称查询是 "www.a.foo.com"，它将路由到带有 Zone "a.foo.com" 的 Server。如果此字段为 nil，则不会创建服务器。 |
|
|
| 服务器定义每个 CoreDNS 实例运行的服务器的 schema。 |
|
|
| upstreamResolver 定义了一个模式，用于将 CoreDNS 配置为将 DNS 消息代理到默认(".")服务器的情况（如果未指定此字段），则使用上游将默认为 /etc/resolv.conf，策略 "sequential" |
10.1.2. .spec.cache
- 描述
- cache 描述了适用于 Corefile 中列出的所有服务器块的缓存配置。此字段允许集群管理员选择性地配置：* positiveTTL，它是一个应缓存正响应的持续时间。* 负TTL，这是应缓存负响应的持续时间。如果没有配置，OpenShift 将使用可能会更改的默认值配置正和负缓存。在编写本文时，默认的 positiveTTL 是 900 秒，默认的负TTL 为 30 秒，或者在您的 OpenShift 版本对应的 Corefile 中记录。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| negativeTTL 是可选的，指定应缓存负响应的时间长度。如果配置，它必须是 1s (1 秒)或大于理论最多的数年值。此字段需要未签名的持续时间字符串为十进制数字，每个数字都有可选的 fraction 和一个单元后缀，如。"100s", "1m30s", "12h30m10s".值为一秒的分数值将舍入到最接近的秒。如果配置的值小于 1s，则使用默认值。如果没有配置，则该值为 0，OpenShift 将使用默认值 30 秒，除非在相应 OpenShift 版本的 Corefile 中另有说明。默认值 30 秒可能会改变。 |
|
|
| positiveTTL 是可选的，指定应缓存正响应的时间长度。如果配置，它必须是 1s (1 秒)或大于理论最多的数年值。此字段需要未签名的持续时间字符串为十进制数字，每个数字都有可选的 fraction 和一个单元后缀，如。"100s", "1m30s", "12h30m10s".值为一秒的分数值将舍入到最接近的秒。如果配置的值小于 1s，则使用默认值。如果没有配置，则该值为 0s，OpenShift 将使用默认值 900 秒，除非在相应 OpenShift 版本的 Corefile 中另有说明。900 秒的默认值可能会改变。 |
10.1.3. .spec.nodePlacement
- 描述
- nodePlacement 提供对 DNS pod 调度的明确控制。通常，在每个节点上运行 DNS pod，以便 DNS 查询始终由本地 DNS pod 处理，而不是通过网络传输到另一个节点上的 DNS pod。但是，安全策略可能需要将 DNS pod 的放置限制到特定的节点。例如，如果安全策略禁止任意节点上的 pod 与 API 通信，则可以指定节点选择器，将 DNS pod 限制到允许与 API 通信的节点。相反，如果需要在具有特定污点的节点上运行 DNS pod，可以为该污点指定容限。如果未设置，则使用默认值。如需了解更多详细信息，请参阅 nodePlacement。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| nodeSelector 是应用到 DNS pod 的节点选择器。如果为空，则使用默认值，它目前如下：kubernetes.io/os: linux，这是可能会更改的。如果设置，则使用指定的选择器并替换默认值。 |
|
|
| tolerations 是应用到 DNS pod 的容限列表。如果为空，DNS 操作器会为 "node-role.kubernetes.io/master" 污点设置容限。这个默认设置可能会改变。在没有包括 "node-role.kubernetes.io/master" 污点的容限的情况下指定容限可能会带来风险，因为在所有 worker 节点都不可用时可能会导致停机。请注意，守护进程控制器也会添加一些容限。See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ |
|
|
| 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。 |
10.1.4. .spec.nodePlacement.tolerations
- 描述
- tolerations 是应用到 DNS pod 的容限列表。如果为空，DNS 操作器会为 "node-role.kubernetes.io/master" 污点设置容限。这个默认设置可能会改变。在没有包括 "node-role.kubernetes.io/master" 污点的容限的情况下指定容限可能会带来风险，因为在所有 worker 节点都不可用时可能会导致停机。请注意，守护进程控制器也会添加一些容限。See https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/
- 类型
-
array
10.1.5. .spec.nodePlacement.tolerations[]
- 描述
- 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| effect 表示要匹配的污点效果。空意味着匹配所有污点效果。指定后，允许的值为 NoSchedule，PreferNoSchedule 和 NoExecute。 |
|
|
| key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空，则必须存在运算符；组合意味着匹配所有值和所有键。 |
|
|
| Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认值为 Equal。exists 等同于值的通配符，以便 pod 可以容忍特定类别的所有污点。 |
|
|
| tolerationSeconds 代表容限的期间（必须生效 NoExecute，否则此字段将被忽略）可以容忍污点。默认情况下，它不会被设置，这意味着容许任何污点（不要驱除）。零值和负值将被视为 0 （立即删除）。 |
|
|
| value 是容限匹配的污点值。如果运算符是 Exists，则该值应该为空，否则仅是一个常规字符串。 |
10.1.6. .spec.servers
- 描述
- 服务器是 DNS 解析器列表，它为集群域范围之外的一个或多个子域提供名称查询委托。如果服务器由多个服务器组成，则将使用最长后缀匹配来确定服务器。例如，如果有两个服务器，一个用于 "foo.com"，另一个用于 "a.foo.com"，名称查询是 "www.a.foo.com"，它将路由到带有 Zone "a.foo.com" 的 Server。如果此字段为 nil，则不会创建服务器。
- 类型
-
array
10.1.7. .spec.servers[]
- 描述
- 服务器定义每个 CoreDNS 实例运行的服务器的 schema。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| forwardPlugin 定义了一个模式，用于将 CoreDNS 配置为将 DNS 信息代理到上游解析器。 |
|
|
| name 是必需的，并指定服务器的唯一名称。name 必须符合 rfc6335 的 Service Name 语法。 |
|
|
| zones 是必需的，并指定服务器对其具有权威的子域。zones 必须符合子域的 rfc1123 定义。指定集群域（例如，"cluster.local"）无效。 |
10.1.8. .spec.servers[].forwardPlugin
- 描述
- forwardPlugin 定义了一个模式，用于将 CoreDNS 配置为将 DNS 信息代理到上游解析器。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 策略用于决定选择上游服务器进行查询的顺序。可以指定以下值之一：*"Random"为每个查询选择一个随机的上游服务器。* "robin" 以轮循顺序选择上游服务器，移动到每个新查询的下一服务器。* "sequential" 会尝试以顺序顺序查询上游服务器，直到一个响应，从第一个服务器开始进行每个新查询。默认值为 "Random" |
|
|
| protocolStrategy 指定用于上游 DNS 请求的协议。protocolStrategy 的有效值为 "TCP" 并省略。省略时，这意味着没有建议，平台会被保留选择合理的默认值，这可能会随时间变化。当前的默认值是使用原始客户端请求的协议。"TCP"指定平台应对所有上游 DNS 请求使用 TCP，即使客户端请求使用了 UDP。"TCP"对于特定于 UDP 的问题（如由不合规的上游解析器创建）非常有用，但可能会消耗更多带宽或增加 DNS 响应时间。请注意，protocolStrategy 只会影响 CoreDNS 向上游解析器进行的 DNS 请求的协议。它不会影响客户端和 CoreDNS 之间的 DNS 请求的协议。 |
|
|
| transportConfig 用于配置传输类型、服务器名称和可选的自定义 CA 或 CA 捆绑包，以便在将 DNS 请求转发到上游解析器时使用。默认值为 "" （空），这会导致在将 DNS 请求转发到上游解析器时使用的标准明文连接。 |
|
|
| upstreams 是为区域子域转发名称查询的解析器列表。CoreDNS 的每个实例都执行 Upstreams 的健康检查。当一个健康的上游在交换过程中返回错误时，会从 Upstreams 试图另一个解析器。Upstreams 按照 Policy 中指定的顺序选择。如果上游监听 53 之外的端口，则每个上游都由 IP 地址或 IP:port 表示。每个 ForwardPlugin 最多允许 15 个 upstreams。 |
10.1.9. .spec.servers[].forwardPlugin.transportConfig
- 描述
- transportConfig 用于配置传输类型、服务器名称和可选的自定义 CA 或 CA 捆绑包，以便在将 DNS 请求转发到上游解析器时使用。默认值为 "" （空），这会导致在将 DNS 请求转发到上游解析器时使用的标准明文连接。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| TLS 包含将 Transport 设置为 "TLS" 时使用的附加配置选项。 |
|
|
| 通过传输，集群管理员可以选择在集群 DNS 和上游解析器之间使用 DNS-over-TLS 连接。在没有配置 CABundle 的情况下将 TLS 配置为传输会导致系统证书用于验证上游解析器的服务证书。可能的值有： "" (empty)- 这意味着没有明确的选择，平台会选择可能会随时间变化的默认值。当前默认为 "Cleartext"。"cleartext" - Cluster admin 指定明文选项。这会导致功能与空值相同，但当集群管理员想要更明确地了解传输时，或者希望明确从 "TLS" 切换到 "Cleartext" 时，可能会很有用。"TLS" - 这表示 DNS 查询应该通过 TLS 连接发送。如果传输设置为 TLS，则必须同时设置 ServerName。如果上游 IP 不包含端口，则根据 RFC 7858 第 3.1 节 https://datatracker.ietf.org/doc/html/rfc7858#section-3.1，默认尝试端口 853。 |
10.1.10. .spec.servers[].forwardPlugin.transportConfig.tls
- 描述
- TLS 包含将 Transport 设置为 "TLS" 时使用的附加配置选项。
- 类型
-
object - 必填
-
serverName
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
CABundle 引用必须包含单个 CA 证书或 CA 捆绑包的 ConfigMap。这允许集群管理员提供自己的 CA 或 CA 捆绑包来验证上游解析器的证书。1.configmap 必须包含 |
|
|
| ServerName 是在转发 DNS 查询时要连接的上游服务器。当将 Transport 设置为 "TLS" 时，需要此项。ServerName 将根据 RFC 1123 中的 DNS 命名约定进行验证，并且应与上游解析器中安装的 TLS 证书匹配。 |
10.1.11. .spec.servers[].forwardPlugin.transportConfig.tls.caBundle
- 描述
-
CABundle 引用必须包含单个 CA 证书或 CA 捆绑包的 ConfigMap。这允许集群管理员提供自己的 CA 或 CA 捆绑包来验证上游解析器的证书。1.configmap 必须包含
ca-bundle.crt键。2.该值必须是 PEM 编码的 CA 证书或 CA 捆绑包。3.管理员必须在 openshift-config 命名空间中创建此 configmap。4.上游服务器证书必须包含与 ServerName 匹配的主题备用名称(SAN)。 - 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是引用的配置映射的 metadata.name |
10.1.12. .spec.upstreamResolvers
- 描述
- upstreamResolver 定义了一个模式，用于将 CoreDNS 配置为将 DNS 消息代理到默认(".")服务器的情况（如果未指定此字段），则使用上游将默认为 /etc/resolv.conf，策略 "sequential"
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 策略用于决定选择上游服务器进行查询的顺序。可以指定以下值之一：*"Random"为每个查询选择一个随机的上游服务器。* "robin" 以轮循顺序选择上游服务器，移动到每个新查询的下一服务器。* "sequential" 会尝试以顺序顺序查询上游服务器，直到一个响应，从第一个服务器开始进行每个新查询。默认值为 "Sequential" |
|
|
| protocolStrategy 指定用于上游 DNS 请求的协议。protocolStrategy 的有效值为 "TCP" 并省略。省略时，这意味着没有建议，平台会被保留选择合理的默认值，这可能会随时间变化。当前的默认值是使用原始客户端请求的协议。"TCP"指定平台应对所有上游 DNS 请求使用 TCP，即使客户端请求使用了 UDP。"TCP"对于特定于 UDP 的问题（如由不合规的上游解析器创建）非常有用，但可能会消耗更多带宽或增加 DNS 响应时间。请注意，protocolStrategy 只会影响 CoreDNS 向上游解析器进行的 DNS 请求的协议。它不会影响客户端和 CoreDNS 之间的 DNS 请求的协议。 |
|
|
| transportConfig 用于配置传输类型、服务器名称和可选的自定义 CA 或 CA 捆绑包，以便在将 DNS 请求转发到上游解析器时使用。默认值为 "" （空），这会导致在将 DNS 请求转发到上游解析器时使用的标准明文连接。 |
|
|
| upstreams 是向 "." 域转发名称查询的解析器列表。CoreDNS 的每个实例都执行 Upstreams 的健康检查。当一个健康的上游在交换过程中返回错误时，会从 Upstreams 试图另一个解析器。Upstreams 按照 Policy 中指定的顺序选择。每个 ForwardPlugin 最多允许 15 个 upstreams。如果没有指定 Upstreams，则默认使用 /etc/resolv.conf |
|
|
| 上游可以是 SystemResolvConf 类型，也可以是网络类型。* 对于 SystemResolvConf 的 Upstream 类型，不需要进一步的字段：上游将配置为使用 /etc/resolv.conf。Stop for an Upstream type Network，如果上游监听端口为 53，则需要使用 NetworkResolver 字段定义 IP 地址或 IP:port。 |
10.1.13. .spec.upstreamResolvers.transportConfig
- 描述
- transportConfig 用于配置传输类型、服务器名称和可选的自定义 CA 或 CA 捆绑包，以便在将 DNS 请求转发到上游解析器时使用。默认值为 "" （空），这会导致在将 DNS 请求转发到上游解析器时使用的标准明文连接。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| TLS 包含将 Transport 设置为 "TLS" 时使用的附加配置选项。 |
|
|
| 通过传输，集群管理员可以选择在集群 DNS 和上游解析器之间使用 DNS-over-TLS 连接。在没有配置 CABundle 的情况下将 TLS 配置为传输会导致系统证书用于验证上游解析器的服务证书。可能的值有： "" (empty)- 这意味着没有明确的选择，平台会选择可能会随时间变化的默认值。当前默认为 "Cleartext"。"cleartext" - Cluster admin 指定明文选项。这会导致功能与空值相同，但当集群管理员想要更明确地了解传输时，或者希望明确从 "TLS" 切换到 "Cleartext" 时，可能会很有用。"TLS" - 这表示 DNS 查询应该通过 TLS 连接发送。如果传输设置为 TLS，则必须同时设置 ServerName。如果上游 IP 不包含端口，则根据 RFC 7858 第 3.1 节 https://datatracker.ietf.org/doc/html/rfc7858#section-3.1，默认尝试端口 853。 |
10.1.14. .spec.upstreamResolvers.transportConfig.tls
- 描述
- TLS 包含将 Transport 设置为 "TLS" 时使用的附加配置选项。
- 类型
-
object - 必填
-
serverName
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
CABundle 引用必须包含单个 CA 证书或 CA 捆绑包的 ConfigMap。这允许集群管理员提供自己的 CA 或 CA 捆绑包来验证上游解析器的证书。1.configmap 必须包含 |
|
|
| ServerName 是在转发 DNS 查询时要连接的上游服务器。当将 Transport 设置为 "TLS" 时，需要此项。ServerName 将根据 RFC 1123 中的 DNS 命名约定进行验证，并且应与上游解析器中安装的 TLS 证书匹配。 |
10.1.15. .spec.upstreamResolvers.transportConfig.tls.caBundle
- 描述
-
CABundle 引用必须包含单个 CA 证书或 CA 捆绑包的 ConfigMap。这允许集群管理员提供自己的 CA 或 CA 捆绑包来验证上游解析器的证书。1.configmap 必须包含
ca-bundle.crt键。2.该值必须是 PEM 编码的 CA 证书或 CA 捆绑包。3.管理员必须在 openshift-config 命名空间中创建此 configmap。4.上游服务器证书必须包含与 ServerName 匹配的主题备用名称(SAN)。 - 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是引用的配置映射的 metadata.name |
10.1.16. .spec.upstreamResolvers.upstreams
- 描述
- upstreams 是向 "." 域转发名称查询的解析器列表。CoreDNS 的每个实例都执行 Upstreams 的健康检查。当一个健康的上游在交换过程中返回错误时，会从 Upstreams 试图另一个解析器。Upstreams 按照 Policy 中指定的顺序选择。每个 ForwardPlugin 最多允许 15 个 upstreams。如果没有指定 Upstreams，则默认使用 /etc/resolv.conf
- 类型
-
数组
10.1.17. .spec.upstreamResolvers.upstreams[]
- 描述
- 上游可以是 SystemResolvConf 类型，也可以是网络类型。* 对于 SystemResolvConf 的 Upstream 类型，不需要进一步的字段：上游将配置为使用 /etc/resolv.conf。Stop for an Upstream type Network，如果上游监听端口为 53，则需要使用 NetworkResolver 字段定义 IP 地址或 IP:port。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 当 Type 设为 Network 时，必须定义地址。否则它将会被忽略。它必须是有效的 ipv4 或 ipv6 地址。 |
|
|
| 当 Type 设为 Network 时，可以定义端口。否则它将会被忽略。端口必须在 65535 之间 |
|
|
| type 定义此上游是否包含 IP/IP:port 解析器或本地 /etc/resolv.conf。type 接受 2 可能的值： SystemResolvConf 或 Network。* 当使用 SystemResolvConf 时，Upstream 结构不需要定义任何其他字段：/etc/resolv.conf 将使用 * when Network 时，Upstream 结构必须至少包含一个地址 |
10.1.18. .status
- 描述
- Status 是 DNS 最近观察到的状态。
- 类型
-
object - 必填
-
clusterDomain -
clusterIP
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| clusterDomain 是 DNS 服务的本地集群 DNS 域后缀。这将是 RFC 1034 中定义的子域，第 3.5 节： https://tools.ietf.org/html/rfc1034#section-3.5 示例： "cluster.local" more info: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service |
|
|
| ClusterIP 是提供此 DNS 的服务 IP。如果是默认的 DNS，它将是一个已知的 IP，用作使用默认 ClusterFirst DNS 策略的 pod 的默认名称服务器。通常，此 IP 可以在 pod 的 spec.dnsConfig.nameservers 列表中指定，或者在从集群中执行名称解析时明确使用。示例：dig foo.com @<service IP> 更多信息： https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
|
|
| 条件提供有关集群中 DNS 状态的信息。这些是支持的 DNS 条件：在满足以下条件时为 Available - True ：如果有任何条件不满意，则为 False。 |
|
|
| OperatorCondition 只是标准条件字段。 |
10.1.19. .status.conditions
- 描述
- 条件提供有关集群中 DNS 状态的信息。这些是支持的 DNS 条件：在满足以下条件时为 Available - True ：如果有任何条件不满意，则为 False。
- 类型
-
array
10.1.20. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
10.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/dnses-
DELETE：删除 DNS 集合 -
GET: 列出类型为 DNS 的对象 -
POST：创建 DNS
-
/apis/operator.openshift.io/v1/dnses/{name}-
DELETE：删除 DNS -
GET：读取指定的 DNS -
PATCH: 部分更新指定的 DNS -
PUT：替换指定的 DNS
-
/apis/operator.openshift.io/v1/dnses/{name}/status-
GET：指定 DNS 的读取状态 -
PATCH: 部分更新指定 DNS 的状态 -
PUT：替换指定 DNS 的状态
-
10.2.1. /apis/operator.openshift.io/v1/dnses
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 DNS 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 DNS 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 DNS
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
10.2.2. /apis/operator.openshift.io/v1/dnses/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| DNS 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 DNS
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 DNS
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 DNS
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 DNS
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
10.2.3. /apis/operator.openshift.io/v1/dnses/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| DNS 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 DNS 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 DNS 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 DNS 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 11 章 DNSRecord [ingress.operator.openshift.io/v1]
- 描述
- dnsrecord 是 dns.config.openshift.io/cluster .spec.publicZone 和 .spec.privateZone 定义的区域管理的 DNS 记录。不支持此资源的集群管理员操作。此资源仅用于 OpenShift 操作器的内部通信。如果 DNSManagementPolicy 为 "Unmanaged"，Operator 将无法管理云供应商上的 DNS 记录。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
11.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 | |
|
|
| spec 是 dnsRecord 的所需行为的规格。 |
|
|
| status 是 dnsRecord 的最新观察状态。 |
11.1.1. .spec
- 描述
- spec 是 dnsRecord 的所需行为的规格。
- 类型
-
object - 必填
-
dnsManagementPolicy -
dnsName -
recordTTL -
recordType -
目标
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| dnsManagementPolicy 表示在 DNS 记录中应用的当前策略。ingress operator 会忽略策略设置为 "Unmanaged" 的记录。这意味着云供应商上的 DNS 记录不由操作员管理，"Published"状态条件将更新为"Unknown"状态，因为它是外部管理的。云供应商上的任何现有记录都可以由集群管理员自行删除。此字段默认为 Managed。有效值为 "Managed" 和 "Unmanaged"。 |
|
|
| dnsName 是 DNS 记录的主机名 |
|
|
| recordTTL 是记录 TTL （以秒为单位）。如果为零，则默认为 30。RecordTTL 不会在 AWS 区域别名目标中使用，但将根据 AWS API 合同在 CNAME 目标中使用。 |
|
|
| recordType 是 DNS 记录类型。例如："A" 或 "CNAME"。 |
|
|
| 目标是记录目标。 |
11.1.2. .status
- 描述
- status 是 dnsRecord 的最新观察状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| observedGeneration 是 DNSRecord 最近观察到的生成。更新 DNSRecord 时，控制器会更新每个受管区中的对应记录。如果特定区的更新失败，则该失败记录在区域的状态条件中，以便控制器可以确定需要为该特定区重试更新。 |
|
|
| zones 是每个区域中的记录状态。 |
|
|
| DNSZoneStatus 是特定区域中的记录的状态。 |
11.1.3. .status.zones
- 描述
- zones 是每个区域中的记录状态。
- 类型
-
array
11.1.4. .status.zones[]
- 描述
- DNSZoneStatus 是特定区域中的记录的状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 条件是与区域中记录关联的任何条件。如果发布记录成功，"Published" 条件将设置为 "True"，失败时，它将被设置为 "False" 以及描述失败原因的消息。 |
|
|
| DNSZoneCondition 只是标准条件字段。 |
|
|
| dnszone 是发布记录的区。 |
11.1.5. .status.zones[].conditions
- 描述
- 条件是与区域中记录关联的任何条件。如果发布记录成功，"Published" 条件将设置为 "True"，失败时，它将被设置为 "False" 以及描述失败原因的消息。
- 类型
-
array
11.1.6. .status.zones[].conditions[]
- 描述
- DNSZoneCondition 只是标准条件字段。
- 类型
-
object - 必填
-
status -
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
11.1.7. .status.zones[].dnsZone
- 描述
- dnszone 是发布记录的区。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
|
|
|
|
标签可用于查询 AWS 上的 DNS 托管区。在 AWS 上，可以使用 resourcegroupstaggingapi [1] 获取区域，使用 |
11.2. API 端点
可用的 API 端点如下：
/apis/ingress.operator.openshift.io/v1/dnsrecords-
GET: 列出类型为 DNSRecord 的对象
-
/apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords-
DELETE：删除 DNSRecord 集合 -
GET: 列出类型为 DNSRecord 的对象 -
POST：创建 DNSRecord
-
/apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}-
DELETE：删除 DNSRecord -
GET：读取指定的 DNSRecord -
PATCH: 部分更新指定的 DNSRecord -
PUT：替换指定的 DNSRecord
-
/apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}/status-
GET：指定 DNSRecord 的读取状态 -
PATCH: 部分更新指定 DNSRecord 的状态 -
PUT：替换指定 DNSRecord 的状态
-
11.2.1. /apis/ingress.operator.openshift.io/v1/dnsrecords
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出 DNSRecord 类型的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
11.2.2. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 DNSRecord 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 DNSRecord 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 DNSRecord
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
11.2.3. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| DNSRecord 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 DNSRecord
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 DNSRecord
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 DNSRecord
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 DNSRecord
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
11.2.4. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| DNSRecord 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 DNSRecord 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 DNSRecord 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 DNSRecord 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 12 章 Etcd [operator.openshift.io/v1]
- 描述
- etcd 提供配置 Operator 来管理 etcd 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
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 | |
|
|
| |
|
|
|
12.1.1. .spec
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| failedRevisionLimit 是要保留在磁盘上的失败静态 pod 安装程序修订的数量，在 api -1 = unlimited, 0 或 unset = 5 (default) |
|
|
| 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 (default) |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
12.1.2. .status
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| latestAvailableRevision 是最新部署的 deploymentID |
|
|
| latestAvailableRevisionReason 描述最新部署的详细原因 |
|
|
| nodeStatuses 跟踪单个节点上的部署值和错误 |
|
|
| NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
12.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
12.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
12.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
12.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
12.1.7. .status.nodeStatuses
- 描述
- nodeStatuses 跟踪单个节点上的部署值和错误
- 类型
-
array
12.1.8. .status.nodeStatuses[]
- 描述
- NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| currentRevision 是最近成功的部署的生成 |
|
|
| lastFailedCount 是最后一次失败修订版本的安装程序 pod 失败的频率。 |
|
|
| lastFailedReason 是一个机器可读的故障原因字符串。 |
|
|
| lastFailedRevision 是我们尝试和部署的部署生成。 |
|
|
| lastFailedRevisionErrors 是 lastFailedRevision 中引用的失败部署中人类可读的错误列表。 |
|
|
| lastFailedTime 是最后一次失败的修订版本最后一次失败的时间。 |
|
|
| lastFallbackCount 是回退到上一修订版本的频率。 |
|
|
| nodeName 是节点的名称 |
|
|
| targetRevision 是我们试图应用的部署生成 |
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 的状态
-
12.2.1. /apis/operator.openshift.io/v1/etcds
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 Etcd 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/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 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 Etcd
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
12.2.2. /apis/operator.openshift.io/v1/etcds/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Etcd 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 Etcd
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 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 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 Etcd
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
12.2.3. /apis/operator.openshift.io/v1/etcds/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| Etcd 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- 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 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 Etcd 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 13 章 ImageContentSourcePolicy [operator.openshift.io/v1alpha1]
- 描述
- ImageContentSourcePolicy 包含有关如何处理 registry 镜像规则的集群范围信息。定义了多个策略时，会在每个字段中定义行为的结果。兼容性级别 4：不提供兼容性，API 可能会因为任何原因而有所变化。这些功能不应由需要长期支持的应用程序使用。
- 类型
-
object - 必填
-
spec
-
13.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 | |
|
|
| spec 包含用于配置的用户可设置值 |
13.1.1. .spec
- 描述
- spec 包含用于配置的用户可设置值
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
repositoryDigestMirrors 允许从替代已镜像的存储库位置拉取 pod 中镜像摘要引用的镜像。为 pod 提供的镜像拉取规格将与 RepositoryDigestMirrors 中描述的源位置进行比较，镜像可以从列表中的任何镜像而不是指定存储库拉取，而不是指定存储库。只有具有镜像摘要的镜像拉取规格才会应用此行为 - 标签将继续从 pull spec 中的指定存储库拉取。每个"源"存储库都独立处理；不同"源"存储库的配置不交互。当为同一"源"存储库定义了多个策略时，定义的镜像集合将合并在一起，保留镜像的相对顺序（如果可能）。例如，如果策略 A 具有镜像 |
|
|
| repositoryDigestMirrors 包含有关如何在 registry 配置中处理 mirros 的集群范围信息。注： 只有拉取由其摘要引用的镜像时，镜像才可以正常工作。 |
13.1.2. .spec.repositoryDigestMirrors
- 描述
-
repositoryDigestMirrors 允许从替代已镜像的存储库位置拉取 pod 中镜像摘要引用的镜像。为 pod 提供的镜像拉取规格将与 RepositoryDigestMirrors 中描述的源位置进行比较，镜像可以从列表中的任何镜像而不是指定存储库拉取，而不是指定存储库。只有具有镜像摘要的镜像拉取规格才会应用此行为 - 标签将继续从 pull spec 中的指定存储库拉取。每个"源"存储库都独立处理；不同"源"存储库的配置不交互。当为同一"源"存储库定义了多个策略时，定义的镜像集合将合并在一起，保留镜像的相对顺序（如果可能）。例如，如果策略 A 具有镜像
a, b, c和 policy B 具有 mirrorc, d, e，则镜像将按a、b、c、d、e的顺序使用。如果镜像条目的顺序冲突（例如，b和 ）。b, a）配置不会被拒绝，但生成的顺序未指定。 - 类型
-
array
13.1.3. .spec.repositoryDigestMirrors[]
- 描述
- repositoryDigestMirrors 包含有关如何在 registry 配置中处理 mirros 的集群范围信息。注： 只有拉取由其摘要引用的镜像时，镜像才可以正常工作。
- 类型
-
object - 必填
-
source
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| mirror 是可能包含同一镜像的一个或多个存储库。此列表中的镜像顺序被视为用户所需的优先级，而源默认被视为比所有镜像的优先级较低。其他集群配置（包括但不限于）其他 repositoryDigestMirrors 对象可能会影响联系的确切顺序镜像，或者一些镜像可以并行联系，因此应该被视为首选项，而不是保证顺序的保证。 |
|
|
| Source 是用户引用的存储库，例如在镜像拉取规格中。 |
13.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies-
DELETE: delete collection of ImageContentSourcePolicy -
GET: 列出 ImageContentSourcePolicy 类型的对象 -
POST：创建 ImageContentSourcePolicy
-
/apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies/{name}-
DELETE: delete an ImageContentSourcePolicy -
GET：读取指定的 ImageContentSourcePolicy -
PATCH: 部分更新指定的 ImageContentSourcePolicy -
PUT：替换指定的 ImageContentSourcePolicy
-
/apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies/{name}/status-
GET：指定 ImageContentSourcePolicy 的读取状态 -
PATCH: 部分更新指定 ImageContentSourcePolicy 的状态 -
PUT：替换指定 ImageContentSourcePolicy 的状态
-
13.2.1. /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- delete collection of ImageContentSourcePolicy
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 ImageContentSourcePolicy 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 ImageContentSourcePolicy
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
13.2.2. /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ImageContentSourcePolicy 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ImageContentSourcePolicy
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 阅读指定的 ImageContentSourcePolicy
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 ImageContentSourcePolicy
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 ImageContentSourcePolicy
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
13.2.3. /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ImageContentSourcePolicy 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 ImageContentSourcePolicy 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 ImageContentSourcePolicy 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 ImageContentSourcePolicy 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 14 章 ImagePruner [imageregistry.operator.openshift.io/v1]
- 描述
- ImagePruner 是由 registry 操作器管理的镜像 registry 修剪器的配置对象。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
metadata -
spec
-
14.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 | |
|
|
| ImagePrunerSpec 定义运行的镜像修剪器的 specs。 |
|
|
| ImagePrunerStatus 报告镜像修剪器操作状态。 |
14.1.1. .spec
- 描述
- ImagePrunerSpec 定义运行的镜像修剪器的 specs。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| affinity 是一组用于镜像修剪器 pod 的节点关联性调度规则。 |
|
|
| failedJobsHistoryLimit 指定要保留的失败镜像修剪器作业数量。如果没有设置，则默认为 3。 |
|
|
| ignoreInvalidImageReferences 表示修剪器是否可以在解析镜像引用时忽略错误。 |
|
|
| keepTagRevisions 指定将保留的镜像流中的标签镜像修订版本数量。默认值为 3。 |
|
|
| keepYoungerThan 指定镜像的最小年龄（纳秒），并将其引用者被视为修剪候选者。DEPRECATED ：此字段已弃用，而使用 keepYoungerThanDuration。如果设置了这两个字段，则忽略此字段，并且 keepYoungerThanDuration 优先使用。 |
|
|
| keepYoungerThanDuration 指定镜像的最短年龄，并将其引用者被视为修剪候选者。默认值为 60m (60 分钟)。 |
|
|
| Loglevel 设置修剪器作业的日志输出级别。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| nodeSelector 为镜像修剪器 pod 定义节点选择限制。 |
|
|
| 资源定义镜像修剪器 Pod 的资源请求和限值。 |
|
|
|
schedule 指定何时使用标准 cronjob 语法执行作业： https://wikipedia.org/wiki/Cron。默认为 |
|
|
| successfulJobsHistoryLimit 指定要保留的成功镜像修剪器作业数量。如果没有设置，则默认为 3。 |
|
|
| suspend 指定是否挂起此 cronjob 的后续执行。默认为false。 |
|
|
| 容限(toleration)定义了镜像修剪器 pod 的节点容限。 |
|
|
| 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。 |
14.1.2. .spec.affinity
- 描述
- affinity 是一组用于镜像修剪器 pod 的节点关联性调度规则。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 描述 pod 的节点关联性调度规则。 |
|
|
| 描述 pod 关联性调度规则（例如，将这个 pod 位于同一个节点、区等）中。 |
|
|
| 描述 pod 反关联性调度规则（例如，避免将此 pod 放置到同一个节点、区等）。 |
14.1.3. .spec.affinity.nodeAffinity
- 描述
- 描述 pod 的节点关联性调度规则。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 调度程序更喜欢将 pod 调度到满足此字段指定的关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、必需关联表达式等）的每个节点，计算出一个总和总和总和总和（如果节点与相应的 matchExpressions 匹配），则计算总和最高的节点是最首选的。 |
|
|
| 空白的首选调度术语与带有隐式权重 0 （例如，它的一个 no-op）的所有对象匹配。空首选调度术语不匹配任何对象（例如，也是 no-op）。 |
|
|
| 如果在调度时没有满足此字段指定的关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的关联性要求在 pod 执行期间某一点满足（例如，由于更新），则系统可能或可能无法最终从其节点驱除 pod。 |
14.1.4. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 描述
- 调度程序更喜欢将 pod 调度到满足此字段指定的关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、必需关联表达式等）的每个节点，计算出一个总和总和总和总和（如果节点与相应的 matchExpressions 匹配），则计算总和最高的节点是最首选的。
- 类型
-
array
14.1.5. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 空白的首选调度术语与带有隐式权重 0 （例如，它的一个 no-op）的所有对象匹配。空首选调度术语不匹配任何对象（例如，也是 no-op）。
- 类型
-
object - 必填
-
preference -
weight
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 与对应权重关联的节点选择器术语。 |
|
|
| 与对应 nodeSelectorTerm 关联的权重，范围为 1-100。 |
14.1.6. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference
- 描述
- 与对应权重关联的节点选择器术语。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 按节点标签划分的节点选择器要求列表。 |
|
|
| 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| 按节点字段划分的节点选择器要求列表。 |
|
|
| 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
14.1.7. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions
- 描述
- 按节点标签划分的节点选择器要求列表。
- 类型
-
array
14.1.8. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]
- 描述
- 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt. |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果运算符是 Gt 或 Lt，则值数组必须具有单个元素，它将解释为整数。这个数组会在策略性合并补丁中被替换。 |
14.1.9. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields
- 描述
- 按节点字段划分的节点选择器要求列表。
- 类型
-
array
14.1.10. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]
- 描述
- 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt. |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果运算符是 Gt 或 Lt，则值数组必须具有单个元素，它将解释为整数。这个数组会在策略性合并补丁中被替换。 |
14.1.11. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 描述
- 如果在调度时没有满足此字段指定的关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的关联性要求在 pod 执行期间某一点满足（例如，由于更新），则系统可能或可能无法最终从其节点驱除 pod。
- 类型
-
object - 必填
-
nodeSelectorTerms
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 必需。节点选择器术语列表。术语为 ORed。 |
|
|
| null 或空节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。 |
14.1.12. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
- 描述
- 必需。节点选择器术语列表。术语为 ORed。
- 类型
-
array
14.1.13. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]
- 描述
- null 或空节点选择器术语不匹配任何对象。它们的要求是 AND。TopologySelectorTerm 类型实现 NodeSelectorTerm 的子集。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 按节点标签划分的节点选择器要求列表。 |
|
|
| 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| 按节点字段划分的节点选择器要求列表。 |
|
|
| 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
14.1.14. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions
- 描述
- 按节点标签划分的节点选择器要求列表。
- 类型
-
array
14.1.15. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]
- 描述
- 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt. |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果运算符是 Gt 或 Lt，则值数组必须具有单个元素，它将解释为整数。这个数组会在策略性合并补丁中被替换。 |
14.1.16. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields
- 描述
- 按节点字段划分的节点选择器要求列表。
- 类型
-
array
14.1.17. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]
- 描述
- 节点选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 选择器应用到的标签键。 |
|
|
| 代表键与一组值的关系。有效的运算符为 In、NotIn、Exists、DoesNotExist。gt 和 Lt. |
|
|
| 字符串值数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。如果运算符是 Gt 或 Lt，则值数组必须具有单个元素，它将解释为整数。这个数组会在策略性合并补丁中被替换。 |
14.1.18. .spec.affinity.podAffinity
- 描述
- 描述 pod 关联性调度规则（例如，将这个 pod 位于同一个节点、区等）中。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 调度程序更喜欢将 pod 调度到满足此字段指定的关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选的节点是具有最大权重总和的节点（即，对于满足所有调度要求的节点(resource request、requiredDuringScheduling 关联性表达式等)的每个节点，计算并迭代此字段元素，并在节点具有与对应 podAffinityTerm 匹配的 pod 时，将"weight"添加到总和（如果节点具有最高 podAffinityTerm）、具有最高总和最高的节点是首选。 |
|
|
| 所有匹配的 WeightedPodAffinityTerm 字段的权重添加到每个节点，以查找最首选节点。 |
|
|
| 如果在调度时没有满足此字段指定的关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的关联性要求在 pod 执行期间某一点满足（例如，由于 pod 标签更新），则系统可能或可能无法最终从其节点驱除 pod。当有多个元素时，与每个 podAffinityTerm 对应的节点列表都会被交集，例如必须满足所有术语。 |
|
|
| 定义一组 pod （即，与给定命名空间相对 labelSelector 匹配的 labelSelector ），该 pod 应该与 pod 共同定位（反关联性）或没有共同定位（反关联性）的节点上运行，其中 co-located 在具有键 <topologyKey> 标签的节点上运行，它与其上运行一组 pod 的 pod 匹配。 |
14.1.19. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 描述
- 调度程序更喜欢将 pod 调度到满足此字段指定的关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选的节点是具有最大权重总和的节点（即，对于满足所有调度要求的节点(resource request、requiredDuringScheduling 关联性表达式等)的每个节点，计算并迭代此字段元素，并在节点具有与对应 podAffinityTerm 匹配的 pod 时，将"weight"添加到总和（如果节点具有最高 podAffinityTerm）、具有最高总和最高的节点是首选。
- 类型
-
array
14.1.20. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 所有匹配的 WeightedPodAffinityTerm 字段的权重添加到每个节点，以查找最首选节点。
- 类型
-
object - 必填
-
podAffinityTerm -
weight
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 必需。与对应权重关联的 pod 关联性术语。 |
|
|
| 与对应的 podAffinityTerm 关联的权重，范围为 1-100。 |
14.1.21. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
- 描述
- 必需。与对应权重关联的 pod 关联性术语。
- 类型
-
object - 必填
-
topologyKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 对一组资源进行标签查询，本例中为 pod。 |
|
|
| 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。 |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用到此字段中列出的命名空间的 union，namespaceSelector 选择的命名空间列表和 null namespaceSelector 表示 " this pod 的命名空间"。 |
|
|
| 此 pod 应该在指定命名空间中与 labelSelector 匹配的 pod 共存（反关联性），其中 co-located 定义为在运行所选 pod 的节点的值为 running 的节点上运行。不允许为空 topologyKey。 |
14.1.22. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
- 描述
- 对一组资源进行标签查询，本例中为 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
14.1.23. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
14.1.24. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
14.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- 描述
- 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
14.1.26. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
14.1.27. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
14.1.28. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 描述
- 如果在调度时没有满足此字段指定的关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的关联性要求在 pod 执行期间某一点满足（例如，由于 pod 标签更新），则系统可能或可能无法最终从其节点驱除 pod。当有多个元素时，与每个 podAffinityTerm 对应的节点列表都会被交集，例如必须满足所有术语。
- 类型
-
array
14.1.29. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 定义一组 pod （即，与给定命名空间相对 labelSelector 匹配的 labelSelector ），该 pod 应该与 pod 共同定位（反关联性）或没有共同定位（反关联性）的节点上运行，其中 co-located 在具有键 <topologyKey> 标签的节点上运行，它与其上运行一组 pod 的 pod 匹配。
- 类型
-
object - 必填
-
topologyKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 对一组资源进行标签查询，本例中为 pod。 |
|
|
| 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。 |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用到此字段中列出的命名空间的 union，namespaceSelector 选择的命名空间列表和 null namespaceSelector 表示 " this pod 的命名空间"。 |
|
|
| 此 pod 应该在指定命名空间中与 labelSelector 匹配的 pod 共存（反关联性），其中 co-located 定义为在运行所选 pod 的节点的值为 running 的节点上运行。不允许为空 topologyKey。 |
14.1.30. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
- 描述
- 对一组资源进行标签查询，本例中为 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
14.1.31. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
14.1.32. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
14.1.33. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- 描述
- 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
14.1.34. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
14.1.35. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
14.1.36. .spec.affinity.podAntiAffinity
- 描述
- 描述 pod 反关联性调度规则（例如，避免将此 pod 放置到同一个节点、区等）。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 调度程序更喜欢将 pod 调度到满足此字段指定的反关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选的节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、requiredDuringScheduling 反关联性表达式等）的每个节点，计算通过此字段元素来计算总和总和（如果节点具有与对应的 podAffinityTerm 匹配的 pod）的总和。 |
|
|
| 所有匹配的 WeightedPodAffinityTerm 字段的权重添加到每个节点，以查找最首选节点。 |
|
|
| 如果在调度时没有满足此字段指定的反关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的反关联性要求在 Pod 执行期间某一点满足（例如，由于 pod 标签更新），则系统可能或可能无法最终从其节点驱除 pod。当有多个元素时，与每个 podAffinityTerm 对应的节点列表都会被交集，例如必须满足所有术语。 |
|
|
| 定义一组 pod （即，与给定命名空间相对 labelSelector 匹配的 labelSelector ），该 pod 应该与 pod 共同定位（反关联性）或没有共同定位（反关联性）的节点上运行，其中 co-located 在具有键 <topologyKey> 标签的节点上运行，它与其上运行一组 pod 的 pod 匹配。 |
14.1.37. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 描述
- 调度程序更喜欢将 pod 调度到满足此字段指定的反关联性表达式的节点，但可能会选择违反一个或多个表达式的节点。最首选的节点是具有最大权重总和的节点，即对于满足所有调度要求（资源请求、requiredDuringScheduling 反关联性表达式等）的每个节点，计算通过此字段元素来计算总和总和（如果节点具有与对应的 podAffinityTerm 匹配的 pod）的总和。
- 类型
-
array
14.1.38. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 所有匹配的 WeightedPodAffinityTerm 字段的权重添加到每个节点，以查找最首选节点。
- 类型
-
object - 必填
-
podAffinityTerm -
weight
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 必需。与对应权重关联的 pod 关联性术语。 |
|
|
| 与对应的 podAffinityTerm 关联的权重，范围为 1-100。 |
14.1.39. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
- 描述
- 必需。与对应权重关联的 pod 关联性术语。
- 类型
-
object - 必填
-
topologyKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 对一组资源进行标签查询，本例中为 pod。 |
|
|
| 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。 |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用到此字段中列出的命名空间的 union，namespaceSelector 选择的命名空间列表和 null namespaceSelector 表示 " this pod 的命名空间"。 |
|
|
| 此 pod 应该在指定命名空间中与 labelSelector 匹配的 pod 共存（反关联性），其中 co-located 定义为在运行所选 pod 的节点的值为 running 的节点上运行。不允许为空 topologyKey。 |
14.1.40. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
- 描述
- 对一组资源进行标签查询，本例中为 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
14.1.41. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
14.1.42. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
14.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- 描述
- 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
14.1.44. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
14.1.45. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
14.1.46. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 描述
- 如果在调度时没有满足此字段指定的反关联性要求，则 pod 不会被调度到该节点上。如果此字段指定的反关联性要求在 Pod 执行期间某一点满足（例如，由于 pod 标签更新），则系统可能或可能无法最终从其节点驱除 pod。当有多个元素时，与每个 podAffinityTerm 对应的节点列表都会被交集，例如必须满足所有术语。
- 类型
-
array
14.1.47. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- 描述
- 定义一组 pod （即，与给定命名空间相对 labelSelector 匹配的 labelSelector ），该 pod 应该与 pod 共同定位（反关联性）或没有共同定位（反关联性）的节点上运行，其中 co-located 在具有键 <topologyKey> 标签的节点上运行，它与其上运行一组 pod 的 pod 匹配。
- 类型
-
object - 必填
-
topologyKey
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 对一组资源进行标签查询，本例中为 pod。 |
|
|
| 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。 |
|
|
| namespaces 指定术语应用到的命名空间名称的静态列表。术语应用到此字段中列出的命名空间的 union，namespaceSelector 选择的命名空间列表和 null namespaceSelector 表示 " this pod 的命名空间"。 |
|
|
| 此 pod 应该在指定命名空间中与 labelSelector 匹配的 pod 共存（反关联性），其中 co-located 定义为在运行所选 pod 的节点的值为 running 的节点上运行。不允许为空 topologyKey。 |
14.1.48. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
- 描述
- 对一组资源进行标签查询，本例中为 pod。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
14.1.49. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
14.1.50. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
14.1.51. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- 描述
- 术语适用的命名空间集合上的标签查询。术语应用于此字段选定的命名空间的 union，以及 namespaces 字段中列出的命名空间。null selector 和 null 或空命名空间列表表示"此 pod 的命名空间"。空选择器({})匹配所有命名空间。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
14.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
14.1.53. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
14.1.54. .spec.resources
- 描述
- 资源定义镜像修剪器 Pod 的资源请求和限值。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门。此字段不可变。 |
|
|
| ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。 |
|
|
| 限制描述了允许的最大计算资源量。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| Requests 描述了所需的最少计算资源。如果容器省略了 Requests，则默认为 Limits （如果明确指定），否则默认为实现定义的值。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
14.1.55. .spec.resources.claims
- 描述
- claim 列出此容器使用的 spec.resourceClaims 中定义的资源名称。这是一个 alpha 字段，需要启用 DynamicResourceAllocation 功能门。此字段不可变。
- 类型
-
array
14.1.56. .spec.resources.claims[]
- 描述
- ResourceClaim 引用 PodSpec.ResourceClaims 中的一个条目。
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 必须与使用此字段的 Pod 的 pod.spec.resourceClaims 中的一个条目的名称匹配。它允许容器内部使用该资源。 |
14.1.57. .spec.tolerations
- 描述
- 容限(toleration)定义了镜像修剪器 pod 的节点容限。
- 类型
-
array
14.1.58. .spec.tolerations[]
- 描述
- 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| effect 表示要匹配的污点效果。空意味着匹配所有污点效果。指定后，允许的值为 NoSchedule，PreferNoSchedule 和 NoExecute。 |
|
|
| key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空，则必须存在运算符；组合意味着匹配所有值和所有键。 |
|
|
| Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认值为 Equal。exists 等同于值的通配符，以便 pod 可以容忍特定类别的所有污点。 |
|
|
| tolerationSeconds 代表容限的期间（必须生效 NoExecute，否则此字段将被忽略）可以容忍污点。默认情况下，它不会被设置，这意味着容许任何污点（不要驱除）。零值和负值将被视为 0 （立即删除）。 |
|
|
| value 是容限匹配的污点值。如果运算符是 Exists，则该值应该为空，否则仅是一个常规字符串。 |
14.1.59. .status
- 描述
- ImagePrunerStatus 报告镜像修剪器操作状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态的列表。 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| observedGeneration 是应用的最后生成更改。 |
14.1.60. .status.conditions
- 描述
- conditions 是条件及其状态的列表。
- 类型
-
array
14.1.61. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
14.2. API 端点
可用的 API 端点如下：
/apis/imageregistry.operator.openshift.io/v1/imagepruners-
DELETE：删除 ImagePruner 集合 -
GET: 列出类型为 ImagePruner 的对象 -
POST：创建 ImagePruner
-
/apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}-
DELETE：删除 ImagePruner -
GET：读取指定的 ImagePruner -
PATCH: 部分更新指定的 ImagePruner -
PUT：替换指定的 ImagePruner
-
/apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}/status-
GET：指定 ImagePruner 的读取状态 -
PATCH: 部分更新指定 ImagePruner 的状态 -
PUT：替换指定 ImagePruner 的状态
-
14.2.1. /apis/imageregistry.operator.openshift.io/v1/imagepruners
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ImagePruner 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 ImagePruner 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 ImagePruner
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
14.2.2. /apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ImagePruner 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ImagePruner
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 ImagePruner
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 ImagePruner
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 ImagePruner
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
14.2.3. /apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ImagePruner 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 ImagePruner 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 ImagePruner 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 ImagePruner 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 15 章 IngressController [operator.openshift.io/v1]
- 描述
- IngressController 描述了集群的受管入口控制器。控制器可以服务 OpenShift Route 和 Kubernetes Ingress 资源。创建 IngressController 时，会创建一个新的入口控制器部署，以允许外部流量访问公开 Ingress 或 Route 资源的服务。更新此资源可能会导致出现面向公共的网络连接中断，因为可能会推出新的入口控制器修订版本。https://kubernetes.io/docs/concepts/services-networking/ingress-controllers 尽可能减少平台的默认值。如需了解更多详细信息，请参阅每个字段。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
15.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 | |
|
|
| spec 是 IngressController 所需的行为的规格。 |
|
|
| Status 是 IngressController 最近观察到的状态。 |
15.1.1. .spec
- 描述
- spec 是 IngressController 所需的行为的规格。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| clientTLS 指定用于请求和验证客户端证书的设置，可用于为 edge-terminated 和 reencrypt 路由启用 mutual TLS。 |
|
|
| defaultCertificate 是对包含入口控制器提供的默认证书的 secret 的引用。当 Routes 没有指定其自身证书时，会使用 defaultCertificate。secret 必须包含以下密钥和数据：tls.crt: 证书文件内容 tls.key: 密钥文件内容（如果未设置），则会自动生成并使用通配符证书。该证书对入口控制器域（和子域）有效，所生成的证书的 CA 将自动与集群的信任存储集成。如果使用通配符证书并由多个 HTTP/2 启用的路由（即 ALPN）使用和共享，那么客户端（例如，特别是浏览器）可随时重复使用开放连接。这意味着客户端可以重复使用到另一个路由的连接，并可能失败。这个行为通常被称为连接合并。正在使用的证书（无论是生成的还是用户指定的）将自动与 OpenShift 的内置 OAuth 服务器集成。 |
|
|
| domain 是入口控制器服务的 DNS 名称，用于配置多个功能：* 对于 LoadBalancerService 端点发布策略，domain 用于配置 DNS 记录。请参阅 endpointPublishingStrategy。* 在使用生成的默认证书时，该证书对域及其子域有效。请参阅 defaultCertificate。* 该值会发布到单独的 Route 状态，以便最终用户知道目标外部 DNS 记录的位置。域在所有 IngressController 中必须是唯一的，且无法更新。如果为空，则默认为 ingress.config.openshift.io/cluster .spec.domain。 |
|
|
| endpointPublishingStrategy 用于向其他网络发布入口控制器端点，启用负载均衡器集成等。如果未设置，则默认值基于 infrastructure.config.openshift.io/cluster .status.platform: AWS: LoadBalancerService (with External scope) Azure: LoadBalancerService (with External scope) GCP: LoadBalancerService (with External scope) IBMCloud: LoadBalancerService (with External scope) LoadBalancerService (with External scope) Libvirt: HostNetwork Any other platform type （包括 None）default to HostNetwork endpointPublishingStrategy. |
|
|
| httpCompression 定义 HTTP 流量压缩的策略。默认情况下，没有 HTTP 压缩。 |
|
|
| HTTPEmptyRequestsPolicy 描述了在收到请求前超时时应如何处理 HTTP 连接。此字段允许的值是 "Respond" 和 "Ignore"。如果字段设置为 "Respond"，入口控制器发送 HTTP 400 或 408 响应，日志连接（如果启用了访问日志），并在适当的指标中统计连接。如果字段设置为 "Ignore"，则入口控制器在不发送响应的情况下关闭连接，记录连接或递增指标。默认值为 "Respond"。通常，这些连接来自负载均衡器的健康状况探测或 Web 浏览器的规范连接("preconnect")，可以安全地忽略。但是，这些请求也可能是由网络错误导致的，因此将此字段设置为 "Ignore" 可能会阻止问题的检测和诊断。此外，这些请求可能是由端口扫描导致的，在这种情况下，记录空请求有助于检测入侵尝试。 |
|
|
| httpErrorCodePages 指定带有自定义错误页面的 configmap。管理员必须在 openshift-config 命名空间中创建此 configmap。此 configmap 的格式应为 "error-page-<error code>.http"，其中 <error code> 是一个 HTTP 错误代码。例如，"error-page-503.http" 定义了 HTTP 503 响应的错误页面。目前只能自定义 503 和 404 响应的错误页面。configmap 中的每个值都应该是完整的响应，包括 HTTP 标头。eg- https://raw.githubusercontent.com/openshift/router/fadab45747a9b30cc3f0a4b41ad2871f95827a93/images/router/haproxy/conf/error-page-503.http 如果此字段为空，ingress 控制器将使用默认错误页面。 |
|
|
| httpHeaders 为 HTTP 标头定义策略。如果此字段为空，则使用默认值。 |
|
|
| logging 为应记录的内容定义参数。如果此字段为空，则会启用运行日志，但禁用访问日志。 |
|
|
| namespaceSelector 用于过滤由 ingress 控制器提供服务的一组命名空间。这对实现分片（shard）非常有用。如果未设置，则默认为没有过滤。 |
|
|
| nodePlacement 启用对入口控制器调度的显式控制。如果未设置，则使用默认值。如需了解更多详细信息，请参阅 NodePlacement。 |
|
|
| replicas 是所需的入口控制器副本数量。如果未设置，则默认值取决于集群 config.openshift.io/v1/ingresses 状态中的 defaultPlacement 字段的值。replicas 的值根据 Infrastructure CR 中所选字段的值设置。如果将 defaultPlacement 设置为 ControlPlane，则所选字段将是 controlPlaneTopology。如果设置为 Workers，则所选字段将为 infrastructureTopology。然后，根据所选字段的值分别是 SingleReplica 或 HighlyAvailable，将 replicas 设置为 1 或 2。这些默认值可能会改变。 |
|
|
| routeAdmission 定义了处理新路由声明的策略（例如，允许或拒绝命名空间之间的声明）。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 routeAdmission 字段。 |
|
|
| routeSelector 用于过滤由入口控制器提供服务的一组 Routes。这对实现分片（shard）非常有用。如果未设置，则默认为没有过滤。 |
|
|
| tlsSecurityProfile 指定 ingresscontrollers 的 TLS 连接的设置。如果未设置，则默认值基于 apiservers.config.openshift.io/cluster 资源。请注意，在使用 Old、Intermediate 和 Modern 配置集类型时，有效的配置集配置可能会在发行版本间有所变化。例如，使用在版本 X.Y.Z 中部署的 Intermediate 配置集，升级到版本 X.Y.Z+1 可能会导致新的配置集应用到 ingress 控制器，从而导致一个 rollout 操作。 |
|
|
| tuningOptions 定义用于调整入口控制器 pod 性能的参数。所有字段都是可选的，如果未设置，则使用它们对应的默认值。如需了解更多详细信息，请参阅特定的 tuningOptions 字段。通常不建议在 tuningOptions 中设置字段。默认值适用于大多数配置。 |
|
| `` | unsupportedConfigOverrides 允许指定不支持的配置选项。其使用不受支持。 |
15.1.2. .spec.clientTLS
- 描述
- clientTLS 指定用于请求和验证客户端证书的设置，可用于为 edge-terminated 和 reencrypt 路由启用 mutual TLS。
- 类型
-
object - 必填
-
clientCA -
clientCertificatePolicy
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| AllowedSubjectPatterns 指定正则表达式列表，该表达式应与有效客户端证书上的可分辨名称匹配，以过滤请求。正则表达式必须使用 PCRE 语法。如果此列表为空，则不会执行任何过滤。如果列表不是空的，则至少一个模式必须与客户端证书的可分辨名称匹配，否则入口控制器拒绝证书并拒绝连接。 |
|
|
| clientCA 指定包含 PEM 编码 CA 证书捆绑包的 configmap，该捆绑包应用于验证客户端的证书。管理员必须在 openshift-config 命名空间中创建此 configmap。 |
|
|
| clientCertificatePolicy 指定入口控制器是否需要客户端提供证书。此字段接受值 "Required" 或 "Optional"。请注意，入口控制器只检查边缘终止和重新加密 TLS 路由的客户端证书；它无法检查明文 HTTP 或 passthrough TLS 路由的证书。 |
15.1.3. .spec.clientTLS.clientCA
- 描述
- clientCA 指定包含 PEM 编码 CA 证书捆绑包的 configmap，该捆绑包应用于验证客户端的证书。管理员必须在 openshift-config 命名空间中创建此 configmap。
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是引用的配置映射的 metadata.name |
15.1.4. .spec.defaultCertificate
- 描述
- defaultCertificate 是对包含入口控制器提供的默认证书的 secret 的引用。当 Routes 没有指定其自身证书时，会使用 defaultCertificate。secret 必须包含以下密钥和数据：tls.crt: 证书文件内容 tls.key: 密钥文件内容（如果未设置），则会自动生成并使用通配符证书。该证书对入口控制器域（和子域）有效，所生成的证书的 CA 将自动与集群的信任存储集成。如果使用通配符证书并由多个 HTTP/2 启用的路由（即 ALPN）使用和共享，那么客户端（例如，特别是浏览器）可随时重复使用开放连接。这意味着客户端可以重复使用到另一个路由的连接，并可能失败。这个行为通常被称为连接合并。正在使用的证书（无论是生成的还是用户指定的）将自动与 OpenShift 的内置 OAuth 服务器集成。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？ |
15.1.5. .spec.endpointPublishingStrategy
- 描述
- endpointPublishingStrategy 用于向其他网络发布入口控制器端点，启用负载均衡器集成等。如果未设置，则默认值基于 infrastructure.config.openshift.io/cluster .status.platform: AWS: LoadBalancerService (with External scope) Azure: LoadBalancerService (with External scope) GCP: LoadBalancerService (with External scope) IBMCloud: LoadBalancerService (with External scope) LoadBalancerService (with External scope) Libvirt: HostNetwork Any other platform type （包括 None）default to HostNetwork endpointPublishingStrategy.
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| HostNetwork 包含 HostNetwork 端点发布策略的参数。仅在 type 为 HostNetwork 时才出现。 |
|
|
| LoadBalancer 包含负载均衡器的参数。仅在类型为 LoadBalancerService 时才出现。 |
|
|
| NodePort 包含 NodePortService 端点发布策略的参数。仅在 type 是 NodePortService 时才出现。 |
|
|
| private 包含 Private 端点发布策略的参数。仅在类型为 Private 时才出现。 |
|
|
| type 是要使用的发布策略。有效值为：* LoadBalancerService 使用 Kubernetes LoadBalancer Service 发布入口控制器。在这个配置中，入口控制器部署使用容器网络。创建了一个 LoadBalancer 服务来发布部署。请参阅 ：https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer 如果设置了域，将管理通配符 DNS 记录以指向 LoadBalancer 服务的外部名称。DNS 记录只在 dns.config.openshift.io/cluster .spec.publicZone 和 .spec.privateZone 定义的 DNS 区域中管理。目前仅在 AWS、Azure 和 GCP 平台上支持通配符 DNS 管理。* HostNetwork 在部署了入口控制器的节点端口上发布入口控制器。在这个配置中，入口控制器部署使用主机网络，并绑定到节点端口 80 和 443。用户负责配置外部负载均衡器，以通过节点端口发布入口控制器。* private Does 没有发布入口控制器。在这个配置中，入口控制器部署使用容器网络，且不会被显式发布。用户必须手动发布入口控制器。* NodePortService 使用 Kubernetes NodePort Service 发布入口控制器。在这个配置中，入口控制器部署使用容器网络。创建了一个 NodePort 服务来发布部署。特定的节点端口由 OpenShift 动态分配，但为了支持静态端口分配，用户会保留对受管 NodePort Service 的节点端口字段的更改。 |
15.1.6. .spec.endpointPublishingStrategy.hostNetwork
- 描述
- HostNetwork 包含 HostNetwork 端点发布策略的参数。仅在 type 为 HostNetwork 时才出现。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| httpPort 是主机上的端口，应该用于侦听 HTTP 请求。当端口 80 已在使用时，应设置此字段。该值不应与集群的 NodePort 范围冲突。如果值为 0 或未指定值，则默认为 80。 |
|
|
| httpsPort 是主机上的端口，应该用于侦听 HTTPS 请求。当端口 443 已在使用时，应设置此字段。该值不应与集群的 NodePort 范围冲突。如果值为 0 或未指定值，则默认为 443。 |
|
|
| protocol 指定 IngressController 是否需要传入连接使用普通 TCP，还是 IngressController 是否需要 PROXY 协议。PROXY 协议可以和支持它的负载均衡器一起使用，以便在将这些连接转发到 IngressController 时通信客户端连接的源地址。使用 PROXY 协议可让 IngressController 报告这些源地址，而不是在 HTTP 标头和日志中报告负载均衡器的地址。请注意，如果您不使用使用 PROXY 协议的负载均衡器将连接转发到 IngressController，则 IngressController 上启用 PROXY 协议会导致连接失败。有关 PROXY 协议的信息，请参阅 http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt。以下值对于此字段有效：* 空字符串。* "TCP".* "PROXY"。空字符串指定默认字符串，即没有 PROXY 协议的 TCP。请注意，默认值可能会改变。 |
|
|
| statsPort 是发布路由器统计的主机上的端口。该值不应与集群的 NodePort 范围冲突。如果外部负载均衡器配置为将连接转发到此 IngressController，负载均衡器应该使用此端口进行健康检查。负载均衡器可以在给定节点上的这个端口上发送 HTTP 探测，路径为 /healthz/ready，以确定入口控制器是否准备好接收节点上的流量。对于正常操作，负载均衡器必须在健康检查报告就绪前，不会将流量转发到节点。负载均衡器还应该在 /healthz/ready 开始报告未就绪后最多停止对 45 秒的转发请求。每 5 秒探测到 10 秒(5 秒超时)，并且两个成功或失败请求的阈值分别变为健康或不健康。当值为 0 或未指定值时，默认为 1936。 |
15.1.7. .spec.endpointPublishingStrategy.loadBalancer
- 描述
- LoadBalancer 包含负载均衡器的参数。仅在类型为 LoadBalancerService 时才出现。
- 类型
-
object - 必填
-
dnsManagementPolicy -
scope
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| `` | AllowedSourceRanges 指定 IP 地址范围允许列表，应该限制访问负载均衡器的访问。必须使用 CIDR 表示法（例如，）指定每个范围。"10.0.0.0/8" 或 "fd00::/8"）。如果没有指定范围，则默认使用 IPv4 的"0.0.0.0/0"和 IPv6 的"::/0"，这将允许所有源地址。为了便于从没有 allowedSourceRanges 字段的 OpenShift 版本的迁移，您可以在 "openshift-ingress" 命名空间中的 "router-<ingresscontroller name>" 服务上设置 service.beta.kubernetes.io/load-balancer-source-ranges 注解。 |
|
|
| dnsManagementPolicy 表示与负载均衡器服务关联的通配符 DNS 记录的生命周期是否由 ingress operator 管理。默认为 Managed。有效值为：Managed 和 Unmanaged。 |
|
|
| providerParameters 包含特定于底层基础架构供应商的所需的负载均衡器信息。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 providerParameters 字段。 |
|
|
| scope 表示公开负载均衡器的范围。可能的值有 "External" 和 "Internal"。 |
15.1.8. .spec.endpointPublishingStrategy.loadBalancer.providerParameters
- 描述
- providerParameters 包含特定于底层基础架构供应商的所需的负载均衡器信息。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 providerParameters 字段。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| AWS 提供特定于 AWS 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 aws 字段。 |
|
|
| GCP 提供特定于 GCP 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 gcp 字段。 |
|
|
| IBM 提供特定于 IBM Cloud 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 ibm 字段。 |
|
|
| type 是负载均衡器的底层基础架构供应商。允许的值是 "AWS", "Azure", "BareMetal", "GCP", "IBM", "Nutanix", "OpenStack", 和 "VSphere"。 |
15.1.9. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws
- 描述
- AWS 提供特定于 AWS 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 aws 字段。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| classicLoadBalancerParameters 包含 AWS 经典负载均衡器的配置参数。仅在 type 为 Classic 时才出现。 |
|
|
| networkLoadBalancerParameters 包含 AWS 网络负载均衡器的配置参数。仅在类型为 NLB 时才存在。 |
|
|
| type 是为 ingresscontroller 实例化的 AWS 负载均衡器的类型。有效值为：* "Classic": 一个 Classic Load Balancer，它在传输层(TCP/SSL)或应用程序层(HTTP/HTTPS)上做出路由决策。详情请查看以下内容： https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb * "NLB": A Network Load Balancer，它在传输层(TCP/SSL)中做出路由决策。详情请查看以下内容： https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb |
15.1.10. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.classicLoadBalancer
- 描述
- classicLoadBalancerParameters 包含 AWS 经典负载均衡器的配置参数。仅在 type 为 Classic 时才出现。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| connectionIdleTimeout 指定在负载均衡器关闭连接前可以闲置的最大时间段。该值必须解析为持续时间值；请参阅 https://pkg.go.dev/time#ParseDuration。nil 或零值表示没有建议，在这种情况下，会使用默认值。此字段的默认值为 60s。这个默认设置可能会改变。 |
15.1.11. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.networkLoadBalancer
- 描述
- networkLoadBalancerParameters 包含 AWS 网络负载均衡器的配置参数。仅在类型为 NLB 时才存在。
- 类型
-
对象
15.1.12. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.gcp
- 描述
- GCP 提供特定于 GCP 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 gcp 字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| clientAccess 描述了如何对内部负载均衡器限制客户端访问。有效值为：* "Global": 指定带有全局客户端访问的内部负载均衡器，允许 VPC 中的任何区域与负载均衡器通信。https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#global_access "local": 指定带有本地客户端访问的内部负载均衡器，这意味着只有同一区域（和 VPC）中的客户端才可以与负载均衡器通信。请注意，这是默认行为。https://cloud.google.com/load-balancing/docs/internal#client_access |
15.1.13. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.ibm
- 描述
- IBM 提供特定于 IBM Cloud 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 ibm 字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| protocol 指定负载均衡器是否使用 PROXY 协议将连接转发到 IngressController。请参阅 "service.kubernetes.io/ibm-load-balancer-cloud-provider-enable-features: "proxy-protocol"" （位于 https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas PROXY 协议）可用于支持它在将客户端连接的源地址转发到 IngressController 时进行通信客户端连接的源地址。使用 PROXY 协议可让 IngressController 报告这些源地址，而不是在 HTTP 标头和日志中报告负载均衡器的地址。请注意，如果您不使用使用 PROXY 协议的负载均衡器将连接转发到 IngressController，则 IngressController 上启用 PROXY 协议会导致连接失败。有关 PROXY 协议的信息，请参阅 http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt。协议的有效值为 TCP、PROXY 和 omitted。省略时，这意味着没有建议，平台会被保留选择合理的默认值，这可能会随时间变化。当前的默认值是 TCP，不启用代理协议。 |
15.1.14. .spec.endpointPublishingStrategy.nodePort
- 描述
- NodePort 包含 NodePortService 端点发布策略的参数。仅在 type 是 NodePortService 时才出现。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| protocol 指定 IngressController 是否需要传入连接使用普通 TCP，还是 IngressController 是否需要 PROXY 协议。PROXY 协议可以和支持它的负载均衡器一起使用，以便在将这些连接转发到 IngressController 时通信客户端连接的源地址。使用 PROXY 协议可让 IngressController 报告这些源地址，而不是在 HTTP 标头和日志中报告负载均衡器的地址。请注意，如果您不使用使用 PROXY 协议的负载均衡器将连接转发到 IngressController，则 IngressController 上启用 PROXY 协议会导致连接失败。有关 PROXY 协议的信息，请参阅 http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt。以下值对于此字段有效：* 空字符串。* "TCP".* "PROXY".空字符串指定默认字符串，即没有 PROXY 协议的 TCP。请注意，默认值可能会改变。 |
15.1.15. .spec.endpointPublishingStrategy.private
- 描述
- private 包含 Private 端点发布策略的参数。仅在类型为 Private 时才出现。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| protocol 指定 IngressController 是否需要传入连接使用普通 TCP，还是 IngressController 是否需要 PROXY 协议。PROXY 协议可以和支持它的负载均衡器一起使用，以便在将这些连接转发到 IngressController 时通信客户端连接的源地址。使用 PROXY 协议可让 IngressController 报告这些源地址，而不是在 HTTP 标头和日志中报告负载均衡器的地址。请注意，如果您不使用使用 PROXY 协议的负载均衡器将连接转发到 IngressController，则 IngressController 上启用 PROXY 协议会导致连接失败。有关 PROXY 协议的信息，请参阅 http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt。以下值对于此字段有效：* 空字符串。* "TCP".* "PROXY".空字符串指定默认字符串，即没有 PROXY 协议的 TCP。请注意，默认值可能会改变。 |
15.1.16. .spec.httpCompression
- 描述
- httpCompression 定义 HTTP 流量压缩的策略。默认情况下，没有 HTTP 压缩。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| mimeTypes 是应该应用压缩的 MIME 类型列表。此列表可能为空，在这种情况下，入口控制器不会应用压缩。注意：并非所有 MIME 类型都受益于压缩，但 HAProxy 仍然将使用资源在指示时尝试压缩。通常说，文本(html、css、js 等)格式可从压缩中受益，但已压缩的格式（镜像、音频、视频等）在交换上需要花费的时间和 cpu 花费。See https://joehonton.medium.com/the-gzip-penalty-d31bd697f1a2 |
15.1.17. .spec.httpErrorCodePages
- 描述
- httpErrorCodePages 指定带有自定义错误页面的 configmap。管理员必须在 openshift-config 命名空间中创建此 configmap。此 configmap 的格式应为 "error-page-<error code>.http"，其中 <error code> 是一个 HTTP 错误代码。例如，"error-page-503.http" 定义了 HTTP 503 响应的错误页面。目前只能自定义 503 和 404 响应的错误页面。configmap 中的每个值都应该是完整的响应，包括 HTTP 标头。eg- https://raw.githubusercontent.com/openshift/router/fadab45747a9b30cc3f0a4b41ad2871f95827a93/images/router/haproxy/conf/error-page-503.http 如果此字段为空，ingress 控制器将使用默认错误页面。
- 类型
-
object - 必填
-
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是引用的配置映射的 metadata.name |
15.1.18. .spec.httpHeaders
- 描述
- httpHeaders 为 HTTP 标头定义策略。如果此字段为空，则使用默认值。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| forwardHeaderPolicy 指定 IngressController 设置 Forwarded、X-Forwarded-For、X-Forwarded-Host、X-Forwarded-Port、X-Forwarded-Proto 和 X-Forwarded-Proto-Version HTTP 标头的时间和方式。该值可以是以下之一：* "Append"，它指定 IngressController 附加了标头，保留现有的标头。* "replace"，它指定 IngressController 设置标头，替换任何现有的 Forwarded 或 X-Forwarded fluentd 标头。* "IfNone"，指定 IngressController 在尚未设置标头时设置它们。* "never"，它指定 IngressController 永远不会设置标头，保留任何现有的标头。默认情况下，策略为 "Append"。 |
|
| `` | headerNameCaseAdjustments 指定可用于 HTTP 标头名称的问题单调整。每个调整都指定一个 HTTP 标头名称需要进行相关的大小写调整。例如，指定 "X-Forwarded-For" 表示"x-forwarded-for" HTTP 标头应调整为具有指定的大写。这些调整仅应用于明文、边缘终止和重新加密路由，且仅在使用 HTTP/1 时有效。对于请求标头，这些调整仅适用于具有 haproxy.router.openshift.io/h1-adjust-case=true 注解的路由。对于响应标头，这些调整适用于所有 HTTP 响应。如果此字段为空，则不会调整任何请求标头。 |
|
|
| uniqueId 描述了自定义 HTTP 标头的配置，入口控制器应注入传入的 HTTP 请求。通常，此标头配置为具有对 HTTP 请求是唯一的值。标头可供应用程序使用，或包含在访问日志中，以方便追踪各个 HTTP 请求。如果此字段为空，则不会将此类标头注入到请求中。 |
15.1.19. .spec.httpHeaders.uniqueId
- 描述
- uniqueId 描述了自定义 HTTP 标头的配置，入口控制器应注入传入的 HTTP 请求。通常，此标头配置为具有对 HTTP 请求是唯一的值。标头可供应用程序使用，或包含在访问日志中，以方便追踪各个 HTTP 请求。如果此字段为空，则不会将此类标头注入到请求中。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| format 指定注入的 HTTP 标头值的格式。除非指定了 name，否则此字段无效。对于基于 HAProxy 的入口控制器实现，这种格式与 HTTP 日志格式的语法相同。如果字段为空，则默认值为 "%{+X}o\\ %ci:%cp_%fi:%fp_%Ts_%rt:%rt:%pid"; 请参阅对应的 HAProxy 文档： http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3 |
|
|
| name 指定入口控制器注入 HTTP 请求的 HTTP 标头的名称（如 "unique-id"）。字段的值必须是 RFC 2616 部分 4.2 中定义的有效 HTTP 标头名称。如果字段为空，则不会注入标头。 |
15.1.20. .spec.logging
- 描述
- logging 为应记录的内容定义参数。如果此字段为空，则会启用运行日志，但禁用访问日志。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| access 描述了应如何记录客户端请求。如果此字段为空，则禁用访问日志。 |
15.1.21. .spec.logging.access
- 描述
- access 描述了应如何记录客户端请求。如果此字段为空，则禁用访问日志。
- 类型
-
object - 必填
-
目的地
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 目的地是访问日志的位置。 |
|
| `` | httpCaptureCookies 指定应在访问日志中捕获的 HTTP cookie。如果此字段为空，则不会捕获 Cookie。 |
|
|
| httpCaptureHeaders 定义应在访问日志中捕获的 HTTP 标头。如果此字段为空，则不会捕获任何标头。请注意，这个选项只适用于明文 HTTP 连接，以及入口控制器终止加密的安全 HTTP 连接（即边缘终止或重新加密连接）。对于 TLS 透传连接，无法捕获标头。 |
|
|
| httpLogFormat 指定 HTTP 请求的日志消息格式。如果此字段为空，日志消息将使用实现中的默认 HTTP 日志格式。对于 HAProxy 的默认 HTTP 日志格式，请参阅 HAProxy 文档： http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3 请注意，这个格式只适用于明文 HTTP 连接，以及入口控制器终止加密的 HTTP 连接的安全（即边缘终止或重新加密连接）。它不会影响 TLS 透传连接的日志格式。 |
|
|
| logEmptyRequests 指定如何记录没有接收请求的连接。通常，这些空请求来自负载均衡器的健康探测或 Web 浏览器的规范连接("preconnect")，在这种情况下，日志记录这些请求可能并不重要。但是，这些请求也可能是由网络错误导致的，在这种情况下，记录空请求可能有助于诊断错误。此外，这些请求可能是由端口扫描导致的，在这种情况下，记录空请求有助于检测入侵尝试。此字段允许的值是 "Log" 和 "Ignore"。默认值为 "Log"。 |
15.1.22. .spec.logging.access.destination
- 描述
- 目的地是访问日志的位置。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 容器包含容器日志记录目的地的参数。仅在类型为 Container 时才会出现。 |
|
|
| syslog 包含 syslog 端点的参数。仅在 type 为 Syslog 时才出现。 |
|
|
| type 是日志的目的地类型。它必须是以下之一：* Container The ingress operator 在 ingress 控制器 pod 上配置名为 "logs" 的 sidecar 容器，并将 ingress 控制器配置为将日志写入 sidecar。然后，日志作为容器日志可用。管理员应该配置一个自定义日志记录解决方案，从这个 sidecar 读取日志。请注意，使用容器日志意味着当日志速率超过容器运行时或自定义日志记录解决方案的容量时，日志可能会丢弃。* syslog 日志发送到 syslog 端点。管理员必须指定可以接收 syslog 信息的端点。管理员应该已经配置了一个自定义 syslog 实例。 |
15.1.23. .spec.logging.access.destination.container
- 描述
- 容器包含容器日志记录目的地的参数。仅在类型为 Container 时才会出现。
- 类型
-
对象
15.1.24. .spec.logging.access.destination.syslog
- 描述
- syslog 包含 syslog 端点的参数。仅在 type 为 Syslog 时才出现。
- 类型
-
object - 必填
-
address -
port
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| address 是接收日志消息的 syslog 端点的 IP 地址。 |
|
|
| facility 指定日志消息的 syslog 工具。如果此字段为空，则工具为 "local1"。 |
|
|
| MaxLength 是 syslog 消息的最大长度（如果此字段为空），maxLength 设置为 "1024"。 |
|
|
| port 是接收日志消息的 syslog 端点的 UDP 端口号。 |
15.1.25. .spec.logging.access.httpCaptureHeaders
- 描述
- httpCaptureHeaders 定义应在访问日志中捕获的 HTTP 标头。如果此字段为空，则不会捕获任何标头。请注意，这个选项只适用于明文 HTTP 连接，以及入口控制器终止加密的安全 HTTP 连接（即边缘终止或重新加密连接）。对于 TLS 透传连接，无法捕获标头。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| `` | request 指定要捕获的 HTTP 请求标头。如果此字段为空，则不会捕获任何请求标头。 |
|
| `` | response 指定要捕获的 HTTP 响应标头。如果此字段为空，则不会捕获响应标头。 |
15.1.26. .spec.namespaceSelector
- 描述
- namespaceSelector 用于过滤由 ingress 控制器提供服务的一组命名空间。这对实现分片（shard）非常有用。如果未设置，则默认为没有过滤。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
15.1.27. .spec.namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
15.1.28. .spec.namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
15.1.29. .spec.nodePlacement
- 描述
- nodePlacement 启用对入口控制器调度的显式控制。如果未设置，则使用默认值。如需了解更多详细信息，请参阅 NodePlacement。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| nodeSelector 是应用到入口控制器部署的节点选择器。如果设置，则使用指定的选择器并替换默认值。如果未设置，则默认值取决于集群 config.openshift.io/v1/ingresses 状态中的 defaultPlacement 字段的值。当 defaultPlacement 是 Workers 时，默认值为： kubernetes.io/os: linux node-role.kubernetes.io/worker: '' when defaultPlacement is ControlPlane, default is: kubernetes.io/os: linux node-role.kubernetes.io/master: '' The these defaults be change.请注意，不支持使用 nodeSelector.matchExpressions。只能使用 nodeSelector.matchLabels。这是 Kubernetes API 的一个限制：pod 规格不允许对节点选择器进行复杂的表达式。 |
|
|
| tolerations 是应用到入口控制器部署的容限列表。默认值为空列表。请参阅 https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
|
|
| 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。 |
15.1.30. .spec.nodePlacement.nodeSelector
- 描述
- nodeSelector 是应用到入口控制器部署的节点选择器。如果设置，则使用指定的选择器并替换默认值。如果未设置，则默认值取决于集群 config.openshift.io/v1/ingresses 状态中的 defaultPlacement 字段的值。当 defaultPlacement 是 Workers 时，默认值为： kubernetes.io/os: linux node-role.kubernetes.io/worker: '' when defaultPlacement is ControlPlane, default is: kubernetes.io/os: linux node-role.kubernetes.io/master: '' The these defaults be change.请注意，不支持使用 nodeSelector.matchExpressions。只能使用 nodeSelector.matchLabels。这是 Kubernetes API 的一个限制：pod 规格不允许对节点选择器进行复杂的表达式。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
15.1.31. .spec.nodePlacement.nodeSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
15.1.32. .spec.nodePlacement.nodeSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
15.1.33. .spec.nodePlacement.tolerations
- 描述
- tolerations 是应用到入口控制器部署的容限列表。默认值为空列表。See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
- 类型
-
array
15.1.34. .spec.nodePlacement.tolerations[]
- 描述
- 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| effect 表示要匹配的污点效果。空意味着匹配所有污点效果。指定后，允许的值为 NoSchedule，PreferNoSchedule 和 NoExecute。 |
|
|
| key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空，则必须存在运算符；组合意味着匹配所有值和所有键。 |
|
|
| Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认值为 Equal。exists 等同于值的通配符，以便 pod 可以容忍特定类别的所有污点。 |
|
|
| tolerationSeconds 代表容限的期间（必须生效 NoExecute，否则此字段将被忽略）可以容忍污点。默认情况下，它不会被设置，这意味着容许任何污点（不要驱除）。零值和负值将被视为 0 （立即删除）。 |
|
|
| value 是容限匹配的污点值。如果运算符是 Exists，则该值应该为空，否则仅是一个常规字符串。 |
15.1.35. .spec.routeAdmission
- 描述
- routeAdmission 定义了处理新路由声明的策略（例如，允许或拒绝命名空间之间的声明）。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 routeAdmission 字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| namespaceOwnership 描述了如何处理跨命名空间的主机名声明。值必须是： - Strict: 不允许不同命名空间中的路由声明同一主机。- InterNamespaceAllowed: 允许路由在命名空间间声明相同主机名的不同路径。如果为空，则默认为 Strict。 |
|
|
| wildcardPolicy 描述了如何为 ingress 控制器处理带有通配符策略的路由。wildcardPolicy 控制使用由入口控制器根据路由的通配符策略公开的路由 [1]。https://github.com/openshift/api/blob/master/route/v1/types.go 注意：将 WildcardPolicy 从 WildcardsAllowed 更新为 WildcardsDisallowed 将导致带有 Subdomain 通配符策略接受的路由停止工作。这些路由必须更新为由入口控制器读取的 None 通配符策略。wildcardPolicy 支持 WildcardsAllowed 和 WildcardsDisallowed 值。如果为空，则默认为 "WildcardsDisallowed"。 |
15.1.36. .spec.routeSelector
- 描述
- routeSelector 用于过滤由入口控制器提供服务的一组 Routes。这对实现分片（shard）非常有用。如果未设置，则默认为没有过滤。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
15.1.37. .spec.routeSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
array
15.1.38. .spec.routeSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
15.1.39. .spec.tlsSecurityProfile
- 描述
- tlsSecurityProfile 指定 ingresscontrollers 的 TLS 连接的设置。如果未设置，则默认值基于 apiservers.config.openshift.io/cluster 资源。请注意，在使用 Old、Intermediate 和 Modern 配置集类型时，有效的配置集配置可能会在发行版本间有所变化。例如，使用在版本 X.Y.Z 中部署的 Intermediate 配置集，升级到版本 X.Y.Z+1 可能会导致新的配置集应用到 ingress 控制器，从而导致一个 rollout 操作。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
| `` | Custom 是一个用户定义的 TLS 安全配置集。使用自定义配置集时要非常小心，因为无效的配置可能是灾难性的。一个自定义配置集示例： password: - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 minTLSVersion: TLSv1.1 |
|
| `` | intermediate 是一个基于以下内容的 TLS 安全配置集： https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29 https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29 and looks like this (yaml): - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 minTLSVersion: TLSv1.2 |
|
| `` | modern 是一个基于 https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility 的 TLS 安全配置集，如下所示：密码： - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 minTLSVersion: TLSv1.3 NOTE: Current unsupported. |
|
| `` | 旧是一个基于以下的 TLS 安全配置集： https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility and looks like this (yaml): - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 - DHE-RSA-CHACHA20-POLY1305 - ECDHE-ECDSA-AES128-SHA256 - ECDHE-RSA-AES128-SHA256 - ECDHE-ECDSA-AES128-AES128-SHA - ECDHE-RSA-AES128-AES256-SHA384 - ECDHE-RSA-AES256-SHA384 - ECDHE-ECDSA-AES256-SHA-SHA - ECDHE-RSA-AES256-SHA - DHE-RSA-AES128-SHA256 - DHE-RSA-AES256-SHA256 - AES128-GCM-SHA256 - AES256-GCM-SHA384 - AES128-SHA256 - AES256-SHA256 - AES128-SHA - AES256-SHA - DES-CBC3-SHA minTLSVersion: TLSv1.0 |
|
|
| type 是 Old、Intermediate、Modern 或 Custom 之一。自定义提供指定各个 TLS 安全配置集参数的功能。旧，Intermediate 和 Modern 是基于 TLS 安全配置集 ：https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations。 配置集基于意图，因此当开发新密码时可能会随时间变化，并且发现现有密码不安全。根据具体哪些密码可用于进程，可以减少列表。请注意，Modern 配置集目前还不被支持，因为它还没有被常见软件库正确采用。 |
15.1.40. .spec.tuningOptions
- 描述
- tuningOptions 定义用于调整入口控制器 pod 性能的参数。所有字段都是可选的，如果未设置，则使用它们对应的默认值。如需了解更多详细信息，请参阅特定的 tuningOptions 字段。通常不建议在 tuningOptions 中设置字段。默认值适用于大多数配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| clientFinTimeout 定义连接在等待客户端响应关闭连接时保持打开的时长。如果未设置，则默认超时为 1s |
|
|
| clientTimeout 定义连接在等待客户端响应时保持打开的时长。如果未设置，则默认超时为 30s |
|
|
| headerBufferBytes 描述了 IngressController 连接会话应保留多少内存（以字节为单位）。请注意，如果 IngressController 启用了 HTTP/2，则该值必须至少为 16384 (https://tools.ietf.org/html/rfc7540)。如果此字段为空，IngressController 将使用默认值 32768 字节。通常不建议设置此字段，因为 headerBufferBytes 值太小可能会破坏 IngressController 和 headerBufferBytes 值太大可能会导致 IngressController 使用比必要多的内存。 |
|
|
| headerBufferMaxRewriteBytes 描述了 headerBufferBytes 为 HTTP 标头重写和附加 IngressController 连接会话应保留多少内存（以字节为单位）。请注意，传入的 HTTP 请求将限制为(headerBufferBytes - headerBufferMaxRewriteBytes)字节，即 headerBufferBytes 必须大于 headerBufferMaxRewriteBytes。如果此字段为空，IngressController 将使用默认值 8192 字节。通常不建议设置此字段，因为 headerBufferMaxRewriteBytes 值太小可能会破坏 IngressController 和 headerBufferMaxRewriteBytes 值，它们太大可能会导致 IngressController 使用比必要更多的内存。 |
|
|
| healthCheckInterval 定义路由器在其配置的后端两个连续健康检查之间等待的时间。这个值被全局应用作为所有路由的默认值，但路由注解 "router.openshift.io/haproxy.health.check.interval" 可能会覆盖每个路由。需要一个未签名的持续时间字符串，每个数字都有可选的 fraction 和一个单位后缀，如 "300ms"、"1.5h" 或 "2h45m"。有效的时间单位是 "ns", "us" （或 "uss" U+00B5 或 "HEKETIs" U+03BC）, "ms", "s", "m", "h"。把它设置为小于 5s 可能会导致流量因为频繁频繁的 TCP 健康检查和附带 SYN 数据包状态而造成过量流量。另外，由于已不再可用的后端服务器，设置太高可能会导致延迟增加，但尚未检测到延迟。空或零的 healthCheckInterval 表示没有建议，IngressController 会选择一个默认值，这可能会随时间变化。目前，默认的 healthCheckInterval 值为 5s。目前，允许的最小值为 1s，允许的最大值为 2147483647ms (24.85 天)。这两者都可能会随着时间而变化。 |
|
|
| maxConnections 定义每个 HAProxy 进程可建立的最大同时连接数。增加这个值可让每个入口控制器 pod 处理更多连接，但代价是被消耗的额外系统资源。允许的值有： empty, 0, -1, 和 range 2000-2000000。如果此字段为空或 0，IngressController 将使用默认值 50000，但默认值可能会在以后的版本中有所变化。如果值为 -1，则 HAProxy 将根据运行中容器中的可用 ulimits 动态计算最大值。选择 -1 （即 auto）会导致计算大量值（在 OpenShift >=4.10 集群中约520000），因此每个 HAProxy 进程都会与当前默认值 50000 相比产生大量内存用量。设置大于当前操作系统限制的值将阻止 HAProxy 进程启动。如果您选择了一个离散值（如 750000），并且路由器 Pod 迁移到新节点，则不能保证新节点配置了相同的 ulimits。在这种情况下，pod 无法启动。如果您配置了不同的 ulimits 的节点（例如，不同的调优配置集），并且您选择了离散值，那么指导是使用 -1，并允许在运行时动态计算值。您可以使用以下指标监控路由器容器的内存用量： 'container_memory_working_set_bytes{container="router",namespace="openshift-ingress"}'。您可以使用以下指标监控路由器容器中的单个 HAProxy 进程的内存使用量： 'container_memory_working_set_bytes{container="router",namespace="openshift-ingress"}/container_processes{container="router",namespace="openshift-ingress"}'。 |
|
|
| reloadInterval 定义允许重新加载路由器接受新更改的最小间隔。根据场景，增加这个值可以防止 HAProxy 进程积累。在使用 roundrobin 平衡算法时，增加这个间隔也可以降低后端服务器上的负载均衡。另外，减少这个值可能会降低延迟，因为 HAProxy 配置的更新可能会更快地生效。该值必须是持续时间值 ; 请参阅 https://pkg.go.dev/time#ParseDuration。目前，允许的最小值为 1s，最大允许的值是 120s。在以后的 OpenShift 版本中，允许的最小和最大值可能会改变。请注意，如果提供了这些绑定以外的持续时间，则 reloadInterval 的值将被上限/失败，且不会被拒绝（例如，超过 120s 的持续时间将上限为 120s；IngressController 不会拒绝并将禁止的值替换为默认值）。reloadInterval 的零值告知 IngressController 选择默认值，这是目前 5s，可能在不通知的情况下更改。此字段需要未签名的持续时间字符串为十进制数字，每个数字都有可选的 fraction 和一个单元后缀，如。"300ms", "1.5h" 或 "2h45m"。有效的时间单位是 "ns", "us" （或 "uss" U+00B5 或 "HEKETIs" U+03BC）, "ms", "s", "m", "h"。注：设置值会显著大于默认值 5s 可能会导致观察路由及其端点更新延迟。HAProxy 的配置将更频繁地重新加载，只有在后续重新加载之前，不会提供新创建的路由。 |
|
|
| serverFinTimeout 定义连接在等待服务器/后端响应关闭连接时保持打开的时长。如果未设置，则默认超时为 1s |
|
|
| serverTimeout 定义连接在等待服务器/后端响应时保持打开的时长。如果未设置，则默认超时为 30s |
|
|
| threadCount 定义每个 HAProxy 进程创建的线程数量。创建更多线程可让每个入口控制器 pod 处理更多连接，而代价会增加所使用的系统资源。HAProxy 目前支持最多 64 个线程。如果此字段为空，IngressController 将使用默认值。当前默认为 4 个线程，但以后的发行版本中可能会改变。通常不建议设置此字段。增加 HAProxy 线程的数量允许入口控制器 pod 在负载下使用更多 CPU 时间，如果设置过高，则可能耗尽其他 pod。减少线程数量可能会导致入口控制器性能不佳。 |
|
|
| tlsInspectDelay 定义路由器可以保存数据以查找匹配的路由的时长。这个设置太短可能会导致路由器回退到边缘终止或重新加密路由的默认证书，即使可以使用更匹配的证书。如果未设置，则默认检查延迟为 5s |
|
|
| tunnelTimeout 定义隧道连接（包括 websocket）在隧道闲置时保持打开的时长。如果未设置，则默认超时为 1h |
15.1.41. .status
- 描述
- Status 是 IngressController 最近观察到的状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| availableReplicas 是根据入口控制器部署观察到的可用副本数。 |
|
|
| conditions 是条件及其状态的列表。Available 意味着入口控制器部署可用，并为路由和入口资源（即 .status.availableReplicas 等于 .spec.replicas）提供额外的条件来指示其他入口控制器特性和功能的状态。* LoadBalancerManaged - 如果满足以下条件，则为 True ：* 端点发布策略需要一个服务负载均衡器。- 如果这些条件不满意，则为 False。* LoadBalancerReady - 如果满足以下条件，则为 True ：* 一个负载均衡器被管理。* 负载均衡器已就绪。- 如果这些条件不满意，则为 False。* DNSManaged - 如果满足以下条件，则为 True：* 端点发布策略和平台支持 DNS。* 设置了入口控制器域。* DNS.config.openshift.io/cluster 配置 DNS 区域。- 如果这些条件不满意，则为 False。* DNSReady - 如果满足以下条件，则为 True: * DNS is managed.* DNS 记录已被成功创建。- 如果这些条件不满意，则为 False。 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| domain 是实际正在使用的域。 |
|
|
| endpointPublishingStrategy 是使用的实际策略。 |
|
|
| namespaceSelector 是使用的实际 namespaceSelector。 |
|
|
| observedGeneration 是观察到的最新生成。 |
|
|
| routeSelector 是使用的实际 routeSelector。 |
|
|
| selector 是字符串格式的标签选择器，用于与 IngressController 对应的 ingress 控制器 pod。匹配 pod 的数量应该等于 availableReplicas 的值。 |
|
|
| TLSProfile 是生效的 TLS 连接配置。 |
15.1.42. .status.conditions
- 描述
- conditions 是条件及其状态的列表。Available 意味着入口控制器部署可用，并为路由和入口资源（即 .status.availableReplicas 等于 .spec.replicas）提供额外的条件来指示其他入口控制器特性和功能的状态。* LoadBalancerManaged - 如果满足以下条件，则为 True ：* 端点发布策略需要一个服务负载均衡器。- 如果这些条件不满意，则为 False。* LoadBalancerReady - 如果满足以下条件，则为 True ：* 一个负载均衡器被管理。* 负载均衡器已就绪。- 如果这些条件不满意，则为 False。* DNSManaged - 如果满足以下条件，则为 True：* 端点发布策略和平台支持 DNS。* 设置了入口控制器域。* DNS.config.openshift.io/cluster 配置 DNS 区域。- 如果这些条件不满意，则为 False。* DNSReady - 如果满足以下条件，则为 True: * DNS is managed.* DNS 记录已被成功创建。- 如果这些条件不满意，则为 False。
- 类型
-
array
15.1.43. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
15.1.44. .status.endpointPublishingStrategy
- 描述
- endpointPublishingStrategy 是使用的实际策略。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| HostNetwork 包含 HostNetwork 端点发布策略的参数。仅在 type 为 HostNetwork 时才出现。 |
|
|
| LoadBalancer 包含负载均衡器的参数。仅在类型为 LoadBalancerService 时才出现。 |
|
|
| NodePort 包含 NodePortService 端点发布策略的参数。仅在 type 是 NodePortService 时才出现。 |
|
|
| private 包含 Private 端点发布策略的参数。仅在类型为 Private 时才出现。 |
|
|
| type 是要使用的发布策略。有效值为：* LoadBalancerService 使用 Kubernetes LoadBalancer Service 发布入口控制器。在这个配置中，入口控制器部署使用容器网络。创建了一个 LoadBalancer 服务来发布部署。请参阅 ：https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer 如果设置了域，将管理通配符 DNS 记录以指向 LoadBalancer 服务的外部名称。DNS 记录只在 dns.config.openshift.io/cluster .spec.publicZone 和 .spec.privateZone 定义的 DNS 区域中管理。目前仅在 AWS、Azure 和 GCP 平台上支持通配符 DNS 管理。* HostNetwork 在部署了入口控制器的节点端口上发布入口控制器。在这个配置中，入口控制器部署使用主机网络，并绑定到节点端口 80 和 443。用户负责配置外部负载均衡器，以通过节点端口发布入口控制器。* private Does 没有发布入口控制器。在这个配置中，入口控制器部署使用容器网络，且不会被显式发布。用户必须手动发布入口控制器。* NodePortService 使用 Kubernetes NodePort Service 发布入口控制器。在这个配置中，入口控制器部署使用容器网络。创建了一个 NodePort 服务来发布部署。特定的节点端口由 OpenShift 动态分配，但为了支持静态端口分配，用户会保留对受管 NodePort Service 的节点端口字段的更改。 |
15.1.45. .status.endpointPublishingStrategy.hostNetwork
- 描述
- HostNetwork 包含 HostNetwork 端点发布策略的参数。仅在 type 为 HostNetwork 时才出现。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| httpPort 是主机上的端口，应该用于侦听 HTTP 请求。当端口 80 已在使用时，应设置此字段。该值不应与集群的 NodePort 范围冲突。如果值为 0 或未指定值，则默认为 80。 |
|
|
| httpsPort 是主机上的端口，应该用于侦听 HTTPS 请求。当端口 443 已在使用时，应设置此字段。该值不应与集群的 NodePort 范围冲突。如果值为 0 或未指定值，则默认为 443。 |
|
|
| protocol 指定 IngressController 是否需要传入连接使用普通 TCP，还是 IngressController 是否需要 PROXY 协议。PROXY 协议可以和支持它的负载均衡器一起使用，以便在将这些连接转发到 IngressController 时通信客户端连接的源地址。使用 PROXY 协议可让 IngressController 报告这些源地址，而不是在 HTTP 标头和日志中报告负载均衡器的地址。请注意，如果您不使用使用 PROXY 协议的负载均衡器将连接转发到 IngressController，则 IngressController 上启用 PROXY 协议会导致连接失败。有关 PROXY 协议的信息，请参阅 http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt。以下值对于此字段有效：* 空字符串。* "TCP".* "PROXY"。空字符串指定默认字符串，即没有 PROXY 协议的 TCP。请注意，默认值可能会改变。 |
|
|
| statsPort 是发布路由器统计的主机上的端口。该值不应与集群的 NodePort 范围冲突。如果外部负载均衡器配置为将连接转发到此 IngressController，负载均衡器应该使用此端口进行健康检查。负载均衡器可以在给定节点上的这个端口上发送 HTTP 探测，路径为 /healthz/ready，以确定入口控制器是否准备好接收节点上的流量。对于正常操作，负载均衡器必须在健康检查报告就绪前，不会将流量转发到节点。负载均衡器还应该在 /healthz/ready 开始报告未就绪后最多停止对 45 秒的转发请求。每 5 秒探测到 10 秒(5 秒超时)，并且两个成功或失败请求的阈值分别变为健康或不健康。当值为 0 或未指定值时，默认为 1936。 |
15.1.46. .status.endpointPublishingStrategy.loadBalancer
- 描述
- LoadBalancer 包含负载均衡器的参数。仅在类型为 LoadBalancerService 时才出现。
- 类型
-
object - 必填
-
dnsManagementPolicy -
scope
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
| `` | AllowedSourceRanges 指定 IP 地址范围允许列表，应该限制访问负载均衡器的访问。必须使用 CIDR 表示法（例如，）指定每个范围。"10.0.0.0/8" 或 "fd00::/8"）。如果没有指定范围，则默认使用 IPv4 的"0.0.0.0/0"和 IPv6 的"::/0"，这将允许所有源地址。为了便于从没有 allowedSourceRanges 字段的 OpenShift 版本的迁移，您可以在 "openshift-ingress" 命名空间中的 "router-<ingresscontroller name>" 服务上设置 service.beta.kubernetes.io/load-balancer-source-ranges 注解。 |
|
|
| dnsManagementPolicy 表示与负载均衡器服务关联的通配符 DNS 记录的生命周期是否由 ingress operator 管理。默认为 Managed。有效值为：Managed 和 Unmanaged。 |
|
|
| providerParameters 包含特定于底层基础架构供应商的所需的负载均衡器信息。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 providerParameters 字段。 |
|
|
| scope 表示公开负载均衡器的范围。可能的值有 "External" 和 "Internal"。 |
15.1.47. .status.endpointPublishingStrategy.loadBalancer.providerParameters
- 描述
- providerParameters 包含特定于底层基础架构供应商的所需的负载均衡器信息。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 providerParameters 字段。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| AWS 提供特定于 AWS 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 aws 字段。 |
|
|
| GCP 提供特定于 GCP 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 gcp 字段。 |
|
|
| IBM 提供特定于 IBM Cloud 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 ibm 字段。 |
|
|
| type 是负载均衡器的底层基础架构供应商。允许的值是 "AWS", "Azure", "BareMetal", "GCP", "IBM", "Nutanix", "OpenStack", 和 "VSphere"。 |
15.1.48. .status.endpointPublishingStrategy.loadBalancer.providerParameters.aws
- 描述
- AWS 提供特定于 AWS 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 aws 字段。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| classicLoadBalancerParameters 包含 AWS 经典负载均衡器的配置参数。仅在 type 为 Classic 时才出现。 |
|
|
| networkLoadBalancerParameters 包含 AWS 网络负载均衡器的配置参数。仅在类型为 NLB 时才存在。 |
|
|
| type 是为 ingresscontroller 实例化的 AWS 负载均衡器的类型。有效值为：* "Classic": 一个 Classic Load Balancer，它在传输层(TCP/SSL)或应用程序层(HTTP/HTTPS)上做出路由决策。详情请查看以下内容： https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb * "NLB": A Network Load Balancer，它在传输层(TCP/SSL)中做出路由决策。详情请查看以下内容： https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb |
15.1.49. .status.endpointPublishingStrategy.loadBalancer.providerParameters.aws.classicLoadBalancer
- 描述
- classicLoadBalancerParameters 包含 AWS 经典负载均衡器的配置参数。仅在 type 为 Classic 时才出现。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| connectionIdleTimeout 指定在负载均衡器关闭连接前可以闲置的最大时间段。该值必须解析为持续时间值；请参阅 https://pkg.go.dev/time#ParseDuration。nil 或零值表示没有建议，在这种情况下，会使用默认值。此字段的默认值为 60s。这个默认设置可能会改变。 |
15.1.50. .status.endpointPublishingStrategy.loadBalancer.providerParameters.aws.networkLoadBalancer
- 描述
- networkLoadBalancerParameters 包含 AWS 网络负载均衡器的配置参数。仅在类型为 NLB 时才存在。
- 类型
-
对象
15.1.51. .status.endpointPublishingStrategy.loadBalancer.providerParameters.gcp
- 描述
- GCP 提供特定于 GCP 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 gcp 字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| clientAccess 描述了如何对内部负载均衡器限制客户端访问。有效值为：* "Global": 指定带有全局客户端访问的内部负载均衡器，允许 VPC 中的任何区域与负载均衡器通信。https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#global_access "local": 指定带有本地客户端访问的内部负载均衡器，这意味着只有同一区域（和 VPC）中的客户端才可以与负载均衡器通信。请注意，这是默认行为。https://cloud.google.com/load-balancing/docs/internal#client_access |
15.1.52. .status.endpointPublishingStrategy.loadBalancer.providerParameters.ibm
- 描述
- IBM 提供特定于 IBM Cloud 负载均衡器的配置设置。如果为空，则应用默认值。有关其默认值的详情，请查看特定的 ibm 字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| protocol 指定负载均衡器是否使用 PROXY 协议将连接转发到 IngressController。请参阅 "service.kubernetes.io/ibm-load-balancer-cloud-provider-enable-features: "proxy-protocol"" （位于 https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas PROXY 协议）可用于支持它在将客户端连接的源地址转发到 IngressController 时进行通信客户端连接的源地址。使用 PROXY 协议可让 IngressController 报告这些源地址，而不是在 HTTP 标头和日志中报告负载均衡器的地址。请注意，如果您不使用使用 PROXY 协议的负载均衡器将连接转发到 IngressController，则 IngressController 上启用 PROXY 协议会导致连接失败。有关 PROXY 协议的信息，请参阅 http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt。协议的有效值为 TCP、PROXY 和 omitted。省略时，这意味着没有建议，平台会被保留选择合理的默认值，这可能会随时间变化。当前的默认值是 TCP，不启用代理协议。 |
15.1.53. .status.endpointPublishingStrategy.nodePort
- 描述
- NodePort 包含 NodePortService 端点发布策略的参数。仅在 type 是 NodePortService 时才出现。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| protocol 指定 IngressController 是否需要传入连接使用普通 TCP，还是 IngressController 是否需要 PROXY 协议。PROXY 协议可以和支持它的负载均衡器一起使用，以便在将这些连接转发到 IngressController 时通信客户端连接的源地址。使用 PROXY 协议可让 IngressController 报告这些源地址，而不是在 HTTP 标头和日志中报告负载均衡器的地址。请注意，如果您不使用使用 PROXY 协议的负载均衡器将连接转发到 IngressController，则 IngressController 上启用 PROXY 协议会导致连接失败。有关 PROXY 协议的信息，请参阅 http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt。以下值对于此字段有效：* 空字符串。* "TCP".* "PROXY".空字符串指定默认字符串，即没有 PROXY 协议的 TCP。请注意，默认值可能会改变。 |
15.1.54. .status.endpointPublishingStrategy.private
- 描述
- private 包含 Private 端点发布策略的参数。仅在类型为 Private 时才出现。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| protocol 指定 IngressController 是否需要传入连接使用普通 TCP，还是 IngressController 是否需要 PROXY 协议。PROXY 协议可以和支持它的负载均衡器一起使用，以便在将这些连接转发到 IngressController 时通信客户端连接的源地址。使用 PROXY 协议可让 IngressController 报告这些源地址，而不是在 HTTP 标头和日志中报告负载均衡器的地址。请注意，如果您不使用使用 PROXY 协议的负载均衡器将连接转发到 IngressController，则 IngressController 上启用 PROXY 协议会导致连接失败。有关 PROXY 协议的信息，请参阅 http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt。以下值对于此字段有效：* 空字符串。* "TCP".* "PROXY".空字符串指定默认字符串，即没有 PROXY 协议的 TCP。请注意，默认值可能会改变。 |
15.1.55. .status.namespaceSelector
- 描述
- namespaceSelector 是使用的实际 namespaceSelector。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
15.1.56. .status.namespaceSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
数组
15.1.57. .status.namespaceSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
15.1.58. .status.routeSelector
- 描述
- routeSelector 是使用的实际 routeSelector。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。 |
|
|
| 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。 |
|
|
| matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。 |
15.1.59. .status.routeSelector.matchExpressions
- 描述
- matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
- 类型
-
数组
15.1.60. .status.routeSelector.matchExpressions[]
- 描述
- 标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
- 类型
-
object - 必填
-
key -
operator
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| key 是选择器应用到的标签键。 |
|
|
| 运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。 |
|
|
| 值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。 |
15.1.61. .status.tlsProfile
- 描述
- TLSProfile 是生效的 TLS 连接配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 密码用于指定 TLS 握手期间协商的加密算法。Operator 可能会删除其操作对象不支持的条目。例如，要使用 DES-CBC3-SHA (yaml)：密码： - DES-CBC3-SHA |
|
|
| minTLSVersion 用于指定 TLS 握手期间协商的 TLS 协议的最小版本。例如，要使用 TLS 版本 1.1、1.2 和 1.3 (yaml)： minTLSVersion: TLSv1.1 备注：当前允许最高的 minTLSVersion 是 VersionTLS12 |
15.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/ingresscontrollers-
GET: 列出类型为 IngressController 的对象
-
/apis/operator.openshift.io/v1/namespaces/{namespace}/ingresscontrollers-
DELETE: 删除 IngressController 集合 -
GET: 列出类型为 IngressController 的对象 -
POST：创建 IngressController
-
/apis/operator.openshift.io/v1/namespaces/{namespace}/ingresscontrollers/{name}-
DELETE: delete an IngressController -
GET：读取指定的 IngressController -
PATCH: 部分更新指定的 IngressController -
PUT：替换指定的 IngressController
-
/apis/operator.openshift.io/v1/namespaces/{namespace}/ingresscontrollers/{name}/scale-
GET：指定 IngressController 的读取规模 -
PATCH: 部分更新指定 IngressController 的扩展 -
PUT：替换指定 IngressController 的扩展
-
/apis/operator.openshift.io/v1/namespaces/{namespace}/ingresscontrollers/{name}/status-
GET：指定 IngressController 的读取状态 -
PATCH: 部分更新指定 IngressController 的状态 -
PUT：替换指定 IngressController 的状态
-
15.2.1. /apis/operator.openshift.io/v1/ingresscontrollers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出类型为 IngressController 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
15.2.2. /apis/operator.openshift.io/v1/namespaces/{namespace}/ingresscontrollers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 IngressController 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 IngressController 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 IngressController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
15.2.3. /apis/operator.openshift.io/v1/namespaces/{namespace}/ingresscontrollers/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| IngressController 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- delete an IngressController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 IngressController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 IngressController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 IngressController
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
15.2.4. /apis/operator.openshift.io/v1/namespaces/{namespace}/ingresscontrollers/{name}/scale
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| IngressController 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 IngressController 的读取规模
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 IngressController 的扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 IngressController 的扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
15.2.5. /apis/operator.openshift.io/v1/namespaces/{namespace}/ingresscontrollers/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| IngressController 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 IngressController 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 IngressController 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 IngressController 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 16 章 InsightsOperator [operator.openshift.io/v1]
- 描述
- InsightsOperator 包含有关 Insights Operator 的集群范围信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
16.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 | |
|
|
| spec 是 Insights 所需的行为的规格。 |
|
|
| Status 是 Insights 操作器最近观察到的状态。 |
16.1.1. .spec
- 描述
- spec 是 Insights 所需的行为的规格。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
16.1.2. .status
- 描述
- Status 是 Insights 操作器最近观察到的状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| gatherStatus 提供有关最后一次 Insights 数据收集的基本信息。如果省略时，这意味着还没有进行数据收集。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| insightsReport 提供常规 Insights 分析结果。如果省略时，这意味着还没有进行数据收集。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
16.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
16.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
16.1.5. .status.gatherStatus
- 描述
- gatherStatus 提供有关最后一次 Insights 数据收集的基本信息。如果省略时，这意味着还没有进行数据收集。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| gatherers 是最后一次收集的活跃收集者（及其状态）的列表。 |
|
|
| gathererStatus 代表有关特定数据收集器的信息。 |
|
|
| lastGatherDuration 是最后一次收集事件期间处理所有收集者的总时间。 |
|
|
| lastGatherTime 是 Insights 数据收集完成后最后一次的时间。空值表示还没有收集任何数据。 |
16.1.6. .status.gatherStatus.gatherers
- 描述
- gatherers 是最后一次收集的活跃收集者（及其状态）的列表。
- 类型
-
array
16.1.7. .status.gatherStatus.gatherers[]
- 描述
- gathererStatus 代表有关特定数据收集器的信息。
- 类型
-
object - 必填
-
conditions -
lastGatherDuration -
name
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 条件详细介绍了每个收集器的状态。 |
|
|
|
条件包含此 API 资源当前状态的一个方面的详情。--- 这个结构旨在直接用作字段路径 .status.conditions 中的数组。例如，输入 FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
|
|
| lastGatherDuration 代表收集时间。 |
|
|
| name 是 gatherer 的名称。 |
16.1.8. .status.gatherStatus.gatherers[].conditions
- 描述
- 条件详细介绍了每个收集器的状态。
- 类型
-
数组
16.1.9. .status.gatherStatus.gatherers[].conditions[]
- 描述
-
条件包含此 API 资源当前状态的一个方面的详情。--- 这个结构旨在直接用作字段路径 .status.conditions 中的数组。例如，输入 FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"// other fields } - 类型
-
object - 必填
-
lastTransitionTime -
message -
reason -
status -
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。 |
|
|
| Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。 |
|
|
| observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。 |
|
|
| reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。 |
|
|
| 条件的状态，True, False, Unknown 之一。 |
|
|
| CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt) |
16.1.10. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
16.1.11. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
16.1.12. .status.insightsReport
- 描述
- insightsReport 提供常规 Insights 分析结果。如果省略时，这意味着还没有进行数据收集。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| downloadedAt 是下载最后一次 Insights 报告的时间。一个空值表示，还没有下载 Insights 报告，它通常会出现在断开连接的集群中（当禁用 Insights 数据收集时）。 |
|
|
| 健康检查提供有关集群中活跃 Insights 健康检查的基本信息。 |
|
|
| Healthcheck 代表 Insights 健康检查属性。 |
16.1.13. .status.insightsReport.healthChecks
- 描述
- 健康检查提供有关集群中活跃 Insights 健康检查的基本信息。
- 类型
-
array
16.1.14. .status.insightsReport.healthChecks[]
- 描述
- Healthcheck 代表 Insights 健康检查属性。
- 类型
-
object - 必填
-
advisorURI -
description -
state -
TotalRisk
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 公告URI 提供到 Insights Advisor 的 URL 链接。 |
|
|
| 描述提供了 healtcheck 的基本描述。 |
|
|
| State 决定健康检查的当前状态是什么。健康检查默认为启用，可以被 Insights 公告用户界面中的用户禁用。 |
|
|
| 健康检查的 TotalRisk。检测到的问题所带来的总风险的指标；影响和可能性组合。值可以从 1 到 4、数值越高，问题越大越重要。 |
16.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/insightsoperators-
DELETE: 删除 InsightsOperator 集合 -
GET: 列出类型为 InsightsOperator 的对象 -
POST：创建 InsightsOperator
-
/apis/operator.openshift.io/v1/insightsoperators/{name}-
DELETE：删除 InsightsOperator -
GET：读取指定的 InsightsOperator -
PATCH: 部分更新指定的 InsightsOperator -
PUT：替换指定的 InsightsOperator
-
/apis/operator.openshift.io/v1/insightsoperators/{name}/scale-
GET：指定 InsightsOperator 的读取扩展 -
PATCH: 部分更新指定 InsightsOperator 扩展 -
PUT：替换指定 InsightsOperator 的规模
-
/apis/operator.openshift.io/v1/insightsoperators/{name}/status-
GET：指定 InsightsOperator 的读取状态 -
PATCH: 部分更新指定 InsightsOperator 的状态 -
PUT：替换指定 InsightsOperator 的状态
-
16.2.1. /apis/operator.openshift.io/v1/insightsoperators
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 InsightsOperator 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 InsightsOperator 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 InsightsOperator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
16.2.2. /apis/operator.openshift.io/v1/insightsoperators/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| InsightsOperator 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 InsightsOperator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 阅读指定的 InsightsOperator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 InsightsOperator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 InsightsOperator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
16.2.3. /apis/operator.openshift.io/v1/insightsoperators/{name}/scale
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| InsightsOperator 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 InsightsOperator 的读取规模
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 InsightsOperator 扩展
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 InsightsOperator 的规模
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
16.2.4. /apis/operator.openshift.io/v1/insightsoperators/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| InsightsOperator 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 InsightsOperator 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 InsightsOperator 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 InsightsOperator 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 17 章 KubeAPIServer [operator.openshift.io/v1]
- 描述
- kubeapiserver 提供配置 Operator 来管理 kube-apiserver 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
17.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 | |
|
|
| spec 是 Kubernetes API 服务器所需行为的规格 |
|
|
| status 是 Kubernetes API 服务器最近观察到的状态 |
17.1.1. .spec
- 描述
- spec 是 Kubernetes API 服务器所需行为的规格
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| failedRevisionLimit 是要保留在磁盘上的失败静态 pod 安装程序修订的数量，在 api -1 = unlimited, 0 或 unset = 5 (default) |
|
|
| 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 (default) |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
17.1.2. .status
- 描述
- status 是 Kubernetes API 服务器最近观察到的状态
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| latestAvailableRevision 是最新部署的 deploymentID |
|
|
| latestAvailableRevisionReason 描述最新部署的详细原因 |
|
|
| nodeStatuses 跟踪单个节点上的部署值和错误 |
|
|
| NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| ServiceAccountIssuers 跟踪已用服务帐户签发者的历史记录。没有过期时间的项目代表当前使用的服务帐户签发者。其他项目表示之前使用的服务帐户签发者，它们仍然被信任。项目的默认过期时间由平台设置，默认为 24h。请参阅 ：https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection |
|
|
| |
|
|
| 版本是此可用性适用的级别 |
17.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
17.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
17.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
17.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
17.1.7. .status.nodeStatuses
- 描述
- nodeStatuses 跟踪单个节点上的部署值和错误
- 类型
-
array
17.1.8. .status.nodeStatuses[]
- 描述
- NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| currentRevision 是最近成功的部署的生成 |
|
|
| lastFailedCount 是最后一次失败修订版本的安装程序 pod 失败的频率。 |
|
|
| lastFailedReason 是一个机器可读的故障原因字符串。 |
|
|
| lastFailedRevision 是我们尝试和部署的部署生成。 |
|
|
| lastFailedRevisionErrors 是 lastFailedRevision 中引用的失败部署中人类可读的错误列表。 |
|
|
| lastFailedTime 是最后一次失败的修订版本最后一次失败的时间。 |
|
|
| lastFallbackCount 是回退到上一修订版本的频率。 |
|
|
| nodeName 是节点的名称 |
|
|
| targetRevision 是我们试图应用的部署生成 |
17.1.9. .status.serviceAccountIssuers
- 描述
- ServiceAccountIssuers 跟踪已用服务帐户签发者的历史记录。没有过期时间的项目代表当前使用的服务帐户签发者。其他项目表示之前使用的服务帐户签发者，它们仍然被信任。项目的默认过期时间由平台设置，默认为 24h。请参阅 ：https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection
- 类型
-
数组
17.1.10. .status.serviceAccountIssuers[]
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| expirationTime 是此服务帐户签发者将被修剪并从服务帐户签发者列表中删除的时间。 |
|
|
| name 是服务帐户签发者 --- |
17.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/kubeapiservers-
DELETE：删除 KubeAPIServer 集合 -
GET: 列出类型为 KubeAPIServer 的对象 -
POST：创建 KubeAPIServer
-
/apis/operator.openshift.io/v1/kubeapiservers/{name}-
DELETE: delete a KubeAPIServer -
GET：读取指定的 KubeAPIServer -
PATCH: 部分更新指定的 KubeAPIServer -
PUT：替换指定的 KubeAPIServer
-
/apis/operator.openshift.io/v1/kubeapiservers/{name}/status-
GET：指定 KubeAPIServer 的读取状态 -
PATCH: 部分更新指定 KubeAPIServer 的状态 -
PUT：替换指定 KubeAPIServer 的状态
-
17.2.1. /apis/operator.openshift.io/v1/kubeapiservers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 KubeAPIServer 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 KubeAPIServer 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 KubeAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
17.2.2. /apis/operator.openshift.io/v1/kubeapiservers/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| KubeAPIServer 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 KubeAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 KubeAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 KubeAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 KubeAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
17.2.3. /apis/operator.openshift.io/v1/kubeapiservers/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| KubeAPIServer 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 KubeAPIServer 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 KubeAPIServer 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 KubeAPIServer 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 18 章 KubeControllerManager [operator.openshift.io/v1]
- 描述
- kubecontrollermanager 提供配置 Operator 以管理 kube-controller-manager 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
18.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 | |
|
|
| spec 是 Kubernetes Controller Manager 所需的行为的规格 |
|
|
| Status 是 Kubernetes Controller Manager 最近观察到的状态 |
18.1.1. .spec
- 描述
- spec 是 Kubernetes Controller Manager 所需的行为的规格
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| failedRevisionLimit 是要保留在磁盘上的失败静态 pod 安装程序修订的数量，在 api -1 = unlimited, 0 或 unset = 5 (default) |
|
|
| 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 (default) |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
|
|
| useMoreSecureServiceCA 表示 SA 令牌卷中提供的 service-ca.crt 应该只包含足够的证书来验证服务证书。当设置为 true 后，它不能设为 false。即使有人发现一种将它设为 false 的方法，之前存在的 service-ca.crt 文件也会具有更安全的内容。 |
18.1.2. .status
- 描述
- Status 是 Kubernetes Controller Manager 最近观察到的状态
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| latestAvailableRevision 是最新部署的 deploymentID |
|
|
| latestAvailableRevisionReason 描述最新部署的详细原因 |
|
|
| nodeStatuses 跟踪单个节点上的部署值和错误 |
|
|
| NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
18.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
18.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
18.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
18.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
18.1.7. .status.nodeStatuses
- 描述
- nodeStatuses 跟踪单个节点上的部署值和错误
- 类型
-
array
18.1.8. .status.nodeStatuses[]
- 描述
- NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| currentRevision 是最近成功的部署的生成 |
|
|
| lastFailedCount 是最后一次失败修订版本的安装程序 pod 失败的频率。 |
|
|
| lastFailedReason 是一个机器可读的故障原因字符串。 |
|
|
| lastFailedRevision 是我们尝试和部署的部署生成。 |
|
|
| lastFailedRevisionErrors 是 lastFailedRevision 中引用的失败部署中人类可读的错误列表。 |
|
|
| lastFailedTime 是最后一次失败的修订版本最后一次失败的时间。 |
|
|
| lastFallbackCount 是回退到上一修订版本的频率。 |
|
|
| nodeName 是节点的名称 |
|
|
| targetRevision 是我们试图应用的部署生成 |
18.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/kubecontrollermanagers-
DELETE：删除 KubeControllerManager 集合 -
GET: 列出类型为 KubeControllerManager 的对象 -
POST：创建 KubeControllerManager
-
/apis/operator.openshift.io/v1/kubecontrollermanagers/{name}-
DELETE：删除 KubeControllerManager -
GET：读取指定的 KubeControllerManager -
PATCH: 部分更新指定的 KubeControllerManager -
PUT：替换指定的 KubeControllerManager
-
/apis/operator.openshift.io/v1/kubecontrollermanagers/{name}/status-
GET：指定 KubeControllerManager 的读取状态 -
PATCH: 部分更新指定 KubeControllerManager 的状态 -
PUT：替换指定 KubeControllerManager 的状态
-
18.2.1. /apis/operator.openshift.io/v1/kubecontrollermanagers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 KubeControllerManager 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 KubeControllerManager 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 KubeControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
18.2.2. /apis/operator.openshift.io/v1/kubecontrollermanagers/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| KubeControllerManager 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 KubeControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 KubeControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 KubeControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 KubeControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
18.2.3. /apis/operator.openshift.io/v1/kubecontrollermanagers/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| KubeControllerManager 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 KubeControllerManager 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 KubeControllerManager 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 KubeControllerManager 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 19 章 KubeScheduler [operator.openshift.io/v1]
- 描述
- kubescheduler 提供配置操作器以管理调度程序的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
19.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 | |
|
|
| spec 是 Kubernetes 调度程序所需的行为的规格 |
|
|
| status 是 Kubernetes 调度程序最近观察到的状态 |
19.1.1. .spec
- 描述
- spec 是 Kubernetes 调度程序所需的行为的规格
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| failedRevisionLimit 是要保留在磁盘上的失败静态 pod 安装程序修订的数量，在 api -1 = unlimited, 0 或 unset = 5 (default) |
|
|
| 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 (default) |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
19.1.2. .status
- 描述
- status 是 Kubernetes 调度程序最近观察到的状态
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| latestAvailableRevision 是最新部署的 deploymentID |
|
|
| latestAvailableRevisionReason 描述最新部署的详细原因 |
|
|
| nodeStatuses 跟踪单个节点上的部署值和错误 |
|
|
| NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
19.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
19.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
19.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
19.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
19.1.7. .status.nodeStatuses
- 描述
- nodeStatuses 跟踪单个节点上的部署值和错误
- 类型
-
array
19.1.8. .status.nodeStatuses[]
- 描述
- NodeStatus 提供有关此操作器管理的特定节点的当前状态的信息。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| currentRevision 是最近成功的部署的生成 |
|
|
| lastFailedCount 是最后一次失败修订版本的安装程序 pod 失败的频率。 |
|
|
| lastFailedReason 是一个机器可读的故障原因字符串。 |
|
|
| lastFailedRevision 是我们尝试和部署的部署生成。 |
|
|
| lastFailedRevisionErrors 是 lastFailedRevision 中引用的失败部署中人类可读的错误列表。 |
|
|
| lastFailedTime 是最后一次失败的修订版本最后一次失败的时间。 |
|
|
| lastFallbackCount 是回退到上一修订版本的频率。 |
|
|
| nodeName 是节点的名称 |
|
|
| targetRevision 是我们试图应用的部署生成 |
19.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/kubeschedulers-
DELETE: 删除 KubeScheduler 集合 -
GET: 列出类型为 KubeScheduler 的对象 -
POST：创建 KubeScheduler
-
/apis/operator.openshift.io/v1/kubeschedulers/{name}-
DELETE：删除 KubeScheduler -
GET：读取指定的 KubeScheduler -
PATCH: 部分更新指定的 KubeScheduler -
PUT：替换指定的 KubeScheduler
-
/apis/operator.openshift.io/v1/kubeschedulers/{name}/status-
GET：指定 KubeScheduler 的读取状态 -
PATCH: 部分更新指定 KubeScheduler 的状态 -
PUT：替换指定 KubeScheduler 的状态
-
19.2.1. /apis/operator.openshift.io/v1/kubeschedulers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 KubeScheduler 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 KubeScheduler 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 KubeScheduler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空 |
19.2.2. /apis/operator.openshift.io/v1/kubeschedulers/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| KubeScheduler 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 KubeScheduler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 KubeScheduler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 KubeScheduler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 KubeScheduler
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
19.2.3. /apis/operator.openshift.io/v1/kubeschedulers/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| KubeScheduler 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 KubeScheduler 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 KubeScheduler 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 KubeScheduler 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 20 章 KubeStorageVersionMigrator [operator.openshift.io/v1]
- 描述
- KubeStorageVersionMigrator 提供配置 Operator 的信息来管理 kube-storage-version-migrator。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
20.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 | |
|
|
| |
|
|
|
20.1.1. .spec
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
20.1.2. .status
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
20.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
20.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
20.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
20.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
20.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/kubestorageversionmigrators-
DELETE: 删除 KubeStorageVersionMigrator 集合 -
GET: 列出类型为 KubeStorageVersionMigrator 的对象 -
POST：创建一个 KubeStorageVersionMigrator
-
/apis/operator.openshift.io/v1/kubestorageversionmigrators/{name}-
DELETE: delete a KubeStorageVersionMigrator -
GET：读取指定的 KubeStorageVersionMigrator -
PATCH: 部分更新指定的 KubeStorageVersionMigrator -
PUT：替换指定的 KubeStorageVersionMigrator
-
/apis/operator.openshift.io/v1/kubestorageversionmigrators/{name}/status-
GET：指定 KubeStorageVersionMigrator 的读取状态 -
PATCH: 部分更新指定 KubeStorageVersionMigrator 的状态 -
PUT：替换指定 KubeStorageVersionMigrator 的状态
-
20.2.1. /apis/operator.openshift.io/v1/kubestorageversionmigrators
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 KubeStorageVersionMigrator 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 KubeStorageVersionMigrator 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 KubeStorageVersionMigrator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
20.2.2. /apis/operator.openshift.io/v1/kubestorageversionmigrators/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| KubeStorageVersionMigrator 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- delete a KubeStorageVersionMigrator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 阅读指定的 KubeStorageVersionMigrator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 KubeStorageVersionMigrator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 KubeStorageVersionMigrator
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
20.2.3. /apis/operator.openshift.io/v1/kubestorageversionmigrators/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| KubeStorageVersionMigrator 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 KubeStorageVersionMigrator 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 KubeStorageVersionMigrator 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 KubeStorageVersionMigrator 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 21 章 Network [operator.openshift.io/v1]
- 描述
- network 描述了集群所需的网络配置。它被 cluster-network-operator 使用。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
对象
21.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 | |
|
|
| NetworkSpec 是顶级网络配置对象。 |
|
|
| NetworkStatus 是详细的 operator 状态，它被干扰到 Network clusteroperator 对象。 |
21.1.1. .spec
- 描述
- NetworkSpec 是顶级网络配置对象。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| additionalNetworks 是启用了多个网络时可供 pod 使用的额外网络列表。 |
|
|
| AdditionalNetworkDefinition 配置了一个额外的网络，该网络可用但没有默认创建。相反，pod 必须按名称请求它们。必须指定类型，以及与类型匹配的 "Config"。 |
|
|
| clusterNetwork 是用于 pod IP 的 IP 地址池。一些网络提供程序（如 OpenShift SDN）支持多个 ClusterNetworks。其他产品仅支持一个。这等同于 cluster-cidr。 |
|
|
| ClusterNetworkEntry 是一个要从中分配 PodIP 的子网。当节点加入集群时，将分配大小为 HostPrefix （以 CIDR 表示法）的网络。如果插件不使用 HostPrefix 字段，则可以取消设置它。不是所有网络供应商都支持多个 ClusterNetworks |
|
|
| defaultNetwork 是所有 pod 将接收的"默认"网络 |
|
|
| deployKubeProxy 指定 Operator 是否应该部署独立 kube-proxy。有些网络供应商包括 kube-proxy 或类似功能。如果未设置，则插件将尝试选择正确的值，该值在 OpenShift SDN 和 ovn-kubernetes 被使用时为 false，否则为 true。 |
|
|
| disableMultiNetwork 指定是否应禁用多个 pod 网络支持。如果未设置，此属性默认为 'false'，并启用多个网络支持。 |
|
|
| disableNetworkDiagnostics 指定 PodNetworkConnectivityCheck CR 从一个测试 pod 到每个节点，apiserver 和 LB 是否应该被禁用。如果未设置，此属性默认为 'false'，并且启用了网络诊断。把它设置为 'true' 可减少执行检查的 pod 的额外负载。 |
|
|
| exportNetworkFlows 通过使用协议 NetFlow、SFlow 或 IPFIX 启用并配置来自 pod 网络的网络流元数据导出。目前仅在 OVN-Kubernetes 插件中支持。如果未设置，则不会将流导出到任何收集器。 |
|
|
| kubeProxyConfig 可让我们配置所需的代理配置。如果未指定，OpenShift 将直接选择相应的默认值。不会被所有网络供应商使用 - 目前只有 openshift-sdn。 |
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
|
| 迁移启用并配置集群网络迁移。迁移步骤允许更改网络类型和 MTU。 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| serviceNetwork 是服务 IP 当前使用的 ip 地址池，所有现有的网络供应商只支持一个值，但这是一个允许增长的数组。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
|
|
| useMultiNetworkPolicy 启用一个控制器，允许 MultiNetworkPolicy 对象用于 Multus CNI 创建的额外网络。MultiNetworkPolicy 与 NetworkPolicy 对象类似，但 NetworkPolicy 对象只适用于主接口。使用 MultiNetworkPolicy，您可以控制 pod 可以通过二级接口接收的流量。如果未设置，此属性默认为 'false' 和 MultiNetworkPolicy 对象。如果 'disableMultiNetwork' 是 'true'，则此字段的值将被忽略。 |
21.1.2. .spec.additionalNetworks
- 描述
- additionalNetworks 是启用了多个网络时可供 pod 使用的额外网络列表。
- 类型
-
array
21.1.3. .spec.additionalNetworks[]
- 描述
- AdditionalNetworkDefinition 配置了一个额外的网络，该网络可用但没有默认创建。相反，pod 必须按名称请求它们。必须指定类型，以及与类型匹配的 "Config"。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| name 是网络的名称。这将在生成的 CRD 中填充，这必须是唯一的。 |
|
|
| namespace 是网络的命名空间。这将在生成的 CRD 中填充，如果没有给定网络会在 default 命名空间中创建。 |
|
|
| rawCNIConfig 是要在 NetworkAttachmentDefinition CRD 中创建的原始 CNI 配置 json |
|
|
| 在 type:NetworkTypeSimpleMacvlan 时，simpleMacvlanConfig 配置 macvlan 接口 |
|
|
| type 是网络类型。支持的值有 NetworkTypeRaw, NetworkTypeSimpleMacvlan |
21.1.4. .spec.additionalNetworks[].simpleMacvlanConfig
- 描述
- 在 type:NetworkTypeSimpleMacvlan 时，simpleMacvlanConfig 配置 macvlan 接口
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| ipamConfig 配置 IPAM 模块将用于 IP 地址管理(IPAM)。 |
|
|
| master 是要从中创建 macvlan 接口的主机接口。如果没有指定，它将是默认路由接口 |
|
|
| 模式是 macvlan 模式：bridge、private、vepa、passthru。默认值为 bridge |
|
|
| MTU 是用于 macvlan 接口的 mtu。如果未设置，主机的内核将选择该值。 |
21.1.5. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig
- 描述
- ipamConfig 配置 IPAM 模块将用于 IP 地址管理(IPAM)。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 在类型为：IPAMTypeStatic 时，staticIPAMConfig 配置静态 IP 地址 |
|
|
| type 是 IPAM 模块的类型将用于 IP 地址管理(IPAM)。支持的值有 IPAMTypeDHCP, IPAMTypeStatic |
21.1.6. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig
- 描述
- 在类型为：IPAMTypeStatic 时，staticIPAMConfig 配置静态 IP 地址
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 地址为接口配置 IP 地址 |
|
|
| StaticIPAMAddresses 为静态 IPAM 地址提供 IP 地址和网关 |
|
|
| DNS 为接口配置 DNS |
|
|
| 路由为接口配置 IP 路由 |
|
|
| StaticIPAMRoutes 为静态 IPAM 路由提供 Destination/Gateway 对 |
21.1.7. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses
- 描述
- 地址为接口配置 IP 地址
- 类型
-
array
21.1.8. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.addresses[]
- 描述
- StaticIPAMAddresses 为静态 IPAM 地址提供 IP 地址和网关
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| address 是 CIDR 格式的 IP 地址 |
|
|
| gateway 是子网内部的 IP，指定为网关 |
21.1.9. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.dns
- 描述
- DNS 为接口配置 DNS
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| domain 配置用于短主机名查找的本地域的 domainname |
|
|
| 名称服务器指向 DNS 服务器进行 IP 查找 |
|
|
| 搜索配置优先级排序的搜索域以进行短主机名查找 |
21.1.10. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes
- 描述
- 路由为接口配置 IP 路由
- 类型
-
array
21.1.11. .spec.additionalNetworks[].simpleMacvlanConfig.ipamConfig.staticIPAMConfig.routes[]
- 描述
- StaticIPAMRoutes 为静态 IPAM 路由提供 Destination/Gateway 对
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 目标点 IP 路由目的地 |
|
|
| gateway 是路由的下一跃点 IP 地址（如果未设置），则假定默认网关（由 CNI 插件决定）。 |
21.1.12. .spec.clusterNetwork
- 描述
- clusterNetwork 是用于 pod IP 的 IP 地址池。一些网络提供程序（如 OpenShift SDN）支持多个 ClusterNetworks。其他产品仅支持一个。这等同于 cluster-cidr。
- 类型
-
array
21.1.13. .spec.clusterNetwork[]
- 描述
- ClusterNetworkEntry 是一个要从中分配 PodIP 的子网。当节点加入集群时，将分配大小为 HostPrefix （以 CIDR 表示法）的网络。如果插件不使用 HostPrefix 字段，则可以取消设置它。不是所有网络供应商都支持多个 ClusterNetworks
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
|
21.1.14. .spec.defaultNetwork
- 描述
- defaultNetwork 是所有 pod 将接收的"默认"网络
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| kuryrConfig 配置 kuryr 插件 |
|
|
| openshiftSDNConfig 配置 openshift-sdn 插件 |
|
|
| ovnKubernetesConfig 配置 ovn-kubernetes 插件。 |
|
|
| type 是网络 All NetworkTypes 的类型，但 NetworkTypeRaw 除外 |
21.1.15. .spec.defaultNetwork.kuryrConfig
- 描述
- kuryrConfig 配置 kuryr 插件
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 端口 kuryr-controller 将侦听就绪度和存活度请求。 |
|
|
| 端口 kuryr-daemon 将侦听就绪度和存活度请求。 |
|
|
| 当 true 将使 Kuryr 预填充时，enablePortPoolsPrepopulation 会使每个新创建的端口池具有最少数量的端口。Kuryr 使用 Neutron 端口池来混淆，它会需要大量时间来创建。当将第一个 pod 配置为在命名空间中创建为 pod 使用专用网络时，它会创建多个端口，并使它们准备好附加到 pod。默认情况下禁用端口预填充。 |
|
|
| MTU 是 Kuryr 在 Neutron 中创建 pod 网络时应使用的 MTU。该值必须较低或等于节点网络的 MTU，Neutron 必须允许使用此类 MTU 创建租户网络。如果取消设置 Pod 网络，则会使用与节点网络相同的 MTU 创建。这也会影响 cluster-network-operator 创建的服务网络。 |
|
|
|
openStackServiceNetwork 包含网络 CIDR，从中为 OpenStack Octavia 的 Amphora 虚拟机分配 IP。请注意，在 Amphora 驱动程序 Octavia 时，每个 loadbalancer 都使用来自该网络的两个 IP，一个由 OpenShift 指定，第二个用于 VRRP 连接。由于第一个由 OpenShift 管理，第二个由 Neutron 的 IPAM 管理，因此它们需要来自不同的池。因此，openStackServiceNetwork 需要至少为 |
|
|
| poolBatchPorts 设置在单一批处理请求中应该创建的多个端口来扩展端口池。默认值为 3。有关端口池的更多信息，请参阅 enablePortPoolsPrepopulation 设置。 |
|
|
| poolMaxPorts 设置在端口池中保留的最大可用端口数。如果端口数量超过此设置，则空闲端口将被删除。设置 0 将禁用此上限，有效防止池缩小，这是默认值。有关端口池的更多信息，请参阅 enablePortPoolsPrepopulation 设置。 |
|
|
| poolMinPorts 设置应在端口池中保留的最小可用端口。如果端口数量低于此设置，则将创建新端口并添加到池中。默认值为 1。有关端口池的更多信息，请参阅 enablePortPoolsPrepopulation 设置。 |
21.1.16. .spec.defaultNetwork.openshiftSDNConfig
- 描述
- openshiftSDNConfig 配置 openshift-sdn 插件
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 启用并发控制服务代理是否支持闲置和取消闲置服务。默认情况下启用取消闲置。 |
|
|
| 模式是 "Multitenant", "Subnet" 或 "NetworkPolicy" 之一 |
|
|
| MTU 是用于隧道接口的 mtu。如果未设置，则默认为 1450。这必须小于机器的 uplink。 |
|
|
| 使用ExternalOpenvswitch 来控制 Operator 是否部署 OVS DaemonSet 本身，还是希望其他人启动 OVS。从 4.6 开始，OVS 始终作为系统服务运行，这个标记将被忽略。DEPRECATED: non- function from 4.6 |
|
|
| vxlanPort 是所有 vxlan 数据包使用的端口。默认值为 4789。 |
21.1.17. .spec.defaultNetwork.ovnKubernetesConfig
- 描述
- ovnKubernetesConfig 配置 ovn-kubernetes 插件。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| egressIPConfig 包含 EgressIP 选项的配置。 |
|
|
| gatewayConfig 包含节点网关选项的配置。 |
|
|
| Geneve 端口是 geneve encapulation 使用的 UDP 端口。默认值为 6081 |
|
|
| hybridOverlayConfig 为不使用 OVN 的对等点配置额外的覆盖网络。 |
|
|
| ipsecConfig 为集群中的 pod 网络上的 pod 启用并配置 IPsec。 |
|
|
| MTU 是用于隧道接口的 MTU。这必须小于 uplink mtu 的 100 字节。默认值为 1400 |
|
|
| policyAuditConfig 是网络策略审计事件的配置。如果未设置，则使用报告的默认值。 |
|
|
| v4InternalSubnet 是 ovn-kubernetes 内部使用的 v4 子网，如果默认子网已被其他人使用。它不得与 OpenShift 或节点网络使用的任何其他子网重叠。子网的大小必须大于节点的数量。在安装后无法更改该值。默认值为 100.64.0.0/16 |
|
|
| v6InternalSubnet 是 ovn-kubernetes 内部使用的 v6 子网，如果默认子网已被其他人使用。它不得与 OpenShift 或节点网络使用的任何其他子网重叠。子网的大小必须大于节点的数量。在安装后无法更改该值。默认为 fd98::/48 |
21.1.18. .spec.defaultNetwork.ovnKubernetesConfig.egressIPConfig
- 描述
- egressIPConfig 包含 EgressIP 选项的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| reachabilityTotalTimeout 配置 EgressIP 节点可访问性检查总超时（以秒为单位）。如果在这个超时时间内无法访问 EgressIP 节点，则会声明该节点。设置较大的值可能会导致 EgressIP 功能对节点更改做出反应。特别是，对于真正具有正常问题且无法访问的 EgressIP 节点，它可能会很慢。如果省略，这意味着用户没有建议，平台会被保留选择合理的默认值，这可能会随时间变化。当前的默认值为 1 秒。0 代表禁用 EgressIP 节点的可访问性检查。 |
21.1.19. .spec.defaultNetwork.ovnKubernetesConfig.gatewayConfig
- 描述
- gatewayConfig 包含节点网关选项的配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| routingViaHost 允许 pod 出口流量通过 ovn-k8s-mp0 管理端口退出，然后再将其发送到主机。如果没有设置，流量将始终直接从 OVN 出口到外部，而无需涉及主机堆栈。把它设置为 true 表示不支持硬件卸载。如果指定了 GatewayConfig，则默认为 false。 |
21.1.20. .spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig
- 描述
- hybridOverlayConfig 为不使用 OVN 的对等点配置额外的覆盖网络。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| hybridClusterNetwork 定义分配给额外覆盖网络上的节点的网络命名空间。 |
|
|
| ClusterNetworkEntry 是一个要从中分配 PodIP 的子网。当节点加入集群时，将分配大小为 HostPrefix （以 CIDR 表示法）的网络。如果插件不使用 HostPrefix 字段，则可以取消设置它。不是所有网络供应商都支持多个 ClusterNetworks |
|
|
| hybridOverlayVXLANPort 定义额外的覆盖网络要使用的 VXLAN 端口号。默认为 4789 |
21.1.21. .spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork
- 描述
- hybridClusterNetwork 定义分配给额外覆盖网络上的节点的网络命名空间。
- 类型
-
array
21.1.22. .spec.defaultNetwork.ovnKubernetesConfig.hybridOverlayConfig.hybridClusterNetwork[]
- 描述
- ClusterNetworkEntry 是一个要从中分配 PodIP 的子网。当节点加入集群时，将分配大小为 HostPrefix （以 CIDR 表示法）的网络。如果插件不使用 HostPrefix 字段，则可以取消设置它。不是所有网络供应商都支持多个 ClusterNetworks
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
|
21.1.23. .spec.defaultNetwork.ovnKubernetesConfig.ipsecConfig
- 描述
- ipsecConfig 为集群中的 pod 网络上的 pod 启用并配置 IPsec。
- 类型
-
对象
21.1.24. .spec.defaultNetwork.ovnKubernetesConfig.policyAuditConfig
- 描述
- policyAuditConfig 是网络策略审计事件的配置。如果未设置，则使用报告的默认值。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| destination 是策略日志消息的位置。无论这种配置如何，永久日志将始终转储到位于 /var/log/ovn/ 中的主机，但也可以配置其他 syslog 输出，如下所示。有效值有： - "libc" → 使用主机节点的 journdd 进程的 libc syslog （）功能 - "udp:host:port" → 用于通过 UDP 发送 syslog - "unix:file" → 用于直接使用 UNIX 域套接字 - "null" → 丢弃日志记录到 syslog The default is "null" 的所有消息 |
|
|
| maxFilesSize 是在轮转单元以 MB 为单位前允许 ACL_audit 日志文件的最大大小，默认为 50MB |
|
|
| maxLogFiles 指定可以存在的最大 ACL_audit 日志文件数。 |
|
|
| ratelimit 是每个节点每秒生成的最大消息数。如果未设置默认值 20 msg/sec。 |
|
|
| syslogFacility the RFC5424 工具用于生成的信息，如 "kern"。默认为 "local0" |
21.1.25. .spec.exportNetworkFlows
- 描述
- exportNetworkFlows 通过使用协议 NetFlow、SFlow 或 IPFIX 启用并配置来自 pod 网络的网络流元数据导出。目前仅在 OVN-Kubernetes 插件中支持。如果未设置，则不会将流导出到任何收集器。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| IPFIX 定义 IPFIX 配置。 |
|
|
| NetFlow 定义 NetFlow 配置。 |
|
|
| sFlow 定义 SFlow 配置。 |
21.1.26. .spec.exportNetworkFlows.ipfix
- 描述
- IPFIX 定义 IPFIX 配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| ipfixCollectors 是字符串列表，格式为 ip:port，最多为 10 个项 |
21.1.27. .spec.exportNetworkFlows.netFlow
- 描述
- NetFlow 定义 NetFlow 配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| NetFlow 定义 NetFlow 收集器，它将消耗从 OVS 导出的流数据。它是字符串列表，格式为 ip:port，最多为 10 个项 |
21.1.28. .spec.exportNetworkFlows.sFlow
- 描述
- sFlow 定义 SFlow 配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| sFlowCollectors 是字符串列表，格式为 ip:port，最多为 10 个项 |
21.1.29. .spec.kubeProxyConfig
- 描述
- kubeProxyConfig 可让我们配置所需的代理配置。如果未指定，OpenShift 将直接选择相应的默认值。不会被所有网络供应商使用 - 目前只有 openshift-sdn。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 默认为 0.0.0.0 上的 "bind" 的地址 |
|
|
| 内部 kube-proxy 参数。在旧的 OCP 版本中，出于性能的原因，在大型集群中，这有时需要调整，但不再需要，因此不需要更改它。默认： 30s |
|
|
| 传递给 kubeproxy 进程的任何额外参数 |
|
|
| ProxyArgumentList 是一个传递给 kubeproxy 进程的参数列表 |
21.1.30. .spec.kubeProxyConfig.proxyArguments
- 描述
- 传递给 kubeproxy 进程的任何额外参数
- 类型
-
对象
21.1.31. .spec.migration
- 描述
- 迁移启用并配置集群网络迁移。迁移步骤允许更改网络类型和 MTU。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 功能包含迁移配置的功能。把它设置为在更改集群默认网络供应商时迁移功能配置。如果未设置，则默认操作是迁移所有支持的功能配置。 |
|
|
| MTU 包含 MTU 迁移配置。把它设置为允许更改默认网络的 MTU 值。如果未设置，则拒绝更改默认网络的 MTU 的操作。 |
|
|
| networkType 是网络迁移的目标类型。把它设置为目标网络类型以允许更改默认网络。如果未设置，更改集群默认网络插件的操作将被拒绝。支持的值有 OpenShiftSDN、OVNKubernetes |
21.1.32. .spec.migration.features
- 描述
- 功能包含迁移配置的功能。把它设置为在更改集群默认网络供应商时迁移功能配置。如果未设置，则默认操作是迁移所有支持的功能配置。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| EgressFirewall 指定在更改集群默认网络供应商时是否自动迁移 Egress 防火墙配置。如果未设置，则此属性默认为 'true' 和 Egress Firewall 配置。 |
|
|
| EgressIP 指定在更改集群默认网络供应商时是否自动迁移 Egress IP 配置。如果未设置，则此属性默认为 'true' 和 Egress IP 配置。 |
|
|
| multicast 指定在更改集群默认网络供应商时是否自动迁移多播配置。如果未设置，则此属性默认为 'true'，并迁移多播配置。 |
21.1.33. .spec.migration.mtu
- 描述
- MTU 包含 MTU 迁移配置。把它设置为允许更改默认网络的 MTU 值。如果未设置，则拒绝更改默认网络的 MTU 的操作。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 机器包含机器的 uplink 的 MTU 迁移配置。需要与默认网络 MTU 一起迁移，除非当前 uplink MTU 已容纳默认的网络 MTU。 |
|
|
| network 包含有关默认网络的 MTU 迁移的信息。迁移只允许的最小适当的偏移量小于机器的 uplink MTU 低的 MTU 值。 |
21.1.34. .spec.migration.mtu.machine
- 描述
- 机器包含机器的 uplink 的 MTU 迁移配置。需要与默认网络 MTU 一起迁移，除非当前 uplink MTU 已容纳默认的网络 MTU。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 从 是要从中迁移的 MTU。 |
|
|
| 要迁移到的 MTU。 |
21.1.35. .spec.migration.mtu.network
- 描述
- network 包含有关默认网络的 MTU 迁移的信息。迁移只允许的最小适当的偏移量小于机器的 uplink MTU 低的 MTU 值。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 从 是要从中迁移的 MTU。 |
|
|
| 要迁移到的 MTU。 |
21.1.36. .status
- 描述
- NetworkStatus 是详细的 operator 状态，它被干扰到 Network clusteroperator 对象。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
21.1.37. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
21.1.38. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
21.1.39. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
21.1.40. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
21.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/networks-
DELETE：删除网络集合 -
GET: 列出类型为 Network 的对象 -
POST：创建网络
-
/apis/operator.openshift.io/v1/networks/{name}-
DELETE：删除网络 -
GET：读取指定的网络 -
PATCH: 部分更新指定的网络 -
PUT：替换指定的网络
-
21.2.1. /apis/operator.openshift.io/v1/networks
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除网络集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 Network 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建网络
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
21.2.2. /apis/operator.openshift.io/v1/networks/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 网络的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除网络
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的网络
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的网络
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的网络
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 22 章 OpenShiftAPIServer [operator.openshift.io/v1]
- 描述
- OpenShiftapiserver 提供配置 Operator 来管理 openshift-apiserver 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
22.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 | |
|
|
| spec 是 OpenShift API 服务器所需行为的规格。 |
|
|
| Status 定义 OpenShift API 服务器的观察状态。 |
22.1.1. .spec
- 描述
- spec 是 OpenShift API 服务器所需行为的规格。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
22.1.2. .status
- 描述
- Status 定义 OpenShift API 服务器的观察状态。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| latestAvailableRevision 是最新修订版本，用作 encryption-config 等修订 secret 的后缀。新修订版本会导致 pod 的新部署。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
22.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
22.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
22.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
22.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
22.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/openshiftapiservers-
DELETE: 删除 OpenShiftAPIServer 集合 -
GET: 列出类型为 OpenShiftAPIServer 的对象 -
POST：创建 OpenShiftAPIServer
-
/apis/operator.openshift.io/v1/openshiftapiservers/{name}-
DELETE：删除 OpenShiftAPIServer -
GET：读取指定的 OpenShiftAPIServer -
PATCH: 部分更新指定的 OpenShiftAPIServer -
PUT：替换指定的 OpenShiftAPIServer
-
/apis/operator.openshift.io/v1/openshiftapiservers/{name}/status-
GET：指定 OpenShiftAPIServer 的读取状态 -
PATCH: 部分更新指定 OpenShiftAPIServer 的状态 -
PUT：替换指定 OpenShiftAPIServer 的状态
-
22.2.1. /apis/operator.openshift.io/v1/openshiftapiservers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 OpenShiftAPIServer 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 OpenShiftAPIServer 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 OpenShiftAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
22.2.2. /apis/operator.openshift.io/v1/openshiftapiservers/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OpenShiftAPIServer 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- delete an OpenShiftAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 OpenShiftAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 OpenShiftAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 OpenShiftAPIServer
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
22.2.3. /apis/operator.openshift.io/v1/openshiftapiservers/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OpenShiftAPIServer 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 OpenShiftAPIServer 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 OpenShiftAPIServer 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 OpenShiftAPIServer 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 23 章 OpenShiftControllerManager [operator.openshift.io/v1]
- 描述
- OpenShiftControllerManager 提供配置操作器以管理 openshift-controller-manager 的信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
23.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 | |
|
|
| |
|
|
|
23.1.1. .spec
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
23.1.2. .status
- 描述
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
23.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
23.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
23.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
23.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
23.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/openshiftcontrollermanagers-
DELETE: 删除 OpenShiftControllerManager 集合 -
GET: 列出类型为 OpenShiftControllerManager 的对象 -
POST：创建 OpenShiftControllerManager
-
/apis/operator.openshift.io/v1/openshiftcontrollermanagers/{name}-
DELETE：删除 OpenShiftControllerManager -
GET：读取指定的 OpenShiftControllerManager -
PATCH: 部分更新指定的 OpenShiftControllerManager -
PUT：替换指定的 OpenShiftControllerManager
-
/apis/operator.openshift.io/v1/openshiftcontrollermanagers/{name}/status-
GET：指定 OpenShiftControllerManager 的读取状态 -
PATCH: 部分更新指定 OpenShiftControllerManager 的状态 -
PUT：替换指定 OpenShiftControllerManager 的状态
-
23.2.1. /apis/operator.openshift.io/v1/openshiftcontrollermanagers
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 OpenShiftControllerManager 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 OpenShiftControllerManager 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- create an OpenShiftControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
23.2.2. /apis/operator.openshift.io/v1/openshiftcontrollermanagers/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OpenShiftControllerManager 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 OpenShiftControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 OpenShiftControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 OpenShiftControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 OpenShiftControllerManager
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
23.2.3. /apis/operator.openshift.io/v1/openshiftcontrollermanagers/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OpenShiftControllerManager 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 OpenShiftControllerManager 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 OpenShiftControllerManager 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 OpenShiftControllerManager 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空 |
第 24 章 OperatorPKI [network.operator.openshift.io/v1]
- 描述
- OperatorPKI 是一个简单的证书颁发机构。它不适用于外部使用 - 相反，它是网络操作器的内部。CNO 创建一个 CA 和由该 CA 签名的证书。证书同时启用了 ClientAuth 和 ServerAuth 扩展使用。更具体地说，如果一个 OperatorPKI 带有 <name>，则 CNO 将管理： - 名为 <name>-ca 的 Secret，带有两个数据键： - tls.key - 私钥 - tls.crt - 一个名为 <name>-ca 的 ConfigMap，带有单个数据键： - cabundle.crt - CA 证书(s)- CA 证书名为 <name>-cert，它有两个数据键： - tls.key - private key - tls.crt, certificate, tls.crt, certificate CA 证书签名的有效期为 10 年，在 9 后轮转。目标证书的有效期为 6 个月，在 3 后轮转，CA 证书将有一个 CommonName 为 "<namespace>_<name>-ca@<timestamp>"，其中 <timestamp> 是最后一次轮转时间。
- 类型
-
object - 必填
-
spec
-
24.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 | |
|
|
| OperatorPKISpec 是 PKI 配置。 |
|
|
| OperatorPKIStatus 未实现。 |
24.1.1. .spec
- 描述
- OperatorPKISpec 是 PKI 配置。
- 类型
-
object - 必填
-
targetCert
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| targetCert 配置 CA 签名的证书。它将同时启用 ClientAuth 和 ServerAuth |
24.1.2. .spec.targetCert
- 描述
- targetCert 配置 CA 签名的证书。它将同时启用 ClientAuth 和 ServerAuth
- 类型
-
object - 必填
-
commonName
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| commonName 是证书的 CN 中的值 |
24.1.3. .status
- 描述
- OperatorPKIStatus 未实现。
- 类型
-
object
24.2. API 端点
可用的 API 端点如下：
/apis/network.operator.openshift.io/v1/operatorpkis-
GET: 列出类型为 OperatorPKI 的对象
-
/apis/network.operator.openshift.io/v1/namespaces/{namespace}/operatorpkis-
DELETE: 删除 OperatorPKI 集合 -
GET: 列出类型为 OperatorPKI 的对象 -
POST：创建 OperatorPKI
-
/apis/network.operator.openshift.io/v1/namespaces/{namespace}/operatorpkis/{name}-
DELETE：删除 OperatorPKI -
GET：读取指定的 OperatorPKI -
PATCH: 部分更新指定的 OperatorPKI -
PUT：替换指定的 OperatorPKI
-
24.2.1. /apis/network.operator.openshift.io/v1/operatorpkis
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出 OperatorPKI 类型的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
24.2.2. /apis/network.operator.openshift.io/v1/namespaces/{namespace}/operatorpkis
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 OperatorPKI 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 OperatorPKI 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 OperatorPKI
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
24.2.3. /apis/network.operator.openshift.io/v1/namespaces/{namespace}/operatorpkis/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| OperatorPKI 的名称 |
|
|
| 对象名称和身份验证范围，如团队（team）和项目（project） |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 OperatorPKI
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 阅读指定的 OperatorPKI
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 OperatorPKI
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 OperatorPKI
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 25 章 ServiceCA [operator.openshift.io/v1]
- 描述
- ServiceCA 提供配置 Operator 以管理服务证书控制器兼容性级别 1 的信息：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
25.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 | |
|
|
| spec 包含用于配置的用户可设置值 |
|
|
| status 包含从集群中观察到的值。它们可能无法被覆盖。 |
25.1.1. .spec
- 描述
- spec 包含用于配置的用户可设置值
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
25.1.2. .status
- 描述
- status 包含从集群中观察到的值。它们可能无法被覆盖。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
25.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
25.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
25.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
25.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
25.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/servicecas-
DELETE：删除 ServiceCA 集合 -
GET: 列出类型为 ServiceCA 的对象 -
POST：创建 ServiceCA
-
/apis/operator.openshift.io/v1/servicecas/{name}-
DELETE：删除 ServiceCA -
GET：读取指定的 ServiceCA -
PATCH: 部分更新指定的 ServiceCA -
PUT：替换指定的 ServiceCA
-
/apis/operator.openshift.io/v1/servicecas/{name}/status-
GET：指定 ServiceCA 的读取状态 -
PATCH: 部分更新指定 ServiceCA 的状态 -
PUT：替换指定 ServiceCA 的状态
-
25.2.1. /apis/operator.openshift.io/v1/servicecas
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ServiceCA 集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出类型为 ServiceCA 的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建 ServiceCA
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
25.2.2. /apis/operator.openshift.io/v1/servicecas/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ServiceCA 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除 ServiceCA
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的 ServiceCA
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的 ServiceCA
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的 ServiceCA
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
25.2.3. /apis/operator.openshift.io/v1/servicecas/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| ServiceCA 的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定 ServiceCA 的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定 ServiceCA 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定 ServiceCA 的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
第 26 章 Storage [operator.openshift.io/v1]
- 描述
-
存储提供了配置操作器以管理集群存储操作器的方法。
Cluster是规范名称。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。 - 类型
-
object - 必填
-
spec
-
26.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 | |
|
|
| spec 包含用于配置的用户可设置值 |
|
|
| status 包含从集群中观察到的值。它们可能无法被覆盖。 |
26.1.1. .spec
- 描述
- spec 包含用于配置的用户可设置值
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Loglevel 是整个组件的意图型日志记录。它无法提供精细的控制，但管理操作员必须针对其操作对象解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
|
| managementState 指明 Operator 是否应该管理组件 |
|
| `` | observedConfig 包含一个从集群状态观察到的稀疏配置。它存在于 spec 中，因为它是 Operator 的级别输入 |
|
|
| operatorLogLevel 是 Operator 本身的意图日志。它无法提供精细的控制，但管理操作员必须自行解释的粗粒度日志记录选择是一个简单的方法。有效值为："Normal", "Debug", "Trace", "TraceAll"。默认值为 "Normal"。 |
|
| `` | unsupportedConfigOverrides 包含稀疏配置，它将覆盖任何之前设置的选项。它只需要是覆盖字段才能按照以下顺序进行覆盖：1.硬编码默认值 2. observedConfig 3. unsupportedConfigOverrides |
|
|
| VSphereStorageDriver 表示在 VSphere 集群中使用的存储驱动程序。当此字段设置为 CSIWithMigrationDriver 后，它不能被更改。如果这是空的，则平台将会选择一个很好的默认值，该默认值可能会随时间推移而变化，而不另行通知。当前默认为 LegacyDeprecatedInTreeDriver。DEPRECATED ：此字段将在以后的版本中删除。 |
26.1.2. .status
- 描述
- status 包含从集群中观察到的值。它们可能无法被覆盖。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| conditions 是条件及其状态列表 |
|
|
| OperatorCondition 只是标准条件字段。 |
|
|
| 生成用于确定项目是否需要协调或更改是否需要反应。 |
|
|
| GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。 |
|
|
| observedGeneration 是您处理的最后生成更改 |
|
|
| readyReplicas 表示有多少副本就绪并处于所需的状态 |
|
|
| 版本是此可用性适用的级别 |
26.1.3. .status.conditions
- 描述
- conditions 是条件及其状态列表
- 类型
-
array
26.1.4. .status.conditions[]
- 描述
- OperatorCondition 只是标准条件字段。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
26.1.5. .status.generations
- 描述
- 生成用于确定项目是否需要协调或更改是否需要反应。
- 类型
-
array
26.1.6. .status.generations[]
- 描述
- GenerationStatus 追踪给定资源的生成，以便可以对强制更新的决策进行。
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组是您要跟踪的内容组 |
|
|
| hash 是为没有生成的情况下为资源设置的可选字段，它们是敏感内容，如 secret 和 configmaps |
|
|
| lastGeneration 是涉及的工作负载控制器的最后生成 |
|
|
| name 是您要跟踪的内容的名称 |
|
|
| 命名空间(namespace)是您要跟踪的事情 |
|
|
| 资源是您要跟踪的资源类型 |
26.2. API 端点
可用的 API 端点如下：
/apis/operator.openshift.io/v1/storages-
DELETE：删除存储集合 -
GET: 列出存储类型的对象 -
POST：创建存储
-
/apis/operator.openshift.io/v1/storages/{name}-
DELETE：删除存储 -
GET：读取指定的存储 -
PATCH: 部分更新指定的存储 -
PUT：替换指定的存储
-
/apis/operator.openshift.io/v1/storages/{name}/status-
GET：指定存储的读取状态 -
PATCH: 部分更新指定存储的状态 -
PUT：替换指定存储的状态
-
26.2.1. /apis/operator.openshift.io/v1/storages
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除存储集合
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 列出 Storage 类型的对象
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。 当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。 |
|
|
| 一个选择器，用于限制其字段返回的对象列表。默认为任何内容。 |
|
|
| 一个选择器，用于限制其标签返回的对象列表。默认为任何内容。 |
|
|
|
limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。 |
|
|
| 观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
POST - 描述
- 创建存储
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
26.2.2. /apis/operator.openshift.io/v1/storages/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 存储的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
DELETE - 描述
- 删除存储
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| 应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。 |
|
|
| 弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。 |
|
|
| 是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
GET - 描述
- 读取指定的存储
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定的存储
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定的存储
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
26.2.3. /apis/operator.openshift.io/v1/storages/{name}/status
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 存储的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 指定存储的读取状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH - 描述
- 部分更新指定存储的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空 |
- HTTP 方法
-
PUT - 描述
- 替换指定存储的状态
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
|
fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空 |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
