配置 API

OpenShift Container Platform 4.12

配置 API 的参考指南

Red Hat OpenShift Documentation Team

法律通告

摘要

本文档描述了 OpenShift Container Platform 配置 API 对象及其详细规格。

第 1 章配置 API
复制链接

1.1. APIServer [config.openshift.io/v1]
复制链接

描述: apiserver 包含系统中所有 API 服务器共享的配置（如服务证书、客户端 CA 和 CORS 域），特别是 kube-apiserver 和 openshift-apiserver。实例的规范名称为 'cluster'。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.2. Authentication [config.openshift.io/v1]
复制链接

描述: 身份验证指定了集群范围的身份验证设置（如 OAuth 和 webhook 令牌验证器）。实例的规范名称 为集群。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.3. Build [config.openshift.io/v1]
复制链接

描述: build 配置整个集群的 OpenShift 构建的行为。这包括可在 BuildConfig 对象中覆盖的默认设置，以及应用到所有构建的覆盖。规范名称是"集群"兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.4. ClusterOperator [config.openshift.io/v1]
复制链接

描述: ClusterOperator 是存放 Operator 当前状态的自定义资源对象。Operator 使用这个对象将其状态传递给集群的其余部分。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.5. ClusterVersion [config.openshift.io/v1]
复制链接

描述: ClusterVersion 是 ClusterVersionOperator 的配置。这是可以设置与自动更新相关的参数的位置。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.6. Console [config.openshift.io/v1]
复制链接

描述: 控制台包含 web 控制台的集群范围配置，包括注销 URL，并报告控制台的公共 URL。规范名称 为集群。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.7. DNS [config.openshift.io/v1]
复制链接

描述: DNS 包含有关 DNS 的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.8. FeatureGate [config.openshift.io/v1]
复制链接

描述: 特性包含有关功能门的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.9. HelmChartRepository [helm.openshift.io/v1beta1]
复制链接

描述: HelmChartRepository 包含用于代理 Helm Chart 仓库兼容性 2 的集群范围配置：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.10. Image [config.openshift.io/v1]
复制链接

描述: 镜像管理与外部 registry 的镜像流导入和运行时配置相关的策略。它允许集群管理员配置允许哪些 registry OpenShift 从哪些 registry 中导入镜像、外部 registry 的额外 CA 信任捆绑包，以及阻止或允许 registry 主机名的策略。将 OpenShift 的镜像 registry 公开给公共时，这也允许集群管理员指定外部主机名。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.11. ImageContentPolicy [config.openshift.io/v1]
复制链接

描述: ImageContentPolicy 包含有关如何处理 registry 镜像规则的集群范围信息。定义了多个策略时，会在每个字段中定义行为的结果。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.12. Infrastructure [config.openshift.io/v1]
复制链接

描述: 基础架构包含有关基础架构的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.13. Ingress [config.openshift.io/v1]
复制链接

描述: Ingress 包含有关 ingress 的集群范围信息，包括用于路由的默认入口域。规范名称 为集群。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.14. Network [config.openshift.io/v1]
复制链接

描述: 网络包含有关网络的集群范围信息。规范名称 为集群。它用于配置所需的网络配置，例如：用于服务/pod IP、网络插件等的 IP 地址池。有关配置此资源时的信息，请查看 network.spec。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: object

1.15. Node [config.openshift.io/v1]
复制链接

描述: 节点包含有关节点特定功能的集群范围信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.16. OAuth [config.openshift.io/v1]
复制链接

描述: OAuth 包含有关 OAuth 的集群范围信息。规范名称 为集群。它用于配置集成的 OAuth 服务器。只有在顶层身份验证配置类型设置为 IntegratedOAuth 时，才会满足此配置。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.17. OperatorHub [config.openshift.io/v1]
复制链接

描述: OperatorHub 是 operatorhubs API 的 Schema。它可用于将集群中 OperatorHub 的默认 hub 源的状态从 enabled 改为 disabled，反之亦然。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.18. Project [config.openshift.io/v1]
复制链接

描述: 项目包含有关项目的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
类型: object

1.19. ProjectHelmChartRepository [helm.openshift.io/v1beta1]
复制链接

描述: ProjectHelmChartRepository 包含代理 Helm Chart 仓库兼容性级别 2 的命名空间范围的配置：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.20. Proxy [config.openshift.io/v1]
复制链接

描述: 代理包含有关如何配置集群的默认代理的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

1.21. Scheduler [config.openshift.io/v1]
复制链接

描述: 调度程序包含集群范围的配置信息，以运行 Kubernetes 调度程序并影响其放置决策。此配置的规范名称 为集群。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

第 2 章 APIServer [config.openshift.io/v1]
复制链接

描述

apiserver 包含系统中所有 API 服务器共享的配置（如服务证书、客户端 CA 和 CORS 域），特别是 kube-apiserver 和 openshift-apiserver。实例的规范名称为 'cluster'。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

2.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

2.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`additionalCORSAllowedOrigins`	`数组（字符串）`	additionalCORSAllowedOrigins 列出了额外的、用户定义的正则表达式，描述 API 服务器允许使用 CORS 标头访问的主机。这可能需要从 JavaScript 应用访问 API 和集成的 OAuth 服务器。值是与 Golang 正则表达式语言对应的正则表达式。
`audit`	`对象`	audit 指定审计配置的设置，以应用到集群中的所有 OpenShift 提供的 API 服务器。
`clientCA`	`对象`	clientCA 引用包含签名者的证书捆绑包的 ConfigMap，除了 Operator managed signers 外，还会识别传入的客户端证书。如果这为空，则只有 Operator 管理的签名者有效。您通常只需要拥有自己的 PKI，才能从其中遵守客户端证书时，您必须设置此设置。ConfigMap 必须存在于 openshift-config 命名空间中，并包含以下必填字段： - ConfigMap.Data["ca-bundle.crt"] - CA bundle。
`encryption`	`对象`	加密允许在数据存储层配置资源加密。
`servingCerts`	`对象`	servingCert 是提供安全流量的 TLS 证书信息。如果没有指定，Operator 管理的证书将用于提供安全流量。
`tlsSecurityProfile`	`对象`	tlsSecurityProfile 指定外部公开服务器的 TLS 连接的设置。如果未设置，则选择默认值（可在版本间更改）。请注意，目前只支持 Old、Intermediate 和 Custom 配置集，最大可用的 MinTLSVersions 为 VersionTLS12。

2.1.2. .spec.audit
复制链接

描述: audit 指定审计配置的设置，以应用到集群中的所有 OpenShift 提供的 API 服务器。
类型: object

Expand

属性	类型	描述
`customRules`	`array`	customRules 指定每个组的配置集。如果应用，这些配置集优先于顶级配置集字段。它们是从上到下评估，第一个匹配项适用。
`customRules[]`	`对象`	auditCustomRule 描述了审计配置集的自定义规则，它优先于顶级配置集。
`配置集`	`字符串`	profile 指定所需的顶级审计配置集的名称，以应用到发送到集群中任何 OpenShift 提供的 API 服务器的所有请求(kube-apiserver、openshift-apiserver 和 oauth-apiserver)，除了与一个或多个 customRules 匹配的请求除外。提供了以下配置集： - Default: default policy，它表示 MetaData 级别日志记录，但事件除外，oauthaccesstokens 和 oauthauthorizetokens （在 RequestBody 级别记录）。- WriteRequestBodies: like 'Default'，但日志请求和响应 HTTP 有效负载用于写入请求（创建、更新、补丁）。- AllRequestBodies: like 'WriteRequestBodies', 但是，还会记录读取请求的请求和响应 HTTP 有效负载(get, list)。- None：没有记录任何请求，即使 oauthaccesstokens 和 oauthauthorizetokens。警告：不建议使用 `None` 配置集禁用审计日志记录，除非您完全意识到在对问题进行故障排除时无法记录数据的风险。如果禁用审计日志记录且出现支持情况，您可能需要启用审计日志记录并重现问题，才能正确排除故障。如果未设置，则使用 'Default' 配置集作为默认值。

2.1.3. .spec.audit.customRules
复制链接

描述: customRules 指定每个组的配置集。如果应用，这些配置集优先于顶级配置集字段。它们是从上到下评估，第一个匹配项适用。
类型: array

2.1.4. .spec.audit.customRules[]
复制链接

描述

auditCustomRule 描述了审计配置集的自定义规则，它优先于顶级配置集。

类型

object

必填

group
配置集

Expand

属性	类型	描述
`group`	`字符串`	group 是请求用户必须属于的组名称，才能应用此配置文件。
`配置集`	`字符串`	profile 指定要部署到集群中的所有 OpenShift 提供的 API 服务器所需的审计策略配置的名称。提供了以下配置集： - Default: existing 默认策略。- WriteRequestBodies: like 'Default', logs request and response HTTP payloads for write requests (create, update, patch). - AllRequestBodies: like 'WriteRequestBodies', also logs requests and response HTTP payloads for read requests (get, list). - None: no requests all, all, not even oauthaccesstokens and oauthtokens.tokens.tokens.如果未设置，则使用 'Default' 配置集作为默认值。

clientCA 引用包含签名者的证书捆绑包的 ConfigMap，除了 Operator managed signers 外，还会识别传入的客户端证书。如果这为空，则只有 Operator 管理的签名者有效。您通常只需要拥有自己的 PKI，才能从其中遵守客户端证书时，您必须设置此设置。ConfigMap 必须存在于 openshift-config 命名空间中，并包含以下必填字段： - ConfigMap.Data["ca-bundle.crt"] - CA bundle。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

2.1.6. .spec.encryption
复制链接

描述: 加密允许在数据存储层配置资源加密。
类型: object

Expand

属性	类型	描述
`type`	`字符串`	Type 定义应在数据存储层上加密资源的加密类型。当此字段未设置时（例如，当它被设置为空字符串时），则表示 identity。未设置的行为可以随时间变化。即使默认启用加密，但未设置的含义可能会根据最佳实践中的更改更改为不同的加密类型。启用加密后，平台附带的所有敏感资源都会被加密。这种敏感资源列表可以，随时间推移而变化。当前权威列表为： 1. secrets 2. configmaps 3. routes.route.openshift.io 4. oauthaccesstokens.oauth.openshift.io 5. oauthauthorizetokens.oauth.openshift.io

2.1.7. .spec.servingCerts
复制链接

描述: servingCert 是提供安全流量的 TLS 证书信息。如果没有指定，Operator 管理的证书将用于提供安全流量。
类型: object

Expand

属性	类型	描述
`namedCertificates`	`array`	namedCertificates 引用包含 TLS 证书信息的 secret，用于向特定主机名提供安全流量。如果没有提供命名的证书，或者没有命名的证书与客户端理解的服务器名称匹配，则会使用 defaultServingCertificate。
`namedCertificates[]`	`对象`	APIServerNamedServingCert 将服务器 DNS 名称（由客户端理解）映射到证书。

2.1.8. .spec.servingCerts.namedCertificates
复制链接

描述: namedCertificates 引用包含 TLS 证书信息的 secret，用于向特定主机名提供安全流量。如果没有提供命名的证书，或者没有命名的证书与客户端理解的服务器名称匹配，则会使用 defaultServingCertificate。
类型: array

2.1.9. .spec.servingCerts.namedCertificates[]
复制链接

描述: APIServerNamedServingCert 将服务器 DNS 名称（由客户端理解）映射到证书。
类型: object

Expand

属性	类型	描述
`names`	`数组（字符串）`	name 是应使用此证书提供安全流量的显式 DNS 名称（允许使用通配符）的可选列表。如果没有提供名称，则会从证书中提取隐式名称。通过通配符名称的确切名称。这里定义的显式名称通过提取的隐式名称而定义。
`servingCertificate`	`对象`	servingCertificate 引用一个 kubernetes.io/tls 类型 secret，其中包含用于提供安全流量的 TLS 证书信息。secret 必须存在于 openshift-config 命名空间中，并包含以下必填字段： - Secret.Data["tls.key"] - TLS 私钥。- Secret.Data["tls.crt"] - TLS 证书。

2.1.10. .spec.servingCerts.namedCertificates[].servingCertificate
复制链接

描述

servingCertificate 引用一个 kubernetes.io/tls 类型 secret，其中包含用于提供安全流量的 TLS 证书信息。secret 必须存在于 openshift-config 命名空间中，并包含以下必填字段： - Secret.Data["tls.key"] - TLS 私钥。- Secret.Data["tls.crt"] - TLS 证书。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

2.1.11. .spec.tlsSecurityProfile
复制链接

描述: tlsSecurityProfile 指定外部公开服务器的 TLS 连接的设置。如果未设置，则选择默认值（可在版本间更改）。请注意，目前只支持 Old、Intermediate 和 Custom 配置集，最大可用的 MinTLSVersions 为 VersionTLS12。
类型: object

Expand

属性	类型	描述
`custom`	``	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`	``	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`	``	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.
`old`	``	旧是一个基于以下的 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`	`字符串`	type 是 Old、Intermediate、Modern 或 Custom 之一。自定义提供指定各个 TLS 安全配置集参数的功能。旧，Intermediate 和 Modern 是基于 TLS 安全配置集：https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations。配置集基于意图，因此当开发新密码时可能会随时间变化，并且发现现有密码不安全。根据具体哪些密码可用于进程，可以减少列表。请注意，Modern 配置集目前还不被支持，因为它还没有被常见软件库正确采用。

2.1.12. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

2.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/apiservers
- DELETE: 删除 APIServer 集合
- GET: 列出类型为 APIServer 的对象
- POST ：创建 APIServer
/apis/config.openshift.io/v1/apiservers/{name}
- DELETE ：删除 APIServer
- GET ：读取指定的 APIServer
- PATCH: 部分更新指定的 APIServer
- PUT ：替换指定的 APIServer
/apis/config.openshift.io/v1/apiservers/{name}/status
- GET ：指定 APIServer 的读取状态
- PATCH: 部分更新指定 APIServer 的状态
- PUT ：替换指定 APIServer 的状态

2.2.1. /apis/config.openshift.io/v1/apiservers
复制链接

Expand

表 2.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 APIServer 集合

Expand

表 2.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 2.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 kind APIServer 的对象

Expand

表 2.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 2.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`APIServerList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 APIServer

Expand

表 2.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 2.7. 主体参数
参数	类型	描述
`正文（body）`	`APIServer` 模式

Expand

表 2.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`APIServer` 模式
201 - Created	`APIServer` 模式
202 - Accepted	`APIServer` 模式
401 - Unauthorized	空

2.2.2. /apis/config.openshift.io/v1/apiservers/{name}
复制链接

Expand

表 2.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	APIServer 的名称

Expand

表 2.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 APIServer

Expand

表 2.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 2.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 2.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的 APIServer

Expand

表 2.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 2.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`APIServer` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 APIServer

Expand

表 2.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 2.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 2.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`APIServer` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 APIServer

Expand

表 2.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 2.20. 主体参数
参数	类型	描述
`正文（body）`	`APIServer` 模式

Expand

表 2.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`APIServer` 模式
201 - Created	`APIServer` 模式
401 - Unauthorized	空

2.2.3. /apis/config.openshift.io/v1/apiservers/{name}/status
复制链接

Expand

表 2.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	APIServer 的名称

Expand

表 2.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 APIServer 的读取状态

Expand

表 2.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 2.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`APIServer` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 APIServer 的状态

Expand

表 2.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 2.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 2.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`APIServer` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 APIServer 的状态

Expand

表 2.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 2.30. 主体参数
参数	类型	描述
`正文（body）`	`APIServer` 模式

Expand

表 2.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`APIServer` 模式
201 - Created	`APIServer` 模式
401 - Unauthorized	空

第 3 章 Authentication [config.openshift.io/v1]
复制链接

描述

身份验证指定了集群范围的身份验证设置（如 OAuth 和 webhook 令牌验证器）。实例的规范名称 为集群。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

3.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

3.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`oauthMetadata`	`对象`	oauthMetadata 包含外部 OAuth 服务器的 OAuth 2.0 授权服务器元数据的发现端点数据。此发现文档可从其服务位置查看：oc get --raw '/.well-known/oauth-authorization-server' 以了解更多详情，请参阅 IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 if oauthMetadata.name is non-empty，这个值优先于状态中存储的元数据引用。键"oauthMetadata"用于查找数据。如果指定且未找到配置映射或预期的键，则不会提供元数据。如果指定的元数据无效，则不会提供元数据。此配置映射的命名空间是 openshift-config。
`serviceAccountIssuer`	`字符串`	serviceAccountIssuer 是绑定服务帐户令牌签发者的标识符。默认值为 https://kubernetes.default.svc WARNING ：更新此字段不会立即验证带有之前签发者值的所有绑定令牌。相反，在平台选择的时间期间，上一个服务帐户签发者发布的令牌将继续被信任（当前设置为 24h）。这个时间段可能会随时间变化。这允许内部组件转换新的服务帐户签发者，而无需服务中断。
`type`	`字符串`	Type 标识集群受管，使用面向用户的身份验证模式。具体来说，它管理响应登录尝试的组件。默认为 IntegratedOAuth。
`webhookTokenAuthenticator`	`对象`	webhookTokenAuthenticator 配置远程令牌查看器。这些远程身份验证 Webhook 可用于通过 tokenreviews.authentication.k8s.io REST API 验证 bearer 令牌。这需要遵循外部身份验证服务置备的 bearer 令牌。
`webhookTokenAuthenticators`	`array`	webhookTokenAuthenticators 是 DEPRECATED，设置它无效。
`webhookTokenAuthenticators[]`	`对象`	deprecatedWebhookTokenAuthenticator 包含远程令牌验证器所需的配置选项。这与 WebhookTokenAuthenticator 相同，但它在 KubeConfig 字段中缺少 'required' 验证。

3.1.2. .spec.oauthMetadata
复制链接

描述

oauthMetadata 包含外部 OAuth 服务器的 OAuth 2.0 授权服务器元数据的发现端点数据。此发现文档可从其服务位置查看：oc get --raw '/.well-known/oauth-authorization-server' 以了解更多详情，请参阅 IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 if oauthMetadata.name is non-empty，这个值优先于状态中存储的元数据引用。键"oauthMetadata"用于查找数据。如果指定且未找到配置映射或预期的键，则不会提供元数据。如果指定的元数据无效，则不会提供元数据。此配置映射的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

3.1.3. .spec.webhookTokenAuthenticator
复制链接

描述

webhookTokenAuthenticator 配置远程令牌查看器。这些远程身份验证 Webhook 可用于通过 tokenreviews.authentication.k8s.io REST API 验证 bearer 令牌。这需要遵循外部身份验证服务置备的 bearer 令牌。

类型

object

必填

kubeConfig

Expand

属性	类型	描述
`kubeConfig`	`对象`	kubeconfig 引用包含 kube 配置文件数据的 secret，该 secret 描述了如何访问远程 Webhook 服务。所引用 secret 的命名空间是 openshift-config。详情请查看：https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication 键"kubeConfig"用于查找数据。如果没有找到 secret 或预期密钥，则不会使用 Webhook。如果指定的 kube config 数据无效，则 webhook 不会被遵守。

3.1.4. .spec.webhookTokenAuthenticator.kubeConfig
复制链接

描述

kubeconfig 引用包含 kube 配置文件数据的 secret，该 secret 描述了如何访问远程 Webhook 服务。所引用 secret 的命名空间是 openshift-config。详情请查看：https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication 键"kubeConfig"用于查找数据。如果没有找到 secret 或预期密钥，则不会使用 Webhook。如果指定的 kube config 数据无效，则 webhook 不会被遵守。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

3.1.5. .spec.webhookTokenAuthenticators
复制链接

描述: webhookTokenAuthenticators 是 DEPRECATED，设置它无效。
类型: array

3.1.6. .spec.webhookTokenAuthenticators[]
复制链接

描述: deprecatedWebhookTokenAuthenticator 包含远程令牌验证器所需的配置选项。这与 WebhookTokenAuthenticator 相同，但它在 KubeConfig 字段中缺少 'required' 验证。
类型: object

Expand

属性	类型	描述
`kubeConfig`	`对象`	kubeconfig 包含 kube 配置文件数据，它们描述了如何访问远程 Webhook 服务。详情请查看：https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication 键"kubeConfig"用于查找数据。如果没有找到 secret 或预期密钥，则不会使用 Webhook。如果指定的 kube config 数据无效，则 webhook 不会被遵守。此 secret 的命名空间由使用点决定。

3.1.7. .spec.webhookTokenAuthenticators[].kubeConfig
复制链接

描述

kubeconfig 包含 kube 配置文件数据，它们描述了如何访问远程 Webhook 服务。详情请查看：https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication 键"kubeConfig"用于查找数据。如果没有找到 secret 或预期密钥，则不会使用 Webhook。如果指定的 kube config 数据无效，则 webhook 不会被遵守。此 secret 的命名空间由使用点决定。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

3.1.8. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

Expand

属性	类型	描述
`integratedOAuthMetadata`	`对象`	integratedOAuthMetadata 包含用于集群集成 OAuth 服务器的 OAuth 2.0 授权服务器元数据的发现端点数据。此发现文档可从其服务位置查看：oc get --raw '/.well-known/oauth-authorization-server'。如需更多详情，请参阅 IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2，其中包含基于集群状态观察的值。spec.oauthMetadata 中的明确设置的值优先于此字段。如果 authentication spec.type 没有设置为 IntegratedOAuth，则此字段没有意义。键"oauthMetadata"用于查找数据。如果没有找到配置映射或预期的键，则不会提供元数据。如果指定的元数据无效，则不会提供元数据。此配置映射的命名空间是 openshift-config-managed。

3.1.9. .status.integratedOAuthMetadata
复制链接

描述

integratedOAuthMetadata 包含用于集群集成 OAuth 服务器的 OAuth 2.0 授权服务器元数据的发现端点数据。此发现文档可从其服务位置查看：oc get --raw '/.well-known/oauth-authorization-server'。如需更多详情，请参阅 IETF Draft: https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2，其中包含基于集群状态观察的值。spec.oauthMetadata 中的明确设置的值优先于此字段。如果 authentication spec.type 没有设置为 IntegratedOAuth，则此字段没有意义。键"oauthMetadata"用于查找数据。如果没有找到配置映射或预期的键，则不会提供元数据。如果指定的元数据无效，则不会提供元数据。此配置映射的命名空间是 openshift-config-managed。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

3.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/authentications
- DELETE ：删除身份验证的集合
- GET: 列出身份验证类型的对象
- POST ：创建身份验证
/apis/config.openshift.io/v1/authentications/{name}
- DELETE ：删除身份验证
- GET ：读取指定的身份验证
- PATCH: 部分更新指定的身份验证
- PUT ：替换指定的身份验证
/apis/config.openshift.io/v1/authentications/{name}/status
- GET ：指定身份验证的读取状态
- PATCH: 部分更新指定身份验证的状态
- PUT ：替换指定身份验证的状态

3.2.1. /apis/config.openshift.io/v1/authentications
复制链接

Expand

表 3.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除身份验证集合

Expand

表 3.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 3.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出身份验证类型的对象

Expand

表 3.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 3.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`AuthenticationList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建身份验证

Expand

表 3.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 3.7. 主体参数
参数	类型	描述
`正文（body）`	`Authentication` 模式

Expand

表 3.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Authentication` 模式
201 - Created	`Authentication` 模式
202 - Accepted	`Authentication` 模式
401 - Unauthorized	空

3.2.2. /apis/config.openshift.io/v1/authentications/{name}
复制链接

Expand

表 3.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	身份验证的名称

Expand

表 3.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除身份验证

Expand

表 3.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 3.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 3.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的身份验证

Expand

表 3.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 3.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Authentication` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的身份验证

Expand

表 3.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 3.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 3.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Authentication` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的身份验证

Expand

表 3.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 3.20. 主体参数
参数	类型	描述
`正文（body）`	`Authentication` 模式

Expand

表 3.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Authentication` 模式
201 - Created	`Authentication` 模式
401 - Unauthorized	空

3.2.3. /apis/config.openshift.io/v1/authentications/{name}/status
复制链接

Expand

表 3.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	身份验证的名称

Expand

表 3.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定身份验证的读取状态

Expand

表 3.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 3.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Authentication` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定身份验证的状态

Expand

表 3.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 3.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 3.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Authentication` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定身份验证的状态

Expand

表 3.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 3.30. 主体参数
参数	类型	描述
`正文（body）`	`Authentication` 模式

Expand

表 3.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Authentication` 模式
201 - Created	`Authentication` 模式
401 - Unauthorized	空

第 4 章 Build [config.openshift.io/v1]
复制链接

描述

build 配置整个集群的 OpenShift 构建的行为。这包括可在 BuildConfig 对象中覆盖的默认设置，以及应用到所有构建的覆盖。规范名称是"集群"兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

4.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含构建控制器配置的 user-settable 值

4.1.1. .spec
复制链接

描述: spec 包含构建控制器配置的 user-settable 值
类型: object

Expand

属性	类型	描述
`additionalTrustedCA`	`对象`	additionalTrustedCA 是对包含额外 CA 的 ConfigMap 的引用，该 CA 应该信任在构建期间进行镜像推送和拉取。此配置映射的命名空间是 openshift-config。DEPRECATED ：应在 image.config.openshift.io/cluster 上设置镜像拉取(pull)和推送的额外 CA。
`buildDefaults`	`对象`	buildDefaults 控制构建的默认信息
`buildOverrides`	`对象`	buildOverrides 控制构建的覆盖设置

4.1.2. .spec.additionalTrustedCA
复制链接

描述

additionalTrustedCA 是对包含额外 CA 的 ConfigMap 的引用，该 CA 应该信任在构建期间进行镜像推送和拉取。此配置映射的命名空间是 openshift-config。DEPRECATED ：应在 image.config.openshift.io/cluster 上设置镜像拉取(pull)和推送的额外 CA。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

4.1.3. .spec.buildDefaults
复制链接

描述: buildDefaults 控制构建的默认信息
类型: object

Expand

属性	类型	描述
`defaultProxy`	`对象`	defaultProxy 包含所有构建操作的默认代理设置，包括镜像拉取/推送和源下载。通过在构建配置的策略中设置 `HTTP_PROXY`、`HTTPS_PROXY` 和 `NO_PROXY` 环境变量，可以覆盖值。
`env`	`array`	env 是一组默认环境变量，如果构建中不存在指定变量，则会应用到构建
`env[]`	`对象`	EnvVar 代表容器中存在的环境变量。
`gitProxy`	`对象`	gitProxy 仅包含 git 操作的代理设置。如果设置，这将覆盖所有 git 命令的任何代理设置，如 git clone。此处未设置的值将从 DefaultProxy 继承。
`imageLabels`	`array`	imageLabels 是应用到生成的镜像的 docker 标签列表。用户可以通过在其 Build/BuildConfig 中提供名称相同的标签来覆盖默认标签。
`imageLabels[]`	`对象`
`资源`	`对象`	资源定义执行构建的资源要求。

4.1.4. .spec.buildDefaults.defaultProxy
复制链接

描述: defaultProxy 包含所有构建操作的默认代理设置，包括镜像拉取/推送和源下载。通过在构建配置的策略中设置 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY 环境变量，可以覆盖值。
类型: object

Expand

属性	类型	描述
`httpProxy`	`字符串`	httpProxy 是 HTTP 请求的代理 URL。空表示未设置，不会导致 env var。
`httpsProxy`	`字符串`	httpsProxy 是 HTTPS 请求的代理 URL。空表示未设置，不会导致 env var。
`noProxy`	`字符串`	noProxy 是不应使用代理的主机名和/或 CIDR 和/或 IP 的逗号分隔列表。空表示未设置，不会导致 env var。
`readinessEndpoints`	`数组（字符串）`	readinessEndpoints 是用于验证代理的就绪状态的端点列表。
`trustedCA`	`对象`	trustedCA 是对包含 CA 证书捆绑包的 ConfigMap 的引用。trustedCA 字段应当仅由代理验证器使用。验证器负责从所需的键 "ca-bundle.crt" 中读取证书捆绑包，将其与系统默认信任捆绑包合并，并在 "openshift-config-managed" 命名空间中写入名为 "trusted-ca-bundle" 的 ConfigMap 中。希望进行代理连接的客户端必须将 trusted-ca-bundle 用于代理的所有 HTTPS 请求，并将 trusted-ca-bundle 用于非代理 HTTPS 请求。被 trustedCA 引用的 ConfigMap 的命名空间为 "openshift-config"。以下是一个 ConfigMap 示例（在 yaml 中）： apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

4.1.5. .spec.buildDefaults.defaultProxy.trustedCA
复制链接

描述

trustedCA 是对包含 CA 证书捆绑包的 ConfigMap 的引用。trustedCA 字段应当仅由代理验证器使用。验证器负责从所需的键 "ca-bundle.crt" 中读取证书捆绑包，将其与系统默认信任捆绑包合并，并在 "openshift-config-managed" 命名空间中写入名为 "trusted-ca-bundle" 的 ConfigMap 中。希望进行代理连接的客户端必须将 trusted-ca-bundle 用于代理的所有 HTTPS 请求，并将 trusted-ca-bundle 用于非代理 HTTPS 请求。被 trustedCA 引用的 ConfigMap 的命名空间为 "openshift-config"。以下是一个 ConfigMap 示例（在 yaml 中）： apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

4.1.6. .spec.buildDefaults.env
复制链接

描述: env 是一组默认环境变量，如果构建中不存在指定变量，则会应用到构建
类型: array

4.1.7. .spec.buildDefaults.env[]
复制链接

描述

EnvVar 代表容器中存在的环境变量。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	环境变量的名称。必须是 C_IDENTIFIER。
`value`	`字符串`	变量引用 $(VAR_NAME)使用容器中之前定义的环境变量以及任何服务环境变量进行扩展。如果无法解析变量，则输入字符串中的引用将保持不变。双引号被缩减为单个 $，它允许转义 $(VAR_NAME)语法：即 " (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会扩展，无论变量是否存在。默认为 ""。
`valueFrom`	`对象`	环境变量的值的源。如果值不为空，则无法使用。

4.1.8. .spec.buildDefaults.env[].valueFrom
复制链接

描述: 环境变量的值的源。如果值不为空，则无法使用。
类型: object

Expand

属性	类型	描述
`configMapKeyRef`	`对象`	选择 ConfigMap 的键。
`fieldRef`	`对象`	选择 pod 的字段：支持 metadata.name、metadata.namespace、`metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
`resourceFieldRef`	`对象`	选择容器的资源：当前仅支持资源限值和请求(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage)。
`secretKeyRef`	`对象`	在 pod 命名空间中选择 secret 的键

4.1.9. .spec.buildDefaults.env[].valueFrom.configMapKeyRef
复制链接

描述

选择 ConfigMap 的键。

类型

object

必填

key

Expand

属性	类型	描述
`key`	`字符串`	要选择的密钥。
`name`	`字符串`	引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？
`optional`	`布尔值`	指定是否必须定义 ConfigMap 还是其键

4.1.10. .spec.buildDefaults.env[].valueFrom.fieldRef
复制链接

描述

选择 pod 的字段：支持 metadata.name、metadata.namespace、metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

类型

object

必填

fieldPath

Expand

属性	类型	描述
`apiVersion`	`字符串`	模式的版本是按术语编写的 FieldPath，默认为 "v1"。
`fieldPath`	`字符串`	在指定 API 版本中选择的字段路径。

4.1.11. .spec.buildDefaults.env[].valueFrom.resourceFieldRef
复制链接

描述

选择容器的资源：当前仅支持资源限值和请求(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage)。

类型

object

必填

resource

Expand

属性	类型	描述
`containerName`	`字符串`	容器名称：卷需要，对于 env vars是可选的
`divisor`	`integer-or-string`	指定公开资源的输出格式，默认为 "1"
`resource`	`字符串`	必需：要选择的资源

4.1.12. .spec.buildDefaults.env[].valueFrom.secretKeyRef
复制链接

描述

在 pod 命名空间中选择 secret 的键

类型

object

必填

key

Expand

属性	类型	描述
`key`	`字符串`	要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。
`name`	`字符串`	引用的名称。更多信息： https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: 添加其他有用的字段。apiVersion、kind、uid？
`optional`	`布尔值`	指定是否需要定义 Secret 还是其密钥

4.1.13. .spec.buildDefaults.gitProxy
复制链接

描述: gitProxy 仅包含 git 操作的代理设置。如果设置，这将覆盖所有 git 命令的任何代理设置，如 git clone。此处未设置的值将从 DefaultProxy 继承。
类型: object

Expand

属性	类型	描述
`httpProxy`	`字符串`	httpProxy 是 HTTP 请求的代理 URL。空表示未设置，不会导致 env var。
`httpsProxy`	`字符串`	httpsProxy 是 HTTPS 请求的代理 URL。空表示未设置，不会导致 env var。
`noProxy`	`字符串`	noProxy 是不应使用代理的主机名和/或 CIDR 和/或 IP 的逗号分隔列表。空表示未设置，不会导致 env var。
`readinessEndpoints`	`数组（字符串）`	readinessEndpoints 是用于验证代理的就绪状态的端点列表。
`trustedCA`	`对象`	trustedCA 是对包含 CA 证书捆绑包的 ConfigMap 的引用。trustedCA 字段应当仅由代理验证器使用。验证器负责从所需的键 "ca-bundle.crt" 中读取证书捆绑包，将其与系统默认信任捆绑包合并，并在 "openshift-config-managed" 命名空间中写入名为 "trusted-ca-bundle" 的 ConfigMap 中。希望进行代理连接的客户端必须将 trusted-ca-bundle 用于代理的所有 HTTPS 请求，并将 trusted-ca-bundle 用于非代理 HTTPS 请求。被 trustedCA 引用的 ConfigMap 的命名空间为 "openshift-config"。以下是一个 ConfigMap 示例（在 yaml 中）： apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

4.1.14. .spec.buildDefaults.gitProxy.trustedCA
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

4.1.15. .spec.buildDefaults.imageLabels
复制链接

描述: imageLabels 是应用到生成的镜像的 docker 标签列表。用户可以通过在其 Build/BuildConfig 中提供名称相同的标签来覆盖默认标签。
类型: array

4.1.16. .spec.buildDefaults.imageLabels[]
复制链接

描述
类型: object

Expand

属性	类型	描述
`name`	`字符串`	name 定义标签的名称。它必须具有非零长度。
`value`	`字符串`	value 定义标签的字面值。

4.1.17. .spec.buildDefaults.resources
复制链接

描述: 资源定义执行构建的资源要求。
类型: object

Expand

属性	类型	描述
`limits`	`integer-or-string`	限制描述了允许的最大计算资源量。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
`requests`	`integer-or-string`	Requests 描述了所需的最少计算资源。如果容器省略了 Requests，则默认为 Limits （如果明确指定），否则默认为实现定义的值。更多信息： https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

4.1.18. .spec.buildOverrides
复制链接

描述: buildOverrides 控制构建的覆盖设置
类型: object

Expand

属性	类型	描述
`forcePull`	`布尔值`	forcePull 覆盖（如果设置了）构建中的等效值，即 false 会禁用对所有构建的强制拉取，true 会独立于每个构建指定其自身的强制拉取
`imageLabels`	`array`	imageLabels 是应用到生成的镜像的 docker 标签列表。如果用户在其 Build/BuildConfig 中提供了与此列表中名称相同的标签，则用户的标签将被覆盖。
`imageLabels[]`	`对象`
`nodeSelector`	`对象（字符串）`	nodeSelector 是一个选择器，必须为 true 才能使构建 pod 适合节点
`容限（tolerations）`	`array`	tolerations (toleration)是一个 Tolerations 列表，它将覆盖构建 pod 上任何现有的容限集。
`tolerations[]`	`对象`	此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。

4.1.19. .spec.buildOverrides.imageLabels
复制链接

描述: imageLabels 是应用到生成的镜像的 docker 标签列表。如果用户在其 Build/BuildConfig 中提供了与此列表中名称相同的标签，则用户的标签将被覆盖。
类型: array

4.1.20. .spec.buildOverrides.imageLabels[]
复制链接

描述
类型: object

Expand

属性	类型	描述
`name`	`字符串`	name 定义标签的名称。它必须具有非零长度。
`value`	`字符串`	value 定义标签的字面值。

4.1.21. .spec.buildOverrides.tolerations
复制链接

描述: tolerations (toleration)是一个 Tolerations 列表，它将覆盖构建 pod 上任何现有的容限集。
类型: array

4.1.22. .spec.buildOverrides.tolerations[]
复制链接

描述: 此 Toleration 附加到 pod，以使用匹配的 operator <operator> 容许与 triple <key,value,effect> 匹配的任何污点。
类型: object

Expand

属性	类型	描述
`effect`	`字符串`	effect 表示要匹配的污点效果。空意味着匹配所有污点效果。指定后，允许的值为 NoSchedule，PreferNoSchedule 和 NoExecute。
`key`	`字符串`	key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空，则必须存在运算符；组合意味着匹配所有值和所有键。
`operator`	`字符串`	Operator 代表键与值的关系。有效的运算符是 Exists 和 Equal。默认值为 Equal。exists 等同于值的通配符，以便 pod 可以容忍特定类别的所有污点。
`tolerationSeconds`	`整数`	tolerationSeconds 代表容限的期间（必须生效 NoExecute，否则此字段将被忽略）可以容忍污点。默认情况下，它不会被设置，这意味着容许任何污点（不要驱除）。零值和负值将被视为 0 （立即删除）。
`value`	`字符串`	value 是容限匹配的污点值。如果运算符是 Exists，则该值应该为空，否则仅是一个常规字符串。

4.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/builds
- DELETE: 删除构建集合
- GET: 列出类型为 Build 的对象
- POST ：创建构建
/apis/config.openshift.io/v1/builds/{name}
- DELETE ：删除构建
- GET ：读取指定的构建
- PATCH: 部分更新指定的构建
- PUT ：替换指定的构建
/apis/config.openshift.io/v1/builds/{name}/status
- GET ：指定构建的读取状态
- PATCH: 部分更新指定构建的状态
- PUT ：替换指定构建的状态

4.2.1. /apis/config.openshift.io/v1/builds
复制链接

Expand

表 4.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除构建集合

Expand

表 4.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 4.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 Build 类型的对象

Expand

表 4.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 4.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`BuildList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建构建

Expand

表 4.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 4.7. 主体参数
参数	类型	描述
`正文（body）`	`Build` 模式

Expand

表 4.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Build` 模式
201 - Created	`Build` 模式
202 - Accepted	`Build` 模式
401 - Unauthorized	空

4.2.2. /apis/config.openshift.io/v1/builds/{name}
复制链接

Expand

表 4.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	构建的名称

Expand

表 4.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除构建

Expand

表 4.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 4.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 4.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的构建

Expand

表 4.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 4.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Build` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的构建

Expand

表 4.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 4.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 4.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Build` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的构建

Expand

表 4.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 4.20. 主体参数
参数	类型	描述
`正文（body）`	`Build` 模式

Expand

表 4.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Build` 模式
201 - Created	`Build` 模式
401 - Unauthorized	空

4.2.3. /apis/config.openshift.io/v1/builds/{name}/status
复制链接

Expand

表 4.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	构建的名称

Expand

表 4.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定构建的读取状态

Expand

表 4.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 4.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Build` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 指定构建的部分更新状态

Expand

表 4.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 4.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 4.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Build` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定构建的状态

Expand

表 4.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 4.30. 主体参数
参数	类型	描述
`正文（body）`	`Build` 模式

Expand

表 4.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Build` 模式
201 - Created	`Build` 模式
401 - Unauthorized	空

第 5 章 ClusterOperator [config.openshift.io/v1]
复制链接

描述

ClusterOperator 是存放 Operator 当前状态的自定义资源对象。Operator 使用这个对象将其状态传递给集群的其余部分。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

5.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含可应用于任何 Operator 的配置。
`status`	`对象`	status 包含有关 Operator 状态的信息。它与 Kubernetes 生态系统中的状态信息一致。

5.1.1. .spec
复制链接

描述: spec 包含可应用于任何 Operator 的配置。
类型: 对象

5.1.2. .status
复制链接

描述: status 包含有关 Operator 状态的信息。它与 Kubernetes 生态系统中的状态信息一致。
类型: object

Expand

属性	类型	描述
`conditions`	`array`	conditions 描述了 Operator 的受管和监控组件的状态。
`conditions[]`	`对象`	ClusterOperatorStatusCondition 代表 Operator 的受管和监控组件的状态。
`extension`	``	extension 包含特定于拥有此状态对象的 Operator 的额外状态信息。
`relatedObjects`	`array`	relatedObjects 是"中间"或与此操作器相关的对象列表。常见用途有：1。导致 operator 2. operator 命名空间 3. operand 命名空间的详细资源
`relatedObjects[]`	`对象`	ObjectReference 包含足够信息供您检查或修改引用的对象。
`版本`	`array`	versions 是 operator 和操作对象版本元组的一个片段。管理多个操作对象的 Operator 将在阵列中有多个操作对象条目。可用的 Operator 必须使用名称 "operator" 报告 Operator 本身的版本。当 Operator 将新版本应用到所有操作对象时，Operator 会报告一个新的 "operator" 版本。
`versions[]`	`对象`

5.1.3. .status.conditions
复制链接

描述: conditions 描述了 Operator 的受管和监控组件的状态。
类型: array

5.1.4. .status.conditions[]
复制链接

描述

ClusterOperatorStatusCondition 代表 Operator 的受管和监控组件的状态。

类型

object

必填

lastTransitionTime
status
type

Expand

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是当前 status 属性最后一次更新的时间。
`message`	`字符串`	Message 提供有关当前条件的附加信息。这只能被人类使用。它可以包含行 Feed 字符(U+000A)，该字符应作为新行呈现。
`reason`	`字符串`	reason 是条件当前状态的 CamelCase 原因。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	Type 指定此条件报告的方面。

5.1.5. .status.relatedObjects
复制链接

描述: relatedObjects 是"中间"或与此操作器相关的对象列表。常见用途有：1。导致 operator 2. operator 命名空间 3. operand 命名空间的详细资源
类型: array

5.1.6. .status.relatedObjects[]
复制链接

描述

ObjectReference 包含足够信息供您检查或修改引用的对象。

类型

object

必填

group
name
resource

Expand

属性	类型	描述
`group`	`字符串`	引用的组。
`name`	`字符串`	引用的名称。
`namespace`	`字符串`	引用的命名空间。
`resource`	`字符串`	引用的资源。

5.1.7. .status.versions
复制链接

描述: versions 是 operator 和操作对象版本元组的一个片段。管理多个操作对象的 Operator 将在阵列中有多个操作对象条目。可用的 Operator 必须使用名称 "operator" 报告 Operator 本身的版本。当 Operator 将新版本应用到所有操作对象时，Operator 会报告一个新的 "operator" 版本。
类型: array

5.1.8. .status.versions[]
复制链接

描述

类型

object

必填

name
version

Expand

属性	类型	描述
`name`	`字符串`	name 是此版本针对的特定操作对象的名称。它通常与容器镜像而不是运算符匹配。
`version`	`字符串`	version 表示当前管理的特定操作对象的版本。它必须始终与 Available 操作对象匹配。如果 1.0.0 为 Available，则必须指示 1.0.0，即使 Operator 正在尝试推出部署 1.1.0

5.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/clusteroperators
- DELETE ：删除 ClusterOperator 集合
- GET: 列出 ClusterOperator 类型的对象
- POST ：创建 ClusterOperator
/apis/config.openshift.io/v1/clusteroperators/{name}
- DELETE ：删除 ClusterOperator
- GET ：读取指定的 ClusterOperator
- PATCH: 部分更新指定的 ClusterOperator
- PUT ：替换指定的 ClusterOperator
/apis/config.openshift.io/v1/clusteroperators/{name}/status
- GET ：指定 ClusterOperator 的读取状态
- PATCH: 部分更新指定 ClusterOperator 的状态
- PUT ：替换指定 ClusterOperator 的状态

5.2.1. /apis/config.openshift.io/v1/clusteroperators
复制链接

Expand

表 5.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ClusterOperator 集合

Expand

表 5.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 5.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 ClusterOperator 类型的对象

Expand

表 5.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 5.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterOperatorList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ClusterOperator

Expand

表 5.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 5.7. 主体参数
参数	类型	描述
`正文（body）`	`ClusterOperator` 模式

Expand

表 5.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterOperator` 模式
201 - Created	`ClusterOperator` 模式
202 - Accepted	`ClusterOperator` 模式
401 - Unauthorized	空

5.2.2. /apis/config.openshift.io/v1/clusteroperators/{name}
复制链接

Expand

表 5.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	ClusterOperator 的名称

Expand

表 5.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ClusterOperator

Expand

表 5.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 5.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 5.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ClusterOperator

Expand

表 5.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 5.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterOperator` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 ClusterOperator

Expand

表 5.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 5.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 5.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterOperator` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 ClusterOperator

Expand

表 5.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 5.20. 主体参数
参数	类型	描述
`正文（body）`	`ClusterOperator` 模式

Expand

表 5.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterOperator` 模式
201 - Created	`ClusterOperator` 模式
401 - Unauthorized	空

5.2.3. /apis/config.openshift.io/v1/clusteroperators/{name}/status
复制链接

Expand

表 5.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	ClusterOperator 的名称

Expand

表 5.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 ClusterOperator 的读取状态

Expand

表 5.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 5.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterOperator` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 ClusterOperator 的状态

Expand

表 5.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 5.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 5.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterOperator` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 ClusterOperator 的状态

Expand

表 5.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 5.30. 主体参数
参数	类型	描述
`正文（body）`	`ClusterOperator` 模式

Expand

表 5.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterOperator` 模式
201 - Created	`ClusterOperator` 模式
401 - Unauthorized	空

第 6 章 ClusterVersion [config.openshift.io/v1]
复制链接

描述

ClusterVersion 是 ClusterVersionOperator 的配置。这是可以设置与自动更新相关的参数的位置。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

6.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 是集群版本的所需状态 - Operator 可以正常工作，以确保将所需的版本应用到集群。
`status`	`对象`	status 包含有关可用更新以及任何 in-progress 更新的信息。

6.1.1. .spec
复制链接

描述

spec 是集群版本的所需状态 - Operator 可以正常工作，以确保将所需的版本应用到集群。

类型

object

必填

clusterID

Expand

属性	类型	描述
`功能`	`object`	capabilities 配置可选的、核心集群组件的安装。这里的 null 值与空对象相同；请参阅子属性以了解默认语义。
`channel`	`字符串`	频道是明确请求一组非默认更新集的标识符。默认频道将包含适合生产集群的稳定更新。
`clusterID`	`字符串`	clusterid 唯一标识此集群。这应该是一个 RFC4122 UUID 值(xxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx)。这是必填字段。
`desiredUpdate`	`对象`	desiredUpdate 是一个可选字段，表示集群版本所需的值。设置此值将触发升级（如果当前版本与所需的版本不匹配）。推荐的更新值集合作为 status 中的可用更新的一部分，设置超出该范围的值可能会导致升级失败。如果在 availableUpdates 或 history 中存在该版本，您可以指定 version 字段而不设置镜像。如果升级失败，Operator 将停止并报告失败组件的状态。将所需的更新值设置为以前的版本会导致尝试回滚。并非所有回滚都将成功。
`overrides`	`array`	overrides 是由集群版本操作器管理的组件覆盖列表。标记组件非受管状态将阻止 Operator 创建或更新对象。
`overrides[]`	`对象`	ComponentOverride 允许覆盖组件的集群版本 Operator 的行为。
`upstream`	`字符串`	upstream 可以用来指定首选的更新服务器。默认情况下，它将对集群和地区使用适当的更新服务器。

6.1.2. .spec.capabilities
复制链接

描述: capabilities 配置可选的、核心集群组件的安装。这里的 null 值与空对象相同；请参阅子属性以了解默认语义。
类型: object

Expand

属性	类型	描述
`additionalEnabledCapabilities`	`数组（字符串）`	additionalEnabledCapabilities 扩展一组受管功能超过 baselineCapabilitySet 中定义的基准。默认值为空集。
`baselineCapabilitySet`	`string`	baselineCapabilitySet 选择要启用的一组初始可选功能，这可以通过 additionalEnabledCapabilities 扩展。如果未设置，集群将选择一个默认值，默认可能会随时间改变。当前默认为 vCurrent。

6.1.3. .spec.desiredUpdate
复制链接

描述: desiredUpdate 是一个可选字段，表示集群版本所需的值。设置此值将触发升级（如果当前版本与所需的版本不匹配）。推荐的更新值集合作为 status 中的可用更新的一部分，设置超出该范围的值可能会导致升级失败。如果在 availableUpdates 或 history 中存在该版本，您可以指定 version 字段而不设置镜像。如果升级失败，Operator 将停止并报告失败组件的状态。将所需的更新值设置为以前的版本会导致尝试回滚。并非所有回滚都将成功。
类型: object

Expand

属性	类型	描述
`force`	`布尔值`	force 允许管理员更新到一个已验证或可升级检查的镜像。只有在验证了带外的镜像的真实性时才应使用此选项，因为提供的镜像将使用集群的完全管理访问权限运行。不要将此标志与来自未知或潜在恶意源的镜像一起使用。
`image`	`字符串`	image 是包含更新的容器镜像位置。当此字段是 spec 的一部分时，如果指定了 version，并且 availableUpdates 字段包含匹配的版本，则 image 是可选的。
`version`	`字符串`	Version 是识别更新版本的语义版本。当此字段是 spec 的一部分时，如果指定了 image，则 version 是可选的。

6.1.4. .spec.overrides
复制链接

描述: overrides 是由集群版本操作器管理的组件覆盖列表。标记组件非受管状态将阻止 Operator 创建或更新对象。
类型: array

6.1.5. .spec.overrides[]
复制链接

描述

ComponentOverride 允许覆盖组件的集群版本 Operator 的行为。

类型

object

必填

group
kind
name
namespace
Unmanaged

Expand

属性	类型	描述
`group`	`字符串`	Group 标识 kind 所在 API 组。
`kind`	`字符串`	缩进要覆盖的对象。
`name`	`字符串`	name 是组件的名称。
`namespace`	`字符串`	namespace 是组件的命名空间。如果资源是集群范围，命名空间应该为空。
`Unmanaged`	`布尔值`	非受管控制，如果集群版本操作器是否应该停止管理此集群中的资源。默认：false

6.1.6. .status
复制链接

描述

status 包含有关可用更新以及任何 in-progress 更新的信息。

类型

object

必填

所需
observedGeneration
versionHash

Expand

属性	类型	描述
`availableUpdates`	``	availableUpdates 包含为这个集群推荐的更新。条件更新但未在 availableUpdates 中出现的更新可能会将这个集群公开给已知的问题。如果没有更新，或者指定了无效的频道，则此列表可能为空。
`功能`	`object`	capabilities 描述了可选、核心集群组件的状态。
`conditionalUpdates`	`数组`	conditionalUpdates 包含在这个集群满足特定所需条件时可能推荐的更新列表。对实际推荐的更新集感兴趣的消费者，应该使用 availableUpdates。如果没有更新，如果没有更新服务，或者指定了空或无效的频道，则此列表可能为空。
`conditionalUpdates[]`	`object`	ConditionalUpdate 代表一个更新，建议把当前集群上的一些集群协调，但可能不建议在当前集群中使用。
`conditions`	`array`	条件提供有关集群版本的信息。如果达到 desiredUpdate，则条件 "Available" 被设置为 true。如果应用了更新，则条件 "Progressing" 被设置为 true。如果更新当前被临时或永久错误阻止，则条件 "Degraded" 被设置为 true。当 metadata.generation 等于 status.generation 时，条件仅对当前 desiredUpdate 有效。
`conditions[]`	`对象`	ClusterOperatorStatusCondition 代表 Operator 的受管和监控组件的状态。
`所需`	`对象`	所需是集群协调的版本。如果集群尚未完全初始化，则将使用可用的信息来设置，这些信息可能是镜像或标签。
`history`	`array`	history 包含应用到集群的最新版本的列表。这个值在集群启动过程中可能为空，然后在应用新更新时更新。最新更新在列表中的第一个，按 recency 排序。如果完成推出部署，则历史记录中的更新状态为 Completed - 如果更新失败或应用了一半，则状态将为 Partial。只有有限数量的更新历史记录会被保留。
`history[]`	`对象`	UpdateHistory 是对集群的单个尝试更新。
`observedGeneration`	`整数`	observedGeneration 报告正在同步哪个 spec 版本。如果这个值不等于 metadata.generation，则所需的和条件字段可能代表之前的版本。
`versionHash`	`字符串`	versionHash 是集群将要更新的内容的指纹。Operator 使用它来避免不必要的工作，仅用于内部使用。

6.1.7. .status.capabilities
复制链接

描述: capabilities 描述了可选、核心集群组件的状态。
类型: object

Expand

属性	类型	描述
`enabledCapabilities`	`数组（字符串）`	enabledCapabilities 列出了当前管理的所有功能。
`knownCapabilities`	`数组（字符串）`	knownCapabilities 列出当前集群已知的所有功能。

6.1.8. .status.conditionalUpdates
复制链接

描述: conditionalUpdates 包含在这个集群满足特定所需条件时可能推荐的更新列表。对实际推荐的更新集感兴趣的消费者，应该使用 availableUpdates。如果没有更新，如果没有更新服务，或者指定了空或无效的频道，则此列表可能为空。
类型: 数组

6.1.9. .status.conditionalUpdates[]
复制链接

描述

ConditionalUpdate 代表一个更新，建议把当前集群上的一些集群协调，但可能不建议在当前集群中使用。

类型

object

必填

release
risks

Expand

属性	类型	描述
`conditions`	`数组`	条件代表条件更新当前状态的观察。已知类型包括：* 评估，对于 cluster-version operator 是否尝试评估任何风险[].matchingRules。* 建议为当前集群推荐更新。
`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 }
`release`	`object`	Release 是更新的目标。
`risks`	`数组`	风险代表了与升级到目标发行版本相关的问题范围。cluster-version operator 将评估所有条目，只有在至少有一个条目和所有条目都推荐更新时才建议更新。
`risks[]`	`object`	ConditionalUpdateRisk 代表不推荐条件更新的原因和 cluster-state。

6.1.10. .status.conditionalUpdates[].conditions
复制链接

描述: 条件代表条件更新当前状态的观察。已知类型包括：* 评估，对于 cluster-version operator 是否尝试评估任何风险[].matchingRules。* 建议为当前集群推荐更新。
类型: 数组

6.1.11. .status.conditionalUpdates[].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

Expand

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。
`message`	`字符串`	Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。
`observedGeneration`	`整数`	observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。
`reason`	`字符串`	reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)

6.1.12. .status.conditionalUpdates[].release
复制链接

描述: Release 是更新的目标。
类型: object

Expand

属性	类型	描述
`Channels`	`数组（字符串）`	channels 是当前发行版本所属的 Cincinnati 频道集合。
`image`	`字符串`	image 是包含更新的容器镜像位置。当此字段是 spec 的一部分时，如果指定了 version，并且 availableUpdates 字段包含匹配的版本，则 image 是可选的。
`url`	`字符串`	URL 包含有关此版本的信息。此 URL 由发行版本上的 'url' metadata 属性或更新 API 返回的元数据设置，应该以用户界面中的链接的形式显示。对于测试或每日发行版本，无法设置 URL 字段。
`version`	`字符串`	Version 是识别更新版本的语义版本。当此字段是 spec 的一部分时，如果指定了 image，则 version 是可选的。

6.1.13. .status.conditionalUpdates[].risks
复制链接

描述: 风险代表了与升级到目标发行版本相关的问题范围。cluster-version operator 将评估所有条目，只有在至少有一个条目和所有条目都推荐更新时才建议更新。
类型: 数组

6.1.14. .status.conditionalUpdates[].risks[]
复制链接

描述

ConditionalUpdateRisk 代表不推荐条件更新的原因和 cluster-state。

类型

object

必填

matchingRules
message
名称
url

Expand

属性	类型	描述
`matchingRules`	`数组`	matchingRules 是一个条件片段，用于决定哪个集群与风险匹配且不匹配。片段按降低的优先级排序。cluster-version 操作器将按顺序处理片段，并在第一个可以成功评估后停止。如果没有成功评估条件，则不建议更新。
`matchingRules[]`	`object`	clusterCondition 是输入的集群条件的联合。'type' 属性决定特定于类型的属性是相关的。在集群上评估时，条件可以匹配、不匹配或无法评估。
`message`	`string`	Message 提供有关更新风险的附加信息，当匹配的Rules 与集群状态匹配时。这只能被人类使用。它可以包含行 Feed 字符(U+000A)，该字符应作为新行呈现。
`名称`	`string`	name 是不推荐条件更新的 CamelCase 原因，当匹配的Rules 与集群状态匹配时。
`url`	`string`	URL 包含有关此风险的信息。

6.1.15. .status.conditionalUpdates[].risks[].matchingRules
复制链接

描述: matchingRules 是一个条件片段，用于决定哪个集群与风险匹配且不匹配。片段按降低的优先级排序。cluster-version 操作器将按顺序处理片段，并在第一个可以成功评估后停止。如果没有成功评估条件，则不建议更新。
类型: 数组

6.1.16. .status.conditionalUpdates[].risks[].matchingRules[]
复制链接

描述

clusterCondition 是输入的集群条件的联合。'type' 属性决定特定于类型的属性是相关的。在集群上评估时，条件可以匹配、不匹配或无法评估。

类型

object

必填

type

Expand

属性	类型	描述
`promql`	`object`	PromQL 代表基于 PromQL 的集群条件。
`type`	`string`	Type 代表 cluster-condition 类型。这将定义任何其他属性的成员和语义。

6.1.17. .status.conditionalUpdates[].risks[].matchingRules[].promql
复制链接

描述

PromQL 代表基于 PromQL 的集群条件。

类型

object

必填

promql

Expand

属性	类型	描述
`promql`	`string`	PromQL 是一个 PromQL 查询分类集群。此查询应在匹配情况下返回 1，在 does-not-match 情况下返回 0。不返回时间序列的查询，或者返回 0 或 1 以外的值是评估失败。

6.1.18. .status.conditions
复制链接

描述: 条件提供有关集群版本的信息。如果达到 desiredUpdate，则条件 "Available" 被设置为 true。如果应用了更新，则条件 "Progressing" 被设置为 true。如果更新当前被临时或永久错误阻止，则条件 "Degraded" 被设置为 true。当 metadata.generation 等于 status.generation 时，条件仅对当前 desiredUpdate 有效。
类型: array

6.1.19. .status.conditions[]
复制链接

描述

ClusterOperatorStatusCondition 代表 Operator 的受管和监控组件的状态。

类型

object

必填

lastTransitionTime
status
type

Expand

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是当前 status 属性最后一次更新的时间。
`message`	`字符串`	Message 提供有关当前条件的附加信息。这只能被人类使用。它可以包含行 Feed 字符(U+000A)，该字符应作为新行呈现。
`reason`	`字符串`	reason 是条件当前状态的 CamelCase 原因。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	Type 指定此条件报告的方面。

6.1.20. .status.desired
复制链接

描述: 所需是集群协调的版本。如果集群尚未完全初始化，则将使用可用的信息来设置，这些信息可能是镜像或标签。
类型: object

Expand

属性	类型	描述
`Channels`	`数组（字符串）`	channels 是当前发行版本所属的 Cincinnati 频道集合。
`image`	`字符串`	image 是包含更新的容器镜像位置。当此字段是 spec 的一部分时，如果指定了 version，并且 availableUpdates 字段包含匹配的版本，则 image 是可选的。
`url`	`字符串`	URL 包含有关此版本的信息。此 URL 由发行版本上的 'url' metadata 属性或更新 API 返回的元数据设置，应该以用户界面中的链接的形式显示。对于测试或每日发行版本，无法设置 URL 字段。
`version`	`字符串`	Version 是识别更新版本的语义版本。当此字段是 spec 的一部分时，如果指定了 image，则 version 是可选的。

6.1.21. .status.history
复制链接

描述: history 包含应用到集群的最新版本的列表。这个值在集群启动过程中可能为空，然后在应用新更新时更新。最新更新在列表中的第一个，按 recency 排序。如果完成推出部署，则历史记录中的更新状态为 Completed - 如果更新失败或应用了一半，则状态将为 Partial。只有有限数量的更新历史记录会被保留。
类型: array

6.1.22. .status.history[]
复制链接

描述

UpdateHistory 是对集群的单个尝试更新。

类型

object

必填

image
startedTime
state
已验证

Expand

属性	类型	描述
`acceptedRisks`	`string`	acceptedRisks 记录被接受启动更新的风险。例如，它可能会认为一个 Upgradeable=False，或缺少通过 desiredUpdate.force 覆盖的签名，或者没有处于 availableUpdates 组推荐的更新目标。
`completionTime`	``	completionTime （如果设置）是完全应用更新的时间。当前应用的更新将有一个 null completion 时间。总会为不是当前更新的条目设置完成时间（通常是下一次更新的开始时间）。
`image`	`字符串`	image 是包含更新的容器镜像位置。这个值始终会被填充。
`startedTime`	`字符串`	startedTime 是启动更新的时间。
`state`	`字符串`	State 反映了是否完全应用更新。Partial 状态表示更新没有被完全应用，但 Completed 状态表示更新至少一次（更新的所有部分都成功应用）。
`已验证`	`布尔值`	验证指示提供的更新是否在安装前正确验证。如果这是 false，则集群可能无法被信任。验证，在接受更新目标时，未涵盖依赖于集群状态的可升级检查。
`version`	`字符串`	Version 是识别更新版本的语义版本。如果请求的镜像没有定义版本，或者检索镜像失败，则该值可能为空。

6.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/clusterversions
- DELETE: 删除 ClusterVersion 集合
- GET: 列出 ClusterVersion 类型的对象
- POST ：创建 ClusterVersion
/apis/config.openshift.io/v1/clusterversions/{name}
- DELETE ：删除 ClusterVersion
- GET ：读取指定的 ClusterVersion
- PATCH: 部分更新指定的 ClusterVersion
- PUT ：替换指定的 ClusterVersion
/apis/config.openshift.io/v1/clusterversions/{name}/status
- GET ：指定 ClusterVersion 的读取状态
- PATCH: 部分更新指定 ClusterVersion 的状态
- PUT ：替换指定 ClusterVersion 的状态

6.2.1. /apis/config.openshift.io/v1/clusterversions
复制链接

Expand

表 6.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ClusterVersion 集合

Expand

表 6.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 6.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 ClusterVersion 类型的对象

Expand

表 6.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 6.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterVersionList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ClusterVersion

Expand

表 6.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 6.7. 主体参数
参数	类型	描述
`正文（body）`	`ClusterVersion` 模式

Expand

表 6.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterVersion` 模式
201 - Created	`ClusterVersion` 模式
202 - Accepted	`ClusterVersion` 模式
401 - Unauthorized	空

6.2.2. /apis/config.openshift.io/v1/clusterversions/{name}
复制链接

Expand

表 6.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	ClusterVersion 的名称

Expand

表 6.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ClusterVersion

Expand

表 6.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 6.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 6.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ClusterVersion

Expand

表 6.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 6.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterVersion` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 ClusterVersion

Expand

表 6.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 6.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 6.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterVersion` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 ClusterVersion

Expand

表 6.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 6.20. 主体参数
参数	类型	描述
`正文（body）`	`ClusterVersion` 模式

Expand

表 6.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterVersion` 模式
201 - Created	`ClusterVersion` 模式
401 - Unauthorized	空

6.2.3. /apis/config.openshift.io/v1/clusterversions/{name}/status
复制链接

Expand

表 6.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	ClusterVersion 的名称

Expand

表 6.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 ClusterVersion 的读取状态

Expand

表 6.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 6.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterVersion` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 ClusterVersion 的状态

Expand

表 6.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 6.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 6.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterVersion` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 ClusterVersion 的状态

Expand

表 6.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 6.30. 主体参数
参数	类型	描述
`正文（body）`	`ClusterVersion` 模式

Expand

表 6.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ClusterVersion` 模式
201 - Created	`ClusterVersion` 模式
401 - Unauthorized	空

第 7 章 Console [config.openshift.io/v1]
复制链接

描述

控制台包含 web 控制台的集群范围配置，包括注销 URL，并报告控制台的公共 URL。规范名称 为集群。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

7.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

7.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`身份验证`	`对象`	ConsoleAuthentication 定义用于控制台身份验证的可选配置列表。

7.1.2. .spec.authentication
复制链接

描述: ConsoleAuthentication 定义用于控制台身份验证的可选配置列表。
类型: object

Expand

属性	类型	描述
`logoutRedirect`	`字符串`	在注销控制台后，将 Web 浏览器重定向到的可选绝对 URL。如果未指定，它将重定向到默认登录页面。当使用支持单点登录(SSO)的身份提供程序时，如： - OpenID (Keycloak, Azure)- RequestHeader (GSSAPI, SSPI, SAML)- OAuth (GitHub, GitLab, Google) Logging from the console 将销毁用户的令牌。logoutRedirect 为用户提供了通过身份提供程序执行单点登录(SLO)的选项，以销毁其单点登录会话。

7.1.3. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

Expand

属性	类型	描述
`consoleURL`	`字符串`	控制台的 URL。这将来自为控制台创建的路由的主机。

7.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/consoles
- DELETE ：删除控制台集合
- GET: 列出类型为 Console 的对象
- POST ：创建控制台
/apis/config.openshift.io/v1/consoles/{name}
- DELETE ：删除控制台
- GET ：读取指定的控制台
- PATCH: 部分更新指定的控制台
- PUT ：替换指定的控制台
/apis/config.openshift.io/v1/consoles/{name}/status
- GET ：指定控制台的读取状态
- PATCH: 部分更新指定控制台的状态
- PUT ：替换指定控制台的状态

7.2.1. /apis/config.openshift.io/v1/consoles
复制链接

Expand

表 7.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除控制台集合

Expand

表 7.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 7.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出控制台的对象

Expand

表 7.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 7.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ConsoleList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建控制台

Expand

表 7.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 7.7. 主体参数
参数	类型	描述
`正文（body）`	`Console` 模式

Expand

表 7.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Console` 模式
201 - Created	`Console` 模式
202 - Accepted	`Console` 模式
401 - Unauthorized	空

7.2.2. /apis/config.openshift.io/v1/consoles/{name}
复制链接

Expand

表 7.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	控制台名称

Expand

表 7.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除控制台

Expand

表 7.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 7.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 7.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的控制台

Expand

表 7.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 7.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Console` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的控制台

Expand

表 7.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 7.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 7.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Console` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的控制台

Expand

表 7.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 7.20. 主体参数
参数	类型	描述
`正文（body）`	`Console` 模式

Expand

表 7.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Console` 模式
201 - Created	`Console` 模式
401 - Unauthorized	空

7.2.3. /apis/config.openshift.io/v1/consoles/{name}/status
复制链接

Expand

表 7.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	控制台名称

Expand

表 7.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定控制台的读取状态

Expand

表 7.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 7.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Console` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定控制台的状态

Expand

表 7.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 7.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 7.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Console` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定控制台的状态

Expand

表 7.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 7.30. 主体参数
参数	类型	描述
`正文（body）`	`Console` 模式

Expand

表 7.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Console` 模式
201 - Created	`Console` 模式
401 - Unauthorized	空

第 8 章 DNS [config.openshift.io/v1]
复制链接

描述

DNS 包含有关 DNS 的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

8.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

8.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`baseDomain`	`字符串`	baseDomain 是集群的基域。所有管理的 DNS 记录都将是这个基域的子域。例如，给定基域 `openshift.example.com`，可以为 `cluster-api.openshift.example.com` 创建 API 服务器 DNS 记录。设置后，无法更改此字段。
`platform`	`object`	平台包含与 DNS 的底层基础架构供应商相关的配置。如果省略，这意味着用户没有建议，平台会被保留选择合理的默认值。这些默认值可能会随时间变化。
`privateZone`	`对象`	privateZone 是集群内部可用的所有 DNS 记录的位置。如果此字段为 nil，则不应创建私有记录。设置后，无法更改此字段。
`publicZone`	`对象`	publicZone 是互联网公开访问的所有 DNS 记录的位置。如果此字段为 nil，则不应创建公共记录。设置后，无法更改此字段。

8.1.2. .spec.platform
复制链接

描述

平台包含与 DNS 的底层基础架构供应商相关的配置。如果省略，这意味着用户没有建议，平台会被保留选择合理的默认值。这些默认值可能会随时间变化。

类型

object

必填

type

Expand

属性	类型	描述
`aws`	`object`	AWS 包含特定于 Amazon Web Services 云供应商的 DNS 配置。
`type`	`字符串`	type 是集群的底层基础架构供应商。允许的值： "", "AWS"。单个组件可能不支持所有平台，且必须使用最佳容量默认值处理未识别的平台。

8.1.3. .spec.platform.aws
复制链接

描述: AWS 包含特定于 Amazon Web Services 云供应商的 DNS 配置。
类型: object

Expand

属性	类型	描述
`privateZoneIAMRole`	`string`	privateZoneIAMRole 包含 IAM 角色的 ARN，在对集群 DNS 配置中指定的集群私有托管区上执行操作时应该假定该角色。当留空时，不应假定任何角色。

8.1.4. .spec.privateZone
复制链接

描述: privateZone 是集群内部可用的所有 DNS 记录的位置。如果此字段为 nil，则不应创建私有记录。设置后，无法更改此字段。
类型: object

Expand

属性	类型	描述
`id`	`字符串`	`ID` 是可用于查找 DNS 托管区的标识符。在 AWS 区域中，可以使用 ID 作为 [1] 上的 id 来获取，在 Azure 区域中，可以使用 `ID` 作为 pre-termined 名称( [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3])获取 GCP 区域。在 GCP 区域中，可以使用 `ID` 作为预确定的名称来获得。[1]: [1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get
`tags`	`对象（字符串）`	标签可用于查询 AWS 上的 DNS 托管区。在 AWS 上，可以使用 resourcegroupstaggingapi [1] 获取区域，使用 `Tags` 作为 tag-filters, [1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options

8.1.5. .spec.publicZone
复制链接

描述: publicZone 是互联网公开访问的所有 DNS 记录的位置。如果此字段为 nil，则不应创建公共记录。设置后，无法更改此字段。
类型: object

Expand

属性	类型	描述
`id`	`字符串`	`ID` 是可用于查找 DNS 托管区的标识符。在 AWS 区域中，可以使用 ID 作为 [1] 上的 id 来获取，在 Azure 区域中，可以使用 `ID` 作为 pre-termined 名称( [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3])获取 GCP 区域。在 GCP 区域中，可以使用 `ID` 作为预确定的名称来获得。[1]: [1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get
`tags`	`对象（字符串）`	标签可用于查询 AWS 上的 DNS 托管区。在 AWS 上，可以使用 resourcegroupstaggingapi [1] 获取区域，使用 `Tags` 作为 tag-filters, [1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options

8.1.6. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

8.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/dnses
- DELETE ：删除 DNS 集合
- GET: 列出类型为 DNS 的对象
- POST ：创建 DNS
/apis/config.openshift.io/v1/dnses/{name}
- DELETE ：删除 DNS
- GET ：读取指定的 DNS
- PATCH: 部分更新指定的 DNS
- PUT ：替换指定的 DNS
/apis/config.openshift.io/v1/dnses/{name}/status
- GET ：指定 DNS 的读取状态
- PATCH: 部分更新指定 DNS 的状态
- PUT ：替换指定 DNS 的状态

8.2.1. /apis/config.openshift.io/v1/dnses
复制链接

Expand

表 8.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 DNS 集合

Expand

表 8.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 8.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 DNS 类型的对象

Expand

表 8.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 8.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DNSList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 DNS

Expand

表 8.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 8.7. 主体参数
参数	类型	描述
`正文（body）`	`DNS` 模式

Expand

表 8.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DNS` 模式
201 - Created	`DNS` 模式
202 - Accepted	`DNS` 模式
401 - Unauthorized	空

8.2.2. /apis/config.openshift.io/v1/dnses/{name}
复制链接

Expand

表 8.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	DNS 的名称

Expand

表 8.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 DNS

Expand

表 8.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 8.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 8.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的 DNS

Expand

表 8.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 8.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DNS` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 DNS

Expand

表 8.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 8.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 8.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DNS` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 DNS

Expand

表 8.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 8.20. 主体参数
参数	类型	描述
`正文（body）`	`DNS` 模式

Expand

表 8.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DNS` 模式
201 - Created	`DNS` 模式
401 - Unauthorized	空

8.2.3. /apis/config.openshift.io/v1/dnses/{name}/status
复制链接

Expand

表 8.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	DNS 的名称

Expand

表 8.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 DNS 的读取状态

Expand

表 8.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 8.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DNS` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 DNS 的状态

Expand

表 8.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 8.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 8.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DNS` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 DNS 的状态

Expand

表 8.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 8.30. 主体参数
参数	类型	描述
`正文（body）`	`DNS` 模式

Expand

表 8.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`DNS` 模式
201 - Created	`DNS` 模式
401 - Unauthorized	空

第 9 章 FeatureGate [config.openshift.io/v1]
复制链接

描述

特性包含有关功能门的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

9.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

9.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`customNoUpgrade`	``	customNoUpgrade 允许启用或禁用任何功能。在 IS NOT SUPPORTED, CANNOT UNDONE, 和 PREVENTS UPGRADES 打开此功能集。由于其性质，无法验证此设置。如果您有任何拼写错误或意外应用无效的组合，则集群可能会以无法恢复的方式失败。featureSet 必须等于 "CustomNoUpgrade" 才能使用此字段。
`featureSet`	`字符串`	featureSet 更改集群中的功能列表。默认值为空。调整此设置时要非常小心。打开或关闭功能可能会导致集群中无法撤销的更改。

9.1.2. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

9.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/featuregates
- DELETE: 删除 FeatureGate 集合
- GET: 列出类型为 FeatureGate 的对象
- POST ：创建 FeatureGate
/apis/config.openshift.io/v1/featuregates/{name}
- DELETE ：删除 FeatureGate
- GET ：读取指定的 FeatureGate
- PATCH: 部分更新指定的 FeatureGate
- PUT ：替换指定的 FeatureGate
/apis/config.openshift.io/v1/featuregates/{name}/status
- GET ：指定 FeatureGate 的读取状态
- PATCH: 部分更新指定 FeatureGate 的状态
- PUT ：替换指定 FeatureGate 的状态

9.2.1. /apis/config.openshift.io/v1/featuregates
复制链接

Expand

表 9.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 FeatureGate 集合

Expand

表 9.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 9.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出类型为 FeatureGate 的对象

Expand

表 9.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 9.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FeatureGateList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 FeatureGate

Expand

表 9.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 9.7. 主体参数
参数	类型	描述
`正文（body）`	`FeatureGate` 模式

Expand

表 9.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FeatureGate` 模式
201 - Created	`FeatureGate` 模式
202 - Accepted	`FeatureGate` 模式
401 - Unauthorized	空

9.2.2. /apis/config.openshift.io/v1/featuregates/{name}
复制链接

Expand

表 9.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	FeatureGate 的名称

Expand

表 9.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 FeatureGate

Expand

表 9.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 9.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 9.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 FeatureGate

Expand

表 9.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 9.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FeatureGate` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 FeatureGate

Expand

表 9.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 9.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 9.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FeatureGate` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 FeatureGate

Expand

表 9.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 9.20. 主体参数
参数	类型	描述
`正文（body）`	`FeatureGate` 模式

Expand

表 9.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FeatureGate` 模式
201 - Created	`FeatureGate` 模式
401 - Unauthorized	空

9.2.3. /apis/config.openshift.io/v1/featuregates/{name}/status
复制链接

Expand

表 9.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	FeatureGate 的名称

Expand

表 9.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 FeatureGate 的读取状态

Expand

表 9.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 9.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FeatureGate` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 FeatureGate 的状态

Expand

表 9.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 9.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 9.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FeatureGate` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 FeatureGate 的状态

Expand

表 9.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 9.30. 主体参数
参数	类型	描述
`正文（body）`	`FeatureGate` 模式

Expand

表 9.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`FeatureGate` 模式
201 - Created	`FeatureGate` 模式
401 - Unauthorized	空

第 10 章 HelmChartRepository [helm.openshift.io/v1beta1]
复制链接

描述

HelmChartRepository 包含用于代理 Helm Chart 仓库兼容性 2 的集群范围配置：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

10.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	观察到集群中的存储库的状态。

10.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`connectionConfig`	`对象`	连接到 chart 仓库所需的配置
`description`	`字符串`	可选人类可读的存储库描述，UI 可用于显示目的
`disabled`	`布尔值`	如果设置为 true，请在 cluster/namespace 中禁用存储库使用量
`名称`	`字符串`	可选关联的人类可读的存储库名称，供 UI 用于显示目的

10.1.2. .spec.connectionConfig
复制链接

描述: 连接到 chart 仓库所需的配置
类型: object

Expand

属性	类型	描述
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。键 "ca-bundle.crt" 用于查找数据。若为空，则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
`tlsClientConfig`	`对象`	tlsClientConfig 是按名称对 secret 的可选引用，其中包含连接到服务器时可用的 PEM 编码 TLS 客户端证书和私钥。键 "tls.crt" 用于查找客户端证书。"tls.key"密钥用于查找私钥。此 secret 的命名空间是 openshift-config。
`url`	`字符串`	Chart 仓库 URL

10.1.3. .spec.connectionConfig.ca
复制链接

描述

CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。键 "ca-bundle.crt" 用于查找数据。若为空，则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

10.1.4. .spec.connectionConfig.tlsClientConfig
复制链接

描述

tlsClientConfig 是按名称对 secret 的可选引用，其中包含连接到服务器时可用的 PEM 编码 TLS 客户端证书和私钥。键 "tls.crt" 用于查找客户端证书。"tls.key"密钥用于查找私钥。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

10.1.5. .status
复制链接

描述: 观察到集群中的存储库的状态。
类型: object

Expand

属性	类型	描述
`conditions`	`array`	条件(Condition)是条件及其状态列表
`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 }

10.1.6. .status.conditions
复制链接

描述: 条件(Condition)是条件及其状态列表
类型: array

10.1.7. .status.conditions[]
复制链接

描述

类型

object

必填

lastTransitionTime
message
reason
status
type

Expand

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。
`message`	`字符串`	Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。
`observedGeneration`	`整数`	observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。
`reason`	`字符串`	reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)

10.2. API 端点
复制链接

可用的 API 端点如下：

/apis/helm.openshift.io/v1beta1/helmchartrepositories
- DELETE: 删除 HelmChartRepository 集合
- GET: 列出类型为 HelmChartRepository 的对象
- POST ：创建 HelmChartRepository
/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}
- DELETE ：删除 HelmChartRepository
- GET ：读取指定的 HelmChartRepository
- PATCH: 部分更新指定的 HelmChartRepository
- PUT ：替换指定的 HelmChartRepository
/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}/status
- GET ：指定 HelmChartRepository 的读取状态
- PATCH: 部分更新指定 HelmChartRepository 的状态
- PUT ：替换指定 HelmChartRepository 的状态

10.2.1. /apis/helm.openshift.io/v1beta1/helmchartrepositories
复制链接

Expand

表 10.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 HelmChartRepository 集合

Expand

表 10.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 10.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 HelmChartRepository 类型的对象

Expand

表 10.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 10.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HelmChartRepositoryList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 HelmChartRepository

Expand

表 10.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 10.7. 主体参数
参数	类型	描述
`正文（body）`	`HelmChartRepository` schema

Expand

表 10.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HelmChartRepository` schema
201 - Created	`HelmChartRepository` schema
202 - Accepted	`HelmChartRepository` schema
401 - Unauthorized	空

10.2.2. /apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}
复制链接

Expand

表 10.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	HelmChartRepository 的名称

Expand

表 10.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: delete a HelmChartRepository

Expand

表 10.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 10.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 10.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 HelmChartRepository

Expand

表 10.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 10.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HelmChartRepository` schema
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 HelmChartRepository

Expand

表 10.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 10.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 10.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HelmChartRepository` schema
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 HelmChartRepository

Expand

表 10.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 10.20. 主体参数
参数	类型	描述
`正文（body）`	`HelmChartRepository` schema

Expand

表 10.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HelmChartRepository` schema
201 - Created	`HelmChartRepository` schema
401 - Unauthorized	空

10.2.3. /apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}/status
复制链接

Expand

表 10.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	HelmChartRepository 的名称

Expand

表 10.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 HelmChartRepository 的读取状态

Expand

表 10.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 10.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HelmChartRepository` schema
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 HelmChartRepository 的状态

Expand

表 10.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 10.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 10.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HelmChartRepository` schema
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 HelmChartRepository 的状态

Expand

表 10.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 10.30. 主体参数
参数	类型	描述
`正文（body）`	`HelmChartRepository` schema

Expand

表 10.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`HelmChartRepository` schema
201 - Created	`HelmChartRepository` schema
401 - Unauthorized	空

第 11 章 Image [config.openshift.io/v1]
复制链接

描述

镜像管理与外部 registry 的镜像流导入和运行时配置相关的策略。它允许集群管理员配置允许哪些 registry OpenShift 从哪些 registry 中导入镜像、外部 registry 的额外 CA 信任捆绑包，以及阻止或允许 registry 主机名的策略。将 OpenShift 的镜像 registry 公开给公共时，这也允许集群管理员指定外部主机名。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

11.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

11.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`additionalTrustedCA`	`对象`	additionalTrustedCA 是对包含在镜像流导入、Pod 镜像拉取、构建镜像 pullthrough 期间应受信任的额外 CA 的 ConfigMap 的引用。此配置映射的命名空间是 openshift-config。
`allowedRegistriesForImport`	`array`	allowedRegistriesForImport 限制普通用户可从中导入镜像的容器镜像 registry。将此列表设置为您信任包含有效 Docker 镜像且希望应用程序能够从中导入的 registry。有权通过 API 创建镜像或 ImageStreamMappings 的用户不受此策略的影响 - 通常只有管理员或系统集成将具有这些权限。
`allowedRegistriesForImport[]`	`对象`	RegistryLocation 包含 registry 域名指定的 registry 位置。域名可能包含通配符，如 '*' 或 '?'。
`externalRegistryHostnames`	`数组（字符串）`	externalRegistryHostnames 为默认外部镜像 registry 提供主机名。只有在镜像 registry 对外公开时才应设置外部主机名。第一个值用于 ImageStreams 中的 'publicDockerImageRepository' 字段。该值必须采用 "hostname[:port]" 格式。
`registrySources`	`对象`	registrySources 包含配置，用于决定容器运行时在访问 builds+pods 时应如何处理各个 registry。（例如，是否允许不安全的访问）。它不包含内部集群 registry 的配置。

11.1.2. .spec.additionalTrustedCA
复制链接

描述

additionalTrustedCA 是对包含在镜像流导入、Pod 镜像拉取、构建镜像 pullthrough 期间应受信任的额外 CA 的 ConfigMap 的引用。此配置映射的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

11.1.3. .spec.allowedRegistriesForImport
复制链接

描述: allowedRegistriesForImport 限制普通用户可从中导入镜像的容器镜像 registry。将此列表设置为您信任包含有效 Docker 镜像且希望应用程序能够从中导入的 registry。有权通过 API 创建镜像或 ImageStreamMappings 的用户不受此策略的影响 - 通常只有管理员或系统集成将具有这些权限。
类型: array

11.1.4. .spec.allowedRegistriesForImport[]
复制链接

描述: RegistryLocation 包含 registry 域名指定的 registry 位置。域名可能包含通配符，如 '*' 或 '?'。
类型: object

Expand

属性	类型	描述
`domainName`	`字符串`	domainname 为 registry 指定域名，当 registry 使用非标准(80 或 443)端口时，该端口也应包含在域名中。
`insecure`	`布尔值`	insecure 表示 registry 是否是安全(https)还是不安全(http)默认（如果未指定），则 registry 假定为安全。

11.1.5. .spec.registrySources
复制链接

描述: registrySources 包含配置，用于决定容器运行时在访问 builds+pods 时应如何处理各个 registry。（例如，是否允许不安全的访问）。它不包含内部集群 registry 的配置。
类型: object

Expand

属性	类型	描述
`allowedRegistries`	`数组（字符串）`	allowedRegistries 是允许进行镜像拉取(pull)和推送(push)操作的 registry。所有其他 registry 都将被阻止。只能设置 BlockedRegistries 或 AllowedRegistries 中的一个。
`blockedRegistries`	`数组（字符串）`	blockedRegistries 无法用于镜像拉取(pull)和推送(push)操作。允许所有其他 registry。只能设置 BlockedRegistries 或 AllowedRegistries 中的一个。
`containerRuntimeSearchRegistries`	`数组（字符串）`	containerRuntimeSearchRegistries 是拉取(pull)在其 pull spec 中没有完全限定域时搜索的 registry。按照列表中提供的顺序搜索 registry。注：此搜索列表仅适用于容器运行时，如 CRI-O。不适用于构建或镜像流导入。
`insecureRegistries`	`数组（字符串）`	insecureRegistries 是没有有效 TLS 证书或仅支持 HTTP 连接的 registry。

11.1.6. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

Expand

属性	类型	描述
`externalRegistryHostnames`	`数组（字符串）`	externalRegistryHostnames 为默认外部镜像 registry 提供主机名。只有在镜像 registry 对外公开时才应设置外部主机名。第一个值用于 ImageStreams 中的 'publicDockerImageRepository' 字段。该值必须采用 "hostname[:port]" 格式。
`internalRegistryHostname`	`字符串`	internalRegistryHostname 设置默认内部镜像 registry 的主机名。该值必须采用 "hostname[:port]" 格式。这个值由控制内部 registry 主机名的镜像 registry Operator 设置。为了向后兼容，用户仍然可以使用 OPENSHIFT_DEFAULT_REGISTRY 环境变量，但此设置会覆盖环境变量。

11.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/images
- DELETE ：删除镜像集合
- GET: 列出类型为 Image 的对象
- POST ：创建镜像
/apis/config.openshift.io/v1/images/{name}
- DELETE ：删除镜像
- GET ：读取指定的镜像
- PATCH: 部分更新指定的镜像
- PUT ：替换指定的镜像
/apis/config.openshift.io/v1/images/{name}/status
- GET ：指定镜像的读取状态
- PATCH: 部分更新指定镜像的状态
- PUT ：替换指定镜像的状态

11.2.1. /apis/config.openshift.io/v1/images
复制链接

Expand

表 11.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除镜像集合

Expand

表 11.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 11.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 Image 类型的对象

Expand

表 11.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 11.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建镜像

Expand

表 11.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 11.7. 主体参数
参数	类型	描述
`正文（body）`	`Image` 模式

Expand

表 11.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Image` 模式
201 - Created	`Image` 模式
202 - Accepted	`Image` 模式
401 - Unauthorized	空

11.2.2. /apis/config.openshift.io/v1/images/{name}
复制链接

Expand

表 11.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	镜像的名称

Expand

表 11.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除镜像

Expand

表 11.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 11.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 11.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的镜像

Expand

表 11.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 11.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Image` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的镜像

Expand

表 11.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 11.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 11.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Image` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的镜像

Expand

表 11.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 11.20. 主体参数
参数	类型	描述
`正文（body）`	`Image` 模式

Expand

表 11.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Image` 模式
201 - Created	`Image` 模式
401 - Unauthorized	空

11.2.3. /apis/config.openshift.io/v1/images/{name}/status
复制链接

Expand

表 11.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	镜像的名称

Expand

表 11.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定镜像的读取状态

Expand

表 11.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 11.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Image` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定镜像的状态

Expand

表 11.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 11.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 11.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Image` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定镜像的状态

Expand

表 11.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 11.30. 主体参数
参数	类型	描述
`正文（body）`	`Image` 模式

Expand

表 11.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Image` 模式
201 - Created	`Image` 模式
401 - Unauthorized	空

第 12 章 ImageContentPolicy [config.openshift.io/v1]
复制链接

描述

ImageContentPolicy 包含有关如何处理 registry 镜像规则的集群范围信息。定义了多个策略时，会在每个字段中定义行为的结果。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

12.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值

12.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`repositoryDigestMirrors`	`array`	repositoryDigestMirrors 允许从替代已镜像的存储库位置拉取 pod 中镜像摘要引用的镜像。为 pod 提供的镜像拉取规格将与 RepositoryDigestMirrors 中描述的源位置进行比较，镜像可以从列表中的任何镜像而不是指定存储库拉取，而不是指定存储库。若要按标签从镜像拉取镜像，应设置"allowMirrorByTags"。每个"源"存储库都独立处理；不同"源"存储库的配置不交互。如果没有指定 "mirrors"，则镜像将继续从 pull spec 中的指定存储库拉取。当为同一"源"存储库定义了多个策略时，定义的镜像集合将合并在一起，保留镜像的相对顺序（如果可能）。例如，如果策略 A 具有镜像 `a, b, c` 和 policy B 具有 mirror `c, d, e`，则镜像将按 `a、b、c、d、e` 的顺序使用。如果镜像条目的顺序冲突（例如 `，b` 和）。`b, a`）配置不会被拒绝，但生成的顺序未指定。
`repositoryDigestMirrors[]`	`对象`	repositoryDigestMirrors 包含有关如何处理 registry 配置中镜像的集群范围信息。

12.1.2. .spec.repositoryDigestMirrors
复制链接

描述: repositoryDigestMirrors 允许从替代已镜像的存储库位置拉取 pod 中镜像摘要引用的镜像。为 pod 提供的镜像拉取规格将与 RepositoryDigestMirrors 中描述的源位置进行比较，镜像可以从列表中的任何镜像而不是指定存储库拉取，而不是指定存储库。若要按标签从镜像拉取镜像，应设置"allowMirrorByTags"。每个"源"存储库都独立处理；不同"源"存储库的配置不交互。如果没有指定 "mirrors"，则镜像将继续从 pull spec 中的指定存储库拉取。当为同一"源"存储库定义了多个策略时，定义的镜像集合将合并在一起，保留镜像的相对顺序（如果可能）。例如，如果策略 A 具有镜像 a, b, c 和 policy B 具有 mirror c, d, e，则镜像将按 a、b、c、d、e 的顺序使用。如果镜像条目的顺序冲突（例如 ，b 和）。b, a）配置不会被拒绝，但生成的顺序未指定。
类型: array

12.1.3. .spec.repositoryDigestMirrors[]
复制链接

描述

repositoryDigestMirrors 包含有关如何处理 registry 配置中镜像的集群范围信息。

类型

object

必填

source

Expand

属性	类型	描述
`allowMirrorByTags`	`布尔值`	AllowMirrorByTags if true，可以使用镜像来拉取由标签引用的镜像。默认为 false，只有在拉取由其摘要引用的镜像时才可以正常工作。根据我们从哪个端点，通过标签拉取镜像可能会生成不同的镜像。为镜像强制执行 digest-pulls 可避免出现这个问题。
`mirrors`	`数组（字符串）`	mirror 是零个或多个仓库，也可以包含相同的镜像。如果没有指定 "mirrors"，则镜像将继续从 pull spec 中的指定存储库拉取。没有配置镜像。此列表中的镜像顺序被视为用户所需的优先级，而源默认被视为比所有镜像的优先级较低。其他集群配置（包括但不限于）其他 repositoryDigestMirrors 对象可能会影响联系的确切顺序镜像，或者一些镜像可以并行联系，因此应该被视为首选项，而不是保证顺序的保证。
`source`	`字符串`	Source 是用户引用的存储库，例如在镜像拉取规格中。

12.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/imagecontentpolicies
- DELETE: delete collection of ImageContentPolicy
- GET: 列出 ImageContentPolicy 类型的对象
- POST ：创建 ImageContentPolicy
/apis/config.openshift.io/v1/imagecontentpolicies/{name}
- DELETE: delete an ImageContentPolicy
- GET ：读取指定的 ImageContentPolicy
- PATCH: 部分更新指定的 ImageContentPolicy
- PUT ：替换指定的 ImageContentPolicy
/apis/config.openshift.io/v1/imagecontentpolicies/{name}/status
- GET ：指定 ImageContentPolicy 的读取状态
- PATCH: 部分更新指定 ImageContentPolicy 的状态
- PUT ：替换指定 ImageContentPolicy 的状态

12.2.1. /apis/config.openshift.io/v1/imagecontentpolicies
复制链接

Expand

表 12.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ImageContentPolicy 集合

Expand

表 12.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 12.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 ImageContentPolicy 类型的对象

Expand

表 12.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 12.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageContentPolicyList` schema
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ImageContentPolicy

Expand

表 12.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 12.7. 主体参数
参数	类型	描述
`正文（body）`	`ImageContentPolicy` schema

Expand

表 12.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageContentPolicy` schema
201 - Created	`ImageContentPolicy` schema
202 - Accepted	`ImageContentPolicy` schema
401 - Unauthorized	空

12.2.2. /apis/config.openshift.io/v1/imagecontentpolicies/{name}
复制链接

Expand

表 12.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	ImageContentPolicy 的名称

Expand

表 12.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: delete an ImageContentPolicy

Expand

表 12.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 12.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 12.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的 ImageContentPolicy

Expand

表 12.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 12.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageContentPolicy` schema
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 ImageContentPolicy

Expand

表 12.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 12.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 12.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageContentPolicy` schema
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 ImageContentPolicy

Expand

表 12.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 12.20. 主体参数
参数	类型	描述
`正文（body）`	`ImageContentPolicy` schema

Expand

表 12.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageContentPolicy` schema
201 - Created	`ImageContentPolicy` schema
401 - Unauthorized	空

12.2.3. /apis/config.openshift.io/v1/imagecontentpolicies/{name}/status
复制链接

Expand

表 12.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	ImageContentPolicy 的名称

Expand

表 12.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 ImageContentPolicy 的读取状态

Expand

表 12.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 12.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageContentPolicy` schema
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 ImageContentPolicy 的状态

Expand

表 12.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 12.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 12.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageContentPolicy` schema
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 ImageContentPolicy 的状态

Expand

表 12.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 12.30. 主体参数
参数	类型	描述
`正文（body）`	`ImageContentPolicy` schema

Expand

表 12.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ImageContentPolicy` schema
201 - Created	`ImageContentPolicy` schema
401 - Unauthorized	空

第 13 章 Infrastructure [config.openshift.io/v1]
复制链接

描述

基础架构包含有关基础架构的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

13.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

13.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`cloudConfig`	`对象`	cloudConfig 是包含云供应商配置文件的 ConfigMap 的引用。此配置文件用于在使用内置云供应商集成或外部云控制器管理器时配置 Kubernetes 云供应商集成。此配置映射的命名空间是 openshift-config。cloudConfig 应该只被 kube_cloud_config 控制器使用。控制器负责将 spec 中的用户配置用于各种平台，并将该用户与此字段中的用户提供的 ConfigMap 相结合，以创建 stitched kube 云配置。控制器在带有 kube 云配置的 `openshift-config-managed` 命名空间中生成 ConfigMap `kube-cloud-config` 存储在 `cloud.conf` 键中。所有客户端都应该只使用生成的 ConfigMap。
`platformSpec`	`对象`	platformSpec 包含与底层基础架构供应商相关的信息。

13.1.2. .spec.cloudConfig
复制链接

描述: cloudConfig 是包含云供应商配置文件的 ConfigMap 的引用。此配置文件用于在使用内置云供应商集成或外部云控制器管理器时配置 Kubernetes 云供应商集成。此配置映射的命名空间是 openshift-config。cloudConfig 应该只被 kube_cloud_config 控制器使用。控制器负责将 spec 中的用户配置用于各种平台，并将该用户与此字段中的用户提供的 ConfigMap 相结合，以创建 stitched kube 云配置。控制器在带有 kube 云配置的 openshift-config-managed 命名空间中生成 ConfigMap kube-cloud-config 存储在 cloud.conf 键中。所有客户端都应该只使用生成的 ConfigMap。
类型: object

Expand

属性	类型	描述
`key`	`字符串`	键允许指向 configmap 中的特定键/值。这对逻辑文件引用非常有用。
`name`	`字符串`

13.1.3. .spec.platformSpec
复制链接

描述: platformSpec 包含与底层基础架构供应商相关的信息。
类型: object

Expand

属性	类型	描述
`alibabaCloud`	`对象`	alibabacloud 包含特定于 Alibaba Cloud 基础架构供应商的设置。
`aws`	`对象`	AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。
`azure`	`对象`	Azure 包含特定于 Azure 基础架构供应商的设置。
`baremetal`	`对象`	裸机包含特定于 BareMetal 平台的设置。
`equinixMetal`	`对象`	equinixMetal 包含特定于 Equinix Metal 基础架构供应商的设置。
`gcp`	`对象`	GCP 包含特定于 Google Cloud Platform 基础架构供应商的设置。
`ibmcloud`	`对象`	ibmcloud 包含特定于 IBMCloud 基础架构供应商的设置。
`kubevirt`	`对象`	kubevirt 包含特定于 kubevirt 基础架构供应商的设置。
`nutanix`	`object`	Nutanix 包含特定于 Nutanix 基础架构供应商的设置。
`openstack`	`对象`	OpenStack 包含特定于 OpenStack 基础架构提供程序的设置。
`ovirt`	`对象`	ovirt 包含特定于 oVirt 基础架构提供程序的设置。
`powervs`	`对象`	powervs 包含与 IBM Power Systems Virtual Servers 基础架构供应商相关的设置。
`type`	`字符串`	type 是集群的底层基础架构供应商。这个值控制是否启用基础架构自动化，如服务负载均衡器、动态卷置备、机器创建和删除，以及其他集成。如果没有，则不会启用基础架构自动化。允许的值是 "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "KubeVirt", "EquinixMetal", "PowerVS", "AlibabaCloud", "Nutanix" 和 "None"。单个组件可能不支持所有平台，如果它们不支持该平台，则必须将未识别的平台处理为 None。
`vsphere`	`对象`	vSphere 包含特定于 VSphere 基础架构供应商的设置。

13.1.4. .spec.platformSpec.alibabaCloud
复制链接

描述: alibabacloud 包含特定于 Alibaba Cloud 基础架构供应商的设置。
类型: 对象

13.1.5. .spec.platformSpec.aws
复制链接

描述: AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`serviceEndpoints`	`array`	serviceEndpoints 列表包含自定义端点，用于覆盖 AWS 服务的默认服务端点。服务必须只有一个 ServiceEndpoint。
`serviceEndpoints[]`	`对象`	AWSServiceEndpoint 存储自定义 url 的配置，以覆盖 AWS Services 的现有默认值。

13.1.6. .spec.platformSpec.aws.serviceEndpoints
复制链接

描述: serviceEndpoints 列表包含自定义端点，用于覆盖 AWS 服务的默认服务端点。服务必须只有一个 ServiceEndpoint。
类型: array

13.1.7. .spec.platformSpec.aws.serviceEndpoints[]
复制链接

描述: AWSServiceEndpoint 存储自定义 url 的配置，以覆盖 AWS Services 的现有默认值。
类型: object

Expand

属性	类型	描述
`name`	`字符串`	name 是 AWS 服务的名称。所有服务名称的列表可在 https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html 中找到，这必须提供且无法为空。
`url`	`字符串`	URL 是方案 https 的完全限定 URI，可覆盖客户端的默认生成端点。这必须提供，且不能为空。

13.1.8. .spec.platformSpec.azure
复制链接

描述: Azure 包含特定于 Azure 基础架构供应商的设置。
类型: 对象

13.1.9. .spec.platformSpec.baremetal
复制链接

描述: 裸机包含特定于 BareMetal 平台的设置。
类型: 对象

13.1.10. .spec.platformSpec.equinixMetal
复制链接

描述: equinixMetal 包含特定于 Equinix Metal 基础架构供应商的设置。
类型: 对象

13.1.11. .spec.platformSpec.gcp
复制链接

描述: GCP 包含特定于 Google Cloud Platform 基础架构供应商的设置。
类型: 对象

13.1.12. .spec.platformSpec.ibmcloud
复制链接

描述: ibmcloud 包含特定于 IBMCloud 基础架构供应商的设置。
类型: 对象

13.1.13. .spec.platformSpec.kubevirt
复制链接

描述: kubevirt 包含特定于 kubevirt 基础架构供应商的设置。
类型: object

13.1.14. .spec.platformSpec.nutanix
复制链接

描述

Nutanix 包含特定于 Nutanix 基础架构供应商的设置。

类型

object

必填

prismCentral
prismElements

Expand

属性	类型	描述
`prismCentral`	`object`	prismCentral 包含端点地址和端口，用于访问 Nutanix Prism Central。安装集群范围代理时，此端点将通过代理访问。如果您希望与此端点通信而不是代理，请将端点添加到代理 spec.noProxy 列表中。
`prismElements`	`数组`	prismElements 包含一个或多个端点地址和端口数据，用于访问 Nutanix Prism Elements (clusters)的 Nutanix Prism Elements (clusters)。目前，我们只支持一个 OpenShift 集群的 Prism Element (cluster)，其中 OpenShift 集群中使用的所有 Nutanix 资源(VM、子网、卷等)。未来，我们可能支持 Nutanix 资源(VM 等)，分布在 Prism Central 的多个 Prism Elements (clusters)。
`prismElements[]`	`object`	NutanixPrismElementEndpoint 包含 Prism Element (cluster)的名称和端点数据

13.1.15. .spec.platformSpec.nutanix.prismCentral
复制链接

描述

prismCentral 包含端点地址和端口，用于访问 Nutanix Prism Central。安装集群范围代理时，此端点将通过代理访问。如果您希望与此端点通信而不是代理，请将端点添加到代理 spec.noProxy 列表中。

类型

object

必填

address
port

Expand

属性	类型	描述
`address`	`string`	address 是 Nutanix Prism Central 或 Element (cluster)的端点地址(DNS 名称或 IP 地址)
`port`	`整数`	port 是访问 Nutanix Prism Central 或 Element (cluster)的端口号

13.1.16. .spec.platformSpec.nutanix.prismElements
复制链接

描述: prismElements 包含一个或多个端点地址和端口数据，用于访问 Nutanix Prism Elements (clusters)的 Nutanix Prism Elements (clusters)。目前，我们只支持一个 OpenShift 集群的 Prism Element (cluster)，其中 OpenShift 集群中使用的所有 Nutanix 资源(VM、子网、卷等)。未来，我们可能支持 Nutanix 资源(VM 等)，分布在 Prism Central 的多个 Prism Elements (clusters)。
类型: 数组

13.1.17. .spec.platformSpec.nutanix.prismElements[]
复制链接

描述

NutanixPrismElementEndpoint 包含 Prism Element (cluster)的名称和端点数据

类型

object

必填

端点
名称

Expand

属性	类型	描述
`端点`	`object`	端点包含 Prism Element (cluster)的端点地址和端口数据。安装集群范围代理时，此端点将通过代理访问。如果您希望与此端点通信而不是代理，请将端点添加到代理 spec.noProxy 列表中。
`名称`	`string`	name 是 Prism Element (cluster)的名称。这个值将与其他资源上配置的 cluster 字段（如 Machines、PVC 等）对应。

13.1.18. .spec.platformSpec.nutanix.prismElements[].endpoint
复制链接

描述

端点包含 Prism Element (cluster)的端点地址和端口数据。安装集群范围代理时，此端点将通过代理访问。如果您希望与此端点通信而不是代理，请将端点添加到代理 spec.noProxy 列表中。

类型

object

必填

address
port

Expand

属性	类型	描述
`address`	`string`	address 是 Nutanix Prism Central 或 Element (cluster)的端点地址(DNS 名称或 IP 地址)
`port`	`整数`	port 是访问 Nutanix Prism Central 或 Element (cluster)的端口号

13.1.19. .spec.platformSpec.openstack
复制链接

描述: OpenStack 包含特定于 OpenStack 基础架构提供程序的设置。
类型: 对象

13.1.20. .spec.platformSpec.ovirt
复制链接

描述: ovirt 包含特定于 oVirt 基础架构提供程序的设置。
类型: 对象

13.1.21. .spec.platformSpec.powervs
复制链接

描述: powervs 包含与 IBM Power Systems Virtual Servers 基础架构供应商相关的设置。
类型: object

Expand

属性	类型	描述
`serviceEndpoints`	`array`	serviceEndpoints 是自定义端点列表，它将覆盖 Power VS 服务的默认服务端点。
`serviceEndpoints[]`	`对象`	PowervsServiceEndpoint 存储自定义 url 的配置，以覆盖 PowerVS Services 的现有默认值。

13.1.22. .spec.platformSpec.powervs.serviceEndpoints
复制链接

描述: serviceEndpoints 是自定义端点列表，它将覆盖 Power VS 服务的默认服务端点。
类型: 数组

13.1.23. .spec.platformSpec.powervs.serviceEndpoints[]
复制链接

描述

PowervsServiceEndpoint 存储自定义 url 的配置，以覆盖 PowerVS Services 的现有默认值。

类型

object

必填

name
url

Expand

属性	类型	描述
`name`	`字符串`	name 是 Power VS 服务的名称。其中一些服务是 IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud
`url`	`字符串`	URL 是方案 https 的完全限定 URI，可覆盖客户端的默认生成端点。这必须提供，且不能为空。

13.1.24. .spec.platformSpec.vsphere
复制链接

描述: vSphere 包含特定于 VSphere 基础架构供应商的设置。
类型: 对象

13.1.25. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

Expand

属性	类型	描述
`apiServerInternalURI`	`字符串`	apiServerInternalURL 是一个有效的 URI，方案为 'https'、地址和可选端口（默认为 443）。apiServerInternalURL 可以被 kubelet 等组件使用，以使用基础架构供应商而不是 Kubernetes 网络联系 Kubernetes API 服务器。
`apiServerURL`	`字符串`	apiServerURL 是一个有效的 URI，方案为 'https'、地址和可选端口（默认为 443）。apiServerURL 可以被 Web 控制台等组件使用，告诉用户在哪里查找 Kubernetes API。
`controlPlaneTopology`	`字符串`	controlPlaneTopology 表达了通常在控制节点上运行的操作对象的预期。默认为 'HighlyAvailable'，它代表了 Operator 在"正常"集群中具有的行为。'SingleReplica' 模式将在单节点部署中使用，Operator 不应该为高可用性操作配置操作对象。"External' 模式表示 control plane 在集群中外部托管，其组件在集群中不可见。
`etcdDiscoveryDomain`	`字符串`	etcdDiscoveryDomain 是用来获取用于发现 etcd 服务器和客户端的 SRV 记录的域。更多信息： https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery 弃用：从 4.7 开始，此字段不再设置或满足。它将在以后的发行版本中被删除。
`infrastructureName`	`字符串`	InfrastructureName 使用用户友好的名称唯一标识集群。设置之后，不应更改。必须是最大长度 27，且只能有字母数字字符或连字符。
`infrastructureTopology`	`字符串`	infrastructureTopology 表达了对没有在 control plane 节点上运行的基础架构服务的预期，通常由节点选择器为 `master` 以外的 `角色` 值表示。默认为 'HighlyAvailable'，它代表了 Operator 在"正常"集群中具有的行为。'SingleReplica' 模式将在单节点部署中使用，Operator 不应该为高可用性操作配置操作对象： External topology mode 不适用于此字段。
`platform`	`字符串`	Platform 是集群的底层基础架构供应商。弃用：使用 platformStatus.type 替代。
`platformStatus`	`对象`	platformStatus 包含特定于底层基础架构供应商的状态信息。

13.1.26. .status.platformStatus
复制链接

描述: platformStatus 包含特定于底层基础架构供应商的状态信息。
类型: object

Expand

属性	类型	描述
`alibabaCloud`	`对象`	alibabacloud 包含特定于 Alibaba Cloud 基础架构供应商的设置。
`aws`	`对象`	AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。
`azure`	`对象`	Azure 包含特定于 Azure 基础架构供应商的设置。
`baremetal`	`对象`	裸机包含特定于 BareMetal 平台的设置。
`equinixMetal`	`对象`	equinixMetal 包含特定于 Equinix Metal 基础架构供应商的设置。
`gcp`	`对象`	GCP 包含特定于 Google Cloud Platform 基础架构供应商的设置。
`ibmcloud`	`对象`	ibmcloud 包含特定于 IBMCloud 基础架构供应商的设置。
`kubevirt`	`对象`	kubevirt 包含特定于 kubevirt 基础架构供应商的设置。
`nutanix`	`object`	Nutanix 包含特定于 Nutanix 基础架构供应商的设置。
`openstack`	`对象`	OpenStack 包含特定于 OpenStack 基础架构提供程序的设置。
`ovirt`	`对象`	ovirt 包含特定于 oVirt 基础架构提供程序的设置。
`powervs`	`对象`	powervs 包含与 Power Systems Virtual Servers 基础架构提供程序相关的设置。
`type`	`字符串`	type 是集群的底层基础架构供应商。这个值控制是否启用基础架构自动化，如服务负载均衡器、动态卷置备、机器创建和删除，以及其他集成。如果没有，则不会启用基础架构自动化。允许的值是 "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "EquinixMetal", "PowerVS", "AlibabaCloud", "Nutanix" 和 "None"。单个组件可能不支持所有平台，如果它们不支持该平台，则必须将未识别的平台处理为 None。这个值将与 `status.platform` 和 `status.platformStatus.type` 同步。目前，设置后无法更改这个值。
`vsphere`	`对象`	vSphere 包含特定于 VSphere 基础架构供应商的设置。

13.1.27. .status.platformStatus.alibabaCloud
复制链接

描述

alibabacloud 包含特定于 Alibaba Cloud 基础架构供应商的设置。

类型

object

必填

region

Expand

属性	类型	描述
`region`	`字符串`	region 指定为集群创建的 Alibaba Cloud 资源的区域。
`resourceGroupID`	`字符串`	resourceGroupID 是集群的资源组的 ID。
`resourceTags`	`array`	resourceTags 是应用于为集群创建的 Alibaba Cloud 资源的附加标签列表。
`resourceTags[]`	`对象`	AlibabaCloudResourceTag 是要添加到资源的一组标签。

13.1.28. .status.platformStatus.alibabaCloud.resourceTags
复制链接

描述: resourceTags 是应用于为集群创建的 Alibaba Cloud 资源的附加标签列表。
类型: array

13.1.29. .status.platformStatus.alibabaCloud.resourceTags[]
复制链接

描述

AlibabaCloudResourceTag 是要添加到资源的一组标签。

类型

object

必填

key
value

Expand

属性	类型	描述
`key`	`字符串`	key 是标签的密钥。
`value`	`字符串`	value 是标签的值。

13.1.30. .status.platformStatus.aws
复制链接

描述: AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`region`	`字符串`	区域包含集群所创建的新 AWS 资源的默认 AWS 区域。
`resourceTags`	`array`	resourceTags 是应用于为集群创建的 AWS 资源的额外标签列表。有关标记 AWS 资源的信息，请参阅 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html。AWS 支持每个资源最多 50 个标签。OpenShift 保留 25 个标签供用户使用，保留 25 个标签供用户使用。
`resourceTags[]`	`对象`	AWSResourceTag 是一个应用于为集群创建的 AWS 资源的标签。
`serviceEndpoints`	`array`	serviceEndpoints 列表包含自定义端点，用于覆盖 AWS 服务的默认服务端点。服务必须只有一个 ServiceEndpoint。
`serviceEndpoints[]`	`对象`	AWSServiceEndpoint 存储自定义 url 的配置，以覆盖 AWS Services 的现有默认值。

13.1.31. .status.platformStatus.aws.resourceTags
复制链接

描述: resourceTags 是应用于为集群创建的 AWS 资源的额外标签列表。有关标记 AWS 资源的信息，请参阅 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html。AWS 支持每个资源最多 50 个标签。OpenShift 保留 25 个标签供用户使用，保留 25 个标签供用户使用。
类型: array

13.1.32. .status.platformStatus.aws.resourceTags[]
复制链接

描述

AWSResourceTag 是一个应用于为集群创建的 AWS 资源的标签。

类型

object

必填

key
value

Expand

属性	类型	描述
`key`	`字符串`	key 是标签的密钥
`value`	`字符串`	value 是标签的值。有些 AWS 服务不支持空值。由于标签添加到许多服务中的资源，标签值的长度必须满足所有服务的要求。

13.1.33. .status.platformStatus.aws.serviceEndpoints
复制链接

描述: serviceEndpoints 列表包含自定义端点，用于覆盖 AWS 服务的默认服务端点。服务必须只有一个 ServiceEndpoint。
类型: array

13.1.34. .status.platformStatus.aws.serviceEndpoints[]
复制链接

描述: AWSServiceEndpoint 存储自定义 url 的配置，以覆盖 AWS Services 的现有默认值。
类型: object

Expand

属性	类型	描述
`name`	`字符串`	name 是 AWS 服务的名称。所有服务名称的列表可在 https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html 中找到，这必须提供且无法为空。
`url`	`字符串`	URL 是方案 https 的完全限定 URI，可覆盖客户端的默认生成端点。这必须提供，且不能为空。

13.1.35. .status.platformStatus.azure
复制链接

描述: Azure 包含特定于 Azure 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`armEndpoint`	`字符串`	armEndpoint 指定在非监管云中（如 Azure Stack）中使用的资源管理的 URL。
`cloudName`	`字符串`	cloudName 是 Azure 云环境的名称，可用于使用适当的 Azure API 端点配置 Azure SDK。如果为空，则该值等于 `AzurePublicCloud`。
`networkResourceGroupName`	`字符串`	networkResourceGroupName 是网络资源的资源组，如集群使用的 Virtual Network 和 Subnets。如果为空，则该值与 ResourceGroupName 相同。
`resourceGroupName`	`字符串`	resourceGroupName 是为集群创建的新 Azure 资源的 Resource Group。

13.1.36. .status.platformStatus.baremetal
复制链接

描述: 裸机包含特定于 BareMetal 平台的设置。
类型: object

Expand

属性	类型	描述
`apiServerInternalIP`	`字符串`	apiServerInternalIP 是一个 IP 地址，用于联系 Kubernetes API 服务器，供集群内的组件使用，如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的一个自托管负载均衡器的 IP。弃用：使用 APIServerInternalIPs 替代。
`apiServerInternalIPs`	`数组（字符串）`	apiServerInternalIPs 是联系 Kubernetes API 服务器的 IP 地址，供集群内的组件使用，如 kubelet 使用基础架构而不是 Kubernetes 网络。这些是 API 服务器前面的自托管负载均衡器的 IP。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`ingressIP`	`字符串`	ingressIP 是一个外部 IP，路由到默认入口控制器。IP 是通配符 DNS 记录的适当目标，用于解析默认路由主机名。弃用：使用 IngressIPs 替代。
`ingressIPs`	`数组（字符串）`	ingressIPs 是路由到默认入口控制器的外部 IP。IP 是通配符 DNS 记录目标，用于解析默认路由主机名。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`nodeDNSIP`	`字符串`	nodeDNSIP 是节点使用的内部 DNS 的 IP 地址。与 DNS 操作器管理的不同，`NodeDNSIP` 为节点本身提供名称解析。对于 BareMetal 部署，没有 DNS-as-a-service。为了最大程度减少对数据中心 DNS 的必要更改，DNS 服务托管为静态 pod，为集群中的节点提供这些主机名。

13.1.37. .status.platformStatus.equinixMetal
复制链接

描述: equinixMetal 包含特定于 Equinix Metal 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`apiServerInternalIP`	`字符串`	apiServerInternalIP 是一个 IP 地址，用于联系 Kubernetes API 服务器，供集群内的组件使用，如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的一个自托管负载均衡器的 IP。
`ingressIP`	`字符串`	ingressIP 是一个外部 IP，路由到默认入口控制器。IP 是通配符 DNS 记录的适当目标，用于解析默认路由主机名。

13.1.38. .status.platformStatus.gcp
复制链接

描述: GCP 包含特定于 Google Cloud Platform 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`projectID`	`字符串`	resourceGroupName 是为集群创建的新 GCP 资源的项目 ID。
`region`	`字符串`	区域包含为集群创建的新 GCP 资源的区域。

13.1.39. .status.platformStatus.ibmcloud
复制链接

描述: ibmcloud 包含特定于 IBMCloud 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`cisInstanceCRN`	`字符串`	CISInstanceCRN 是 Cloud Internet Services 实例的 CRN，用于管理集群基域的 DNS 区域
`dnsInstanceCRN`	`string`	DNSInstanceCRN 是 DNS Services 实例的 CRN，用于管理集群基域的 DNS 区域
`位置`	`字符串`	位置是集群部署的位置
`providerType`	`字符串`	ProviderType 表示创建的集群类型
`resourceGroupName`	`字符串`	resourceGroupName 是为集群创建的新 IBMCloud 资源的 Resource Group。

13.1.40. .status.platformStatus.kubevirt
复制链接

描述: kubevirt 包含特定于 kubevirt 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`apiServerInternalIP`	`字符串`	apiServerInternalIP 是一个 IP 地址，用于联系 Kubernetes API 服务器，供集群内的组件使用，如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的一个自托管负载均衡器的 IP。
`ingressIP`	`字符串`	ingressIP 是一个外部 IP，路由到默认入口控制器。IP 是通配符 DNS 记录的适当目标，用于解析默认路由主机名。

13.1.41. .status.platformStatus.nutanix
复制链接

描述: Nutanix 包含特定于 Nutanix 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`apiServerInternalIP`	`字符串`	apiServerInternalIP 是一个 IP 地址，用于联系 Kubernetes API 服务器，供集群内的组件使用，如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的一个自托管负载均衡器的 IP。弃用：使用 APIServerInternalIPs 替代。
`apiServerInternalIPs`	`数组（字符串）`	apiServerInternalIPs 是联系 Kubernetes API 服务器的 IP 地址，供集群内的组件使用，如 kubelet 使用基础架构而不是 Kubernetes 网络。这些是 API 服务器前面的自托管负载均衡器的 IP。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`ingressIP`	`字符串`	ingressIP 是一个外部 IP，路由到默认入口控制器。IP 是通配符 DNS 记录的适当目标，用于解析默认路由主机名。弃用：使用 IngressIPs 替代。
`ingressIPs`	`数组（字符串）`	ingressIPs 是路由到默认入口控制器的外部 IP。IP 是通配符 DNS 记录目标，用于解析默认路由主机名。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。

13.1.42. .status.platformStatus.openstack
复制链接

描述: OpenStack 包含特定于 OpenStack 基础架构提供程序的设置。
类型: object

Expand

属性	类型	描述
`apiServerInternalIP`	`字符串`	apiServerInternalIP 是一个 IP 地址，用于联系 Kubernetes API 服务器，供集群内的组件使用，如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的一个自托管负载均衡器的 IP。弃用：使用 APIServerInternalIPs 替代。
`apiServerInternalIPs`	`数组（字符串）`	apiServerInternalIPs 是联系 Kubernetes API 服务器的 IP 地址，供集群内的组件使用，如 kubelet 使用基础架构而不是 Kubernetes 网络。这些是 API 服务器前面的自托管负载均衡器的 IP。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`cloudName`	`字符串`	cloudName 是客户端配置文件(`clouds.yaml`)中所需 OpenStack 云的名称。
`ingressIP`	`字符串`	ingressIP 是一个外部 IP，路由到默认入口控制器。IP 是通配符 DNS 记录的适当目标，用于解析默认路由主机名。弃用：使用 IngressIPs 替代。
`ingressIPs`	`数组（字符串）`	ingressIPs 是路由到默认入口控制器的外部 IP。IP 是通配符 DNS 记录目标，用于解析默认路由主机名。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`nodeDNSIP`	`字符串`	nodeDNSIP 是节点使用的内部 DNS 的 IP 地址。与 DNS 操作器管理的不同，`NodeDNSIP` 为节点本身提供名称解析。OpenStack 部署没有 DNS 即服务。为了最大程度减少对数据中心 DNS 的必要更改，DNS 服务托管为静态 pod，为集群中的节点提供这些主机名。

13.1.43. .status.platformStatus.ovirt
复制链接

描述: ovirt 包含特定于 oVirt 基础架构提供程序的设置。
类型: object

Expand

属性	类型	描述
`apiServerInternalIP`	`字符串`	apiServerInternalIP 是一个 IP 地址，用于联系 Kubernetes API 服务器，供集群内的组件使用，如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的一个自托管负载均衡器的 IP。弃用：使用 APIServerInternalIPs 替代。
`apiServerInternalIPs`	`数组（字符串）`	apiServerInternalIPs 是联系 Kubernetes API 服务器的 IP 地址，供集群内的组件使用，如 kubelet 使用基础架构而不是 Kubernetes 网络。这些是 API 服务器前面的自托管负载均衡器的 IP。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`ingressIP`	`字符串`	ingressIP 是一个外部 IP，路由到默认入口控制器。IP 是通配符 DNS 记录的适当目标，用于解析默认路由主机名。弃用：使用 IngressIPs 替代。
`ingressIPs`	`数组（字符串）`	ingressIPs 是路由到默认入口控制器的外部 IP。IP 是通配符 DNS 记录目标，用于解析默认路由主机名。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`nodeDNSIP`	`字符串`	弃用：从 4.6 开始，此字段不再设置或接受。它将在以后的发行版本中被删除。

13.1.44. .status.platformStatus.powervs
复制链接

描述: powervs 包含与 Power Systems Virtual Servers 基础架构提供程序相关的设置。
类型: object

Expand

属性	类型	描述
`cisInstanceCRN`	`字符串`	CISInstanceCRN 是 Cloud Internet Services 实例的 CRN，用于管理集群基域的 DNS 区域
`dnsInstanceCRN`	`string`	DNSInstanceCRN 是 DNS Services 实例的 CRN，用于管理集群基域的 DNS 区域
`region`	`字符串`	region 包含集群所创建的新 Power VS 资源的默认 Power VS 区域。
`serviceEndpoints`	`array`	serviceEndpoints 是自定义端点列表，它将覆盖 Power VS 服务的默认服务端点。
`serviceEndpoints[]`	`对象`	PowervsServiceEndpoint 存储自定义 url 的配置，以覆盖 PowerVS Services 的现有默认值。
`zone`	`字符串`	zone 包含集群所创建的新 Power VS 资源的默认区域。注：目前只支持单区 OCP 集群

13.1.45. .status.platformStatus.powervs.serviceEndpoints
复制链接

描述: serviceEndpoints 是自定义端点列表，它将覆盖 Power VS 服务的默认服务端点。
类型: array

13.1.46. .status.platformStatus.powervs.serviceEndpoints[]
复制链接

描述

PowervsServiceEndpoint 存储自定义 url 的配置，以覆盖 PowerVS Services 的现有默认值。

类型

object

必填

name
url

Expand

属性	类型	描述
`name`	`字符串`	name 是 Power VS 服务的名称。其中一些服务是 IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud
`url`	`字符串`	URL 是方案 https 的完全限定 URI，可覆盖客户端的默认生成端点。这必须提供，且不能为空。

13.1.47. .status.platformStatus.vsphere
复制链接

描述: vSphere 包含特定于 VSphere 基础架构供应商的设置。
类型: object

Expand

属性	类型	描述
`apiServerInternalIP`	`字符串`	apiServerInternalIP 是一个 IP 地址，用于联系 Kubernetes API 服务器，供集群内的组件使用，如使用基础架构而不是 Kubernetes 网络的 kubelet。它是 Infrastructure.status.apiServerInternalURI 指向的 IP。它是 API 服务器前面的一个自托管负载均衡器的 IP。弃用：使用 APIServerInternalIPs 替代。
`apiServerInternalIPs`	`数组（字符串）`	apiServerInternalIPs 是联系 Kubernetes API 服务器的 IP 地址，供集群内的组件使用，如 kubelet 使用基础架构而不是 Kubernetes 网络。这些是 API 服务器前面的自托管负载均衡器的 IP。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`ingressIP`	`字符串`	ingressIP 是一个外部 IP，路由到默认入口控制器。IP 是通配符 DNS 记录的适当目标，用于解析默认路由主机名。弃用：使用 IngressIPs 替代。
`ingressIPs`	`数组（字符串）`	ingressIPs 是路由到默认入口控制器的外部 IP。IP 是通配符 DNS 记录目标，用于解析默认路由主机名。在双栈集群中，此列表包含两个 IP，否则只有一个 IP。
`nodeDNSIP`	`字符串`	nodeDNSIP 是节点使用的内部 DNS 的 IP 地址。与 DNS 操作器管理的不同，`NodeDNSIP` 为节点本身提供名称解析。vSphere 部署没有 DNS 即服务。为了最大程度减少对数据中心 DNS 的必要更改，DNS 服务托管为静态 pod，为集群中的节点提供这些主机名。

13.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/infrastructures
- DELETE ：删除基础架构集合
- GET ：列出类型为 Infrastructure 的对象
- POST ：创建一个基础架构
/apis/config.openshift.io/v1/infrastructures/{name}
- DELETE ：删除基础架构
- GET ：读取指定的基础架构
- PATCH: 部分更新指定的基础架构
- PUT ：替换指定的基础架构
/apis/config.openshift.io/v1/infrastructures/{name}/status
- GET ：指定基础架构的读取状态
- PATCH: 部分更新指定基础架构的状态
- PUT ：替换指定基础架构的状态

13.2.1. /apis/config.openshift.io/v1/infrastructures
复制链接

Expand

表 13.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除基础架构集合

Expand

表 13.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 13.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 Infrastructure 类型的对象

Expand

表 13.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 13.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`InfrastructureList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建基础架构

Expand

表 13.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 13.7. 主体参数
参数	类型	描述
`正文（body）`	`Infrastructure` 模式

Expand

表 13.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Infrastructure` 模式
201 - Created	`Infrastructure` 模式
202 - Accepted	`Infrastructure` 模式
401 - Unauthorized	空

13.2.2. /apis/config.openshift.io/v1/infrastructures/{name}
复制链接

Expand

表 13.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	基础架构的名称

Expand

表 13.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除基础架构

Expand

表 13.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 13.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 13.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的基础架构

Expand

表 13.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 13.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Infrastructure` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的基础架构

Expand

表 13.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 13.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 13.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Infrastructure` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的基础架构

Expand

表 13.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 13.20. 主体参数
参数	类型	描述
`正文（body）`	`Infrastructure` 模式

Expand

表 13.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Infrastructure` 模式
201 - Created	`Infrastructure` 模式
401 - Unauthorized	空

13.2.3. /apis/config.openshift.io/v1/infrastructures/{name}/status
复制链接

Expand

表 13.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	基础架构的名称

Expand

表 13.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定基础架构的读取状态

Expand

表 13.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 13.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Infrastructure` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定基础架构的状态

Expand

表 13.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 13.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 13.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Infrastructure` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定基础架构的状态

Expand

表 13.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 13.30. 主体参数
参数	类型	描述
`正文（body）`	`Infrastructure` 模式

Expand

表 13.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Infrastructure` 模式
201 - Created	`Infrastructure` 模式
401 - Unauthorized	空

第 14 章 Ingress [config.openshift.io/v1]
复制链接

描述

Ingress 包含有关 ingress 的集群范围信息，包括用于路由的默认入口域。规范名称 为集群。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

14.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

14.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`appsDomain`	`字符串`	当创建 Route 时，appsDomain 是使用的可选域，而不是在 domain 字段中指定的域，而不指定显式主机。如果 appsDomain 是非空的，则使用这个值为 Route 生成默认主机值。与 domain 不同，appsDomain 可以在安装后进行修改。这假设已使用通配符证书设置一个新的 ingresscontroller。
`componentRoutes`	`array`	componentRoutes 是由 cluster-admin 配置主机名和提供证书的 OpenShift 组件管理的可选路由列表。此列表中每个路由的命名空间和名称应与 status.componentRoutes 列表中的现有条目匹配。要确定可配置的 Routes 集合，请查看 .status.componentRoutes 列表中的条目和名称，其中参与 Operator 写入可配置路由的状态。
`componentRoutes[]`	`对象`	ComponentRouteSpec 允许配置路由的主机名和服务证书。
`domain`	`字符串`	domain 用于在路由的主机名为空时为路由生成默认主机名。生成的主机名将遵循以下模式："<route-name>.<route-namespace>.<domain>"。它还用作 ingress 的默认通配符域后缀。默认 ingresscontroller 域将遵循以下模式："*.<domain>"。设置后，目前不支持更改域。
`loadBalancer`	`object`	LoadBalancer 包含负载均衡器详情，它们不仅特定于当前集群的底层基础架构供应商，并且 Ingress Controller 在 OpenShift 中工作需要。
`requiredHSTSPolicies`	`array`	requiredHSTSPolicies 指定在与策略中指定的 domainPattern/s 和 namespaceSelector/s 匹配的新创建或更新路由上所需的 HSTS 策略。每个 requiredHSTSPolicy 必须至少具有 domainPattern 和 maxAge，才能验证路由 HSTS 策略路由注解，并影响路由准入。具有 HSTS 策略的 HSTS 策略，则会检查 candidate 路由： "haproxy.router.openshift.io/hsts_header" E.g. haproxy.router.openshift.io/hsts_header: max-age=31536000;preload;includeSubDomains - 对于每个 candidate 路由，如果与 requiredHSTSPolicy domainPattern 和可选的 namespaceSelector 匹配，则必须接受它。否则，路由将被拒绝。- 第一个匹配，由 domainPattern 和 optional namespaceSelector 在 RequiredHSTSPolicies 的顺序中，决定路由的准入状态。- 如果 candidate 路由不匹配任何 requiredHSTSPolicy domainPattern 和 optional namespaceSelector，然后使用任何 HSTS 策略注解。HSTS 策略配置可能会在路由创建后更改。如果更新的路由不符合更新的 HSTS 策略配置，则对之前接受的路由的更新可能会失败。但是，更改 HSTS 策略配置不会导致已经接受的路由停止工作。请注意，如果没有 RequiredHSTSPolicies，则路由上的任何 HSTS 策略注解都有效。
`requiredHSTSPolicies[]`	`对象`

14.1.2. .spec.componentRoutes
复制链接

描述: componentRoutes 是由 cluster-admin 配置主机名和提供证书的 OpenShift 组件管理的可选路由列表。此列表中每个路由的命名空间和名称应与 status.componentRoutes 列表中的现有条目匹配。要确定可配置的 Routes 集合，请查看 .status.componentRoutes 列表中的条目和名称，其中参与 Operator 写入可配置路由的状态。
类型: array

14.1.3. .spec.componentRoutes[]
复制链接

描述

ComponentRouteSpec 允许配置路由的主机名和服务证书。

类型

object

必填

主机名
name
namespace

Expand

属性	类型	描述
`hostname`	`字符串`	hostname 是路由应使用的主机名。
`name`	`字符串`	name 是要自定义的路由的逻辑名称。如果要自定义路由，则此组件的命名空间和名称必须与 status.componentRoutes 列表中对应的条目匹配。
`namespace`	`字符串`	namespace 是要自定义的路由的命名空间。如果要自定义路由，则此组件的命名空间和名称必须与 status.componentRoutes 列表中对应的条目匹配。
`servingCertKeyPairSecret`	`对象`	serviceCertKeyPairSecret 是 openshift-config 命名空间中类型为 `kubernetes.io/tls` 的 secret 的引用。服务证书/密钥对必须匹配，并且 Operator 将使用它来满足使用此名称服务的意图。如果自定义主机名使用集群的默认路由后缀，则不需要服务证书的 Secret 规格。

14.1.4. .spec.componentRoutes[].servingCertKeyPairSecret
复制链接

描述

serviceCertKeyPairSecret 是 openshift-config 命名空间中类型为 kubernetes.io/tls 的 secret 的引用。服务证书/密钥对必须匹配，并且 Operator 将使用它来满足使用此名称服务的意图。如果自定义主机名使用集群的默认路由后缀，则不需要服务证书的 Secret 规格。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

14.1.5. .spec.loadBalancer
复制链接

描述: LoadBalancer 包含负载均衡器详情，它们不仅特定于当前集群的底层基础架构供应商，并且 Ingress Controller 在 OpenShift 中工作需要。
类型: object

Expand

属性	类型	描述
`platform`	`object`	平台包含特定于入口负载均衡器的底层基础架构供应商的配置。如果省略，这意味着用户没有建议，平台会被保留选择合理的默认值。这些默认值可能会随时间变化。

14.1.6. .spec.loadBalancer.platform
复制链接

描述: 平台包含特定于入口负载均衡器的底层基础架构供应商的配置。如果省略，这意味着用户没有建议，平台会被保留选择合理的默认值。这些默认值可能会随时间变化。
类型: object

Expand

属性	类型	描述
`aws`	`object`	AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。
`type`	`字符串`	type 是集群的底层基础架构供应商。允许的值是 "AWS", "Azure", "BareMetal", "GCP", "Libvirt", "OpenStack", "VSphere", "oVirt", "KubeVirt", "EquinixMetal", "PowerVS", "AlibabaCloud", "Nutanix" 和 "None"。单个组件可能不支持所有平台，如果它们不支持该平台，则必须将未识别的平台处理为 None。

14.1.7. .spec.loadBalancer.platform.aws
复制链接

描述

AWS 包含特定于 Amazon Web Services 基础架构供应商的设置。

类型

object

必填

type

Expand

属性	类型	描述
`type`	`string`	类型允许用户设置负载均衡器类型。当设置此字段时，将使用指定的 LBType 创建默认 ingresscontroller。如果没有设置此字段，则会创建 LBType Classic 的默认入口控制器。有效值为：* "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

14.1.8. .spec.requiredHSTSPolicies
复制链接

描述: requiredHSTSPolicies 指定在与策略中指定的 domainPattern/s 和 namespaceSelector/s 匹配的新创建或更新路由上所需的 HSTS 策略。每个 requiredHSTSPolicy 必须至少具有 domainPattern 和 maxAge，才能验证路由 HSTS 策略路由注解，并影响路由准入。具有 HSTS 策略的 HSTS 策略，则会检查 candidate 路由： "haproxy.router.openshift.io/hsts_header" E.g. haproxy.router.openshift.io/hsts_header: max-age=31536000;preload;includeSubDomains - 对于每个 candidate 路由，如果与 requiredHSTSPolicy domainPattern 和可选的 namespaceSelector 匹配，则必须接受它。否则，路由将被拒绝。- 第一个匹配，由 domainPattern 和 optional namespaceSelector 在 RequiredHSTSPolicies 的顺序中，决定路由的准入状态。- 如果 candidate 路由不匹配任何 requiredHSTSPolicy domainPattern 和 optional namespaceSelector，然后使用任何 HSTS 策略注解。HSTS 策略配置可能会在路由创建后更改。如果更新的路由不符合更新的 HSTS 策略配置，则对之前接受的路由的更新可能会失败。但是，更改 HSTS 策略配置不会导致已经接受的路由停止工作。请注意，如果没有 RequiredHSTSPolicies，则路由上的任何 HSTS 策略注解都有效。
类型: array

14.1.9. .spec.requiredHSTSPolicies[]
复制链接

描述

类型

object

必填

domainPatterns

Expand

属性	类型	描述
`domainPatterns`	`数组（字符串）`	domainPatterns 是需要其 HSTS 注解的域列表。如果指定了 domainPatterns，并使用与其中一个域匹配的 spec.host 创建路由，则路由必须指定匹配的 RequiredHSTSPolicy 中描述的 HSTS Policy 组件。允许使用通配符： .foo *.com 匹配 foo.com. foo.com 下的所有内容仅与 foo.com 匹配，因此要覆盖 foo.com 及其下面的所有内容，您必须指定 2**。
`includeSubDomainsPolicy`	`字符串`	includeSubDomainsPolicy 表示 HSTS 策略应该应用到主机域名的任何子域。因此，对于主机 bar.foo.com，如果 includeSubDomainsPolicy 设置为 RequireIncludeSubDomains: - 主机 app.bar.foo.com 将继承 bar.foo.com 的 HSTS 策略 - 主机 bar.foo.com 将继承 HSTS 策略 bar.foo.com - 主机 foo.com 不会继承 bar.foo.com 的 HSTS 策略。
`maxAge`	`对象`	maxAge 是 delta 时间范围，以秒为单位，主机被视为 HSTS 主机。如果设置为 0，则会对效果进行求值，并且主机将作为 HSTS 主机删除。如果设置为 0，并且指定了 includeSubdomains，则主机的所有子域也会作为 HSTS 主机删除。maxAge 是一个生存时间值，如果客户端没有刷新此策略，则 HSTS 策略最终在该客户端上过期。
`namespaceSelector`	`对象`	namespaceSelector 指定标签选择器，以便策略只适用于带有与选择器匹配的标签命名空间中的路由，并位于其中一个 DomainPatterns 中。默认为空 LabelSelector，它将匹配所有内容。
`preloadPolicy`	`字符串`	preloadPolicy 将客户端定向到主机 preload 列表中的主机，以便不需要初始负载来获取 HSTS 标头（请注意，这没有在 RFC 6797 中定义，因此客户端实现）。

14.1.10. .spec.requiredHSTSPolicies[].maxAge
复制链接

描述: maxAge 是 delta 时间范围，以秒为单位，主机被视为 HSTS 主机。如果设置为 0，则会对效果进行求值，并且主机将作为 HSTS 主机删除。如果设置为 0，并且指定了 includeSubdomains，则主机的所有子域也会作为 HSTS 主机删除。maxAge 是一个生存时间值，如果客户端没有刷新此策略，则 HSTS 策略最终在该客户端上过期。
类型: object

Expand

属性	类型	描述
`largestMaxAge`	`整数`	RequiredHSTSPolicy max-age 的最大允许值（以秒为单位）可未指定，在这种情况下，不会强制实施上限。
`smallestMaxAge`	`整数`	RequiredHSTSPolicy max-age Setting max-age=0 的最小允许值（以秒为单位）允许从主机中删除现有的 HSTS 标头。这是一个必要的工具，可供管理员快速更正错误。这个值可以被未指定，在这种情况下，没有强制实施较低限制。

14.1.11. .spec.requiredHSTSPolicies[].namespaceSelector
复制链接

描述: namespaceSelector 指定标签选择器，以便策略只适用于带有与选择器匹配的标签命名空间中的路由，并位于其中一个 DomainPatterns 中。默认为空 LabelSelector，它将匹配所有内容。
类型: object

Expand

属性	类型	描述
`matchExpressions`	`array`	matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
`matchExpressions[]`	`对象`	标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。
`matchLabels`	`对象（字符串）`	matchLabels 是 {key,value} 对的映射。MatchLabels 映射中的单个 {key,value} 等同于 matchExpressions 的一个元素，其 key 字段是 "key"，运算符是 "In"，值数组仅包含 "value"。要求的逻辑关系是 AND。

14.1.12. .spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions
复制链接

描述: matchExpressions 是标签选择器要求列表。要求的逻辑关系是 AND。
类型: array

14.1.13. .spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions[]
复制链接

描述

标签选择器要求是一个选择器，其中包含与键和值相关的值、键和值。

类型

object

必填

key
operator

Expand

属性	类型	描述
`key`	`字符串`	key 是选择器应用到的标签键。
`operator`	`字符串`	运算符代表一个键与一组值的关系。有效的运算符是 In、NotIn、Exists 和 DoesNotExist。
`值`	`数组（字符串）`	值是字符串值的数组。如果运算符是 In 或 NotIn，则值数组必须是非空的。如果运算符是 Exists 或 DoesNotExist，则值数组必须为空。这个数组会在策略性合并补丁中被替换。

14.1.14. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

Expand

属性	类型	描述
`componentRoutes`	`array`	componentRoutes 是参与操作员为可由 cluster-admin 自定义主机名和提供证书的路由状态放置当前路由状态。
`componentRoutes[]`	`对象`	ComponentRouteStatus 包含允许配置路由主机名和服务证书的信息。
`defaultPlacement`	`string`	在安装时设置了 defaultPlacement 来控制将默认托管入口路由器 pod 的节点。选项是 control-plane 节点或 worker 节点。此字段的工作原理是，在 Cluster Ingress Operator 在创建对应的 Deployment 时如何考虑取消设置 IngressController 资源中的 replicas 和 nodePlacement 字段。如需更多信息，请参阅 IngressController 副本和 nodePlacement 字段的文档。在省略时，默认值为 Workers

14.1.15. .status.componentRoutes
复制链接

描述: componentRoutes 是参与操作员为可由 cluster-admin 自定义主机名和提供证书的路由状态放置当前路由状态。
类型: array

14.1.16. .status.componentRoutes[]
复制链接

描述

ComponentRouteStatus 包含允许配置路由主机名和服务证书的信息。

类型

object

必填

defaultHostname
name
namespace
relatedObjects

Expand

属性	类型	描述
`conditions`	`array`	条件用于传达 componentRoutes 条目的状态。支持的条件包括 Available、Degraded 和 Progressing。如果可用，则路由提供的内容可以被用户访问。这包括在配置 cluster-admin 指定的自定义路由时默认可能会继续提供内容。如果 Degraded 为 true，这意味着无法尝试处理 componentRoutes 条目。currentHostnames 字段可能或可能无效。如果 Progressing 为 true，这意味着组件正在执行与 componentRoutes 条目相关的一些操作。
`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 }
`consumingUsers`	`数组（字符串）`	使用Users 是 ServiceAccounts 的一个片段，需要对 serviceCertKeyPairSecret secret 有读取权限。
`currentHostnames`	`数组（字符串）`	currentHostnames 是路由使用的当前名称列表。通常，此列表应包含单个主机名，但如果路由支持多个主机名，Operator 可能会将多个条目写入此列表。
`defaultHostname`	`字符串`	defaultHostname 是自定义前此路由的主机名。
`name`	`字符串`	name 是要自定义的路由的逻辑名称。它不一定是路由资源的实际名称，但不能重命名。如果要自定义路由，则此组件的路由的命名空间和名称必须与 spec.componentRoutes 列表中对应的条目匹配。
`namespace`	`字符串`	namespace 是要自定义的路由的命名空间。它必须是实际的命名空间。使用实际命名空间可确保没有两个组件冲突，并且可以多次安装同一组件。如果要自定义路由，则此组件的路由的命名空间和名称必须与 spec.componentRoutes 列表中对应的条目匹配。
`relatedObjects`	`array`	relatedObjects 是资源列表，在调试或检查如何应用 spec.componentRoutes 时很有用。
`relatedObjects[]`	`对象`	ObjectReference 包含足够信息供您检查或修改引用的对象。

14.1.17. .status.componentRoutes[].conditions
复制链接

描述: 条件用于传达 componentRoutes 条目的状态。支持的条件包括 Available、Degraded 和 Progressing。如果可用，则路由提供的内容可以被用户访问。这包括在配置 cluster-admin 指定的自定义路由时默认可能会继续提供内容。如果 Degraded 为 true，这意味着无法尝试处理 componentRoutes 条目。currentHostnames 字段可能或可能无效。如果 Progressing 为 true，这意味着组件正在执行与 componentRoutes 条目相关的一些操作。
类型: array

14.1.18. .status.componentRoutes[].conditions[]
复制链接

描述

类型

object

必填

lastTransitionTime
message
reason
status
type

Expand

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。
`message`	`字符串`	Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。
`observedGeneration`	`整数`	observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。
`reason`	`字符串`	reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)

14.1.19. .status.componentRoutes[].relatedObjects
复制链接

描述: relatedObjects 是资源列表，在调试或检查如何应用 spec.componentRoutes 时很有用。
类型: array

14.1.20. .status.componentRoutes[].relatedObjects[]
复制链接

描述

ObjectReference 包含足够信息供您检查或修改引用的对象。

类型

object

必填

group
name
resource

Expand

属性	类型	描述
`group`	`字符串`	引用的组。
`name`	`字符串`	引用的名称。
`namespace`	`字符串`	引用的命名空间。
`resource`	`字符串`	引用的资源。

14.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/ingresses
- DELETE ：删除 Ingress 集合
- GET: 列出类型为 Ingress 的对象
- POST ：创建 Ingress
/apis/config.openshift.io/v1/ingresses/{name}
- DELETE ：删除 Ingress
- GET ：读取指定的 Ingress
- PATCH: 部分更新指定的 Ingress
- PUT ：替换指定的 Ingress
/apis/config.openshift.io/v1/ingresses/{name}/status
- GET ：指定 Ingress 的读取状态
- PATCH: 部分更新指定 Ingress 的状态
- PUT ：替换指定 Ingress 的状态

14.2.1. /apis/config.openshift.io/v1/ingresses
复制链接

Expand

表 14.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 Ingress 集合

Expand

表 14.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 14.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 Ingress 类型的对象

Expand

表 14.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 14.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`IngressList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 Ingress

Expand

表 14.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 14.7. 主体参数
参数	类型	描述
`正文（body）`	`Ingress` 模式

Expand

表 14.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Ingress` 模式
201 - Created	`Ingress` 模式
202 - Accepted	`Ingress` 模式
401 - Unauthorized	空

14.2.2. /apis/config.openshift.io/v1/ingresses/{name}
复制链接

Expand

表 14.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	Ingress 的名称

Expand

表 14.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 Ingress

Expand

表 14.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 14.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 14.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的 Ingress

Expand

表 14.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 14.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Ingress` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 Ingress

Expand

表 14.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 14.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 14.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Ingress` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 Ingress

Expand

表 14.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 14.20. 主体参数
参数	类型	描述
`正文（body）`	`Ingress` 模式

Expand

表 14.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Ingress` 模式
201 - Created	`Ingress` 模式
401 - Unauthorized	空

14.2.3. /apis/config.openshift.io/v1/ingresses/{name}/status
复制链接

Expand

表 14.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	Ingress 的名称

Expand

表 14.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 Ingress 的读取状态

Expand

表 14.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 14.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Ingress` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 Ingress 的状态

Expand

表 14.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 14.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 14.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Ingress` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 Ingress 的状态

Expand

表 14.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 14.30. 主体参数
参数	类型	描述
`正文（body）`	`Ingress` 模式

Expand

表 14.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Ingress` 模式
201 - Created	`Ingress` 模式
401 - Unauthorized	空

第 15 章 Network [config.openshift.io/v1]
复制链接

描述

网络包含有关网络的集群范围信息。规范名称 为集群。它用于配置所需的网络配置，例如：用于服务/pod IP、网络插件等的 IP 地址池。有关配置此资源时的信息，请查看 network.spec。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

15.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值。作为一般规则，不会直接读取此 SHOULD。相反，您应该使用 NetworkStatus，因为它表示当前部署的配置。目前，大多数 spec 字段在安装后都是不可变的。请查看各个类别以了解每个人的更多详情。
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

15.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值。作为一般规则，不会直接读取此 SHOULD。相反，您应该使用 NetworkStatus，因为它表示当前部署的配置。目前，大多数 spec 字段在安装后都是不可变的。请查看各个类别以了解每个人的更多详情。
类型: object

Expand

属性	类型	描述
`clusterNetwork`	`array`	用于 pod IP 的 IP 地址池。在安装后，此字段是不可变的。
`clusterNetwork[]`	`对象`	ClusterNetworkEntry 是从中分配 pod IP 地址的连续块。
`externalIP`	`对象`	ExternalIP 为影响 Service.ExternalIP 的控制器定义配置。如果为 nil，则不允许设置 ExternalIP。
`networkType`	`字符串`	networkType 是要部署的插件（如 OpenShiftSDN）。这应该与 cluster-network-operator 理解的值匹配，否则不会安装任何网络。目前支持的值有： - OpenShiftSDN this field after installation.
`serviceNetwork`	`数组（字符串）`	服务的 IP 地址池.目前，我们只支持一个条目。在安装后，此字段是不可变的。
`serviceNodePortRange`	`字符串`	端口范围允许用于 NodePort 类型的服务。如果没有指定，则使用默认值 30000-32767。未指定 NodePort 的此类服务将从此范围内自动分配。可在安装集群后更新此参数。

15.1.2. .spec.clusterNetwork
复制链接

描述: 用于 pod IP 的 IP 地址池。在安装后，此字段是不可变的。
类型: array

15.1.3. .spec.clusterNetwork[]
复制链接

描述: ClusterNetworkEntry 是从中分配 pod IP 地址的连续块。
类型: object

Expand

属性	类型	描述
`cidr`	`字符串`	pod IP 的完整块。
`hostPrefix`	`整数`	分配给每个节点的块的大小（前缀）。如果插件没有使用此字段，则可以取消设置它。

15.1.4. .spec.externalIP
复制链接

描述: ExternalIP 为影响 Service.ExternalIP 的控制器定义配置。如果为 nil，则不允许设置 ExternalIP。
类型: object

Expand

属性	类型	描述
`autoAssignCIDRs`	`数组（字符串）`	autoAssignCIDRs 是自动分配 Service.ExternalIP 的 CIDR 列表。当服务是 LoadBalancer 类型时，会分配它们。通常，这仅适用于裸机集群。在 Openshift 3.x 中，这被误认为是"IngressIPs"。自动分配外部 IP 不会受到任何 ExternalIPPolicy 规则的影响。目前，只能提供一个条目。
`policy`	`对象`	policy 是应用于 ExternalIP 字段的一组限制。如果为 nil 或空，则不允许设置 ExternalIP。

15.1.5. .spec.externalIP.policy
复制链接

描述: policy 是应用于 ExternalIP 字段的一组限制。如果为 nil 或空，则不允许设置 ExternalIP。
类型: object

Expand

属性	类型	描述
`allowedCIDRs`	`数组（字符串）`	allowedCIDRs 是允许的 CIDR 列表。
`rejectedCIDRs`	`数组（字符串）`	rejectedCIDRs 是禁止的 CIDR 列表。它们优先于 allowedCIDRs。

15.1.6. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

Expand

属性	类型	描述
`clusterNetwork`	`array`	用于 pod IP 的 IP 地址池。
`clusterNetwork[]`	`对象`	ClusterNetworkEntry 是从中分配 pod IP 地址的连续块。
`clusterNetworkMTU`	`整数`	clusterNetworkMTU 是 pod 网络间的 MTU。
`迁移`	`对象`	迁移包含集群网络迁移配置。
`networkType`	`字符串`	networkType 是部署的插件（如 OpenShiftSDN）。
`serviceNetwork`	`数组（字符串）`	服务的 IP 地址池.目前，我们只支持一个条目。

15.1.7. .status.clusterNetwork
复制链接

描述: 用于 pod IP 的 IP 地址池。
类型: array

15.1.8. .status.clusterNetwork[]
复制链接

描述: ClusterNetworkEntry 是从中分配 pod IP 地址的连续块。
类型: object

Expand

属性	类型	描述
`cidr`	`字符串`	pod IP 的完整块。
`hostPrefix`	`整数`	分配给每个节点的块的大小（前缀）。如果插件没有使用此字段，则可以取消设置它。

15.1.9. .status.migration
复制链接

描述: 迁移包含集群网络迁移配置。
类型: object

Expand

属性	类型	描述
`mtu`	`object`	MTU 包含 MTU 迁移配置。
`networkType`	`字符串`	networkType 是要部署的目标插件。目前支持的值有： OpenShiftSDN、OVNKubernetes

15.1.10. .status.migration.mtu
复制链接

描述: MTU 包含 MTU 迁移配置。
类型: object

Expand

属性	类型	描述
`机器`	`object`	机器包含机器的 uplink 的 MTU 迁移配置。
`network`	`object`	network 包含 default 网络的 MTU 迁移配置。

15.1.11. .status.migration.mtu.machine
复制链接

描述: 机器包含机器的 uplink 的 MTU 迁移配置。
类型: object

Expand

属性	类型	描述
`from`	`整数`	从是要从中迁移的 MTU。
`至`	`整数`	要迁移到的 MTU。

15.1.12. .status.migration.mtu.network
复制链接

描述: network 包含 default 网络的 MTU 迁移配置。
类型: object

Expand

属性	类型	描述
`from`	`整数`	从是要从中迁移的 MTU。
`至`	`整数`	要迁移到的 MTU。

15.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/networks
- DELETE ：删除网络集合
- GET: 列出类型为 Network 的对象
- POST ：创建网络
/apis/config.openshift.io/v1/networks/{name}
- DELETE ：删除网络
- GET ：读取指定的网络
- PATCH: 部分更新指定的网络
- PUT ：替换指定的网络

15.2.1. /apis/config.openshift.io/v1/networks
复制链接

Expand

表 15.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除网络集合

Expand

表 15.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 15.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出类型为 Network 的对象

Expand

表 15.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 15.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`NetworkList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建网络

Expand

表 15.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 15.7. 主体参数
参数	类型	描述
`正文（body）`	`Network` 模式

Expand

表 15.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Network` 模式
201 - Created	`Network` 模式
202 - Accepted	`Network` 模式
401 - Unauthorized	空

15.2.2. /apis/config.openshift.io/v1/networks/{name}
复制链接

Expand

表 15.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	网络的名称

Expand

表 15.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除网络

Expand

表 15.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 15.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 15.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的网络

Expand

表 15.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 15.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Network` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的网络

Expand

表 15.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 15.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 15.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Network` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的网络

Expand

表 15.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 15.20. 主体参数
参数	类型	描述
`正文（body）`	`Network` 模式

Expand

表 15.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Network` 模式
201 - Created	`Network` 模式
401 - Unauthorized	空

第 16 章 Node [config.openshift.io/v1]
复制链接

描述

节点包含有关节点特定功能的集群范围信息。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

16.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`object`	status 包含观察到的值。

16.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`cgroupMode`	`string`	cgroupMode 决定节点上的 cgroups 版本
`workerLatencyProfile`	`string`	workerLatencyProfile 确定 kubelet 更新状态和对集群的反应的速度

16.1.2. .status
复制链接

描述: status 包含观察到的值。
类型: object

16.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/nodes
- DELETE ：删除节点集合
- GET ：列出类型为 Node 的对象
- POST ：创建节点
/apis/config.openshift.io/v1/nodes/{name}
- DELETE ：删除节点
- GET ：读取指定的节点
- PATCH: 部分更新指定节点
- PUT ：替换指定的节点
/apis/config.openshift.io/v1/nodes/{name}/status
- GET ：指定节点的读取状态
- PATCH: 部分更新指定节点的状态
- PUT ：替换指定节点的状态

16.2.1. /apis/config.openshift.io/v1/nodes
复制链接

Expand

表 16.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除节点集合

Expand

表 16.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 16.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出类型为 Node 的对象

Expand

表 16.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 16.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`NodeList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建节点

Expand

表 16.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 16.7. 主体参数
参数	类型	描述
`正文（body）`	`Node` 模式

Expand

表 16.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
201 - Created	`Node` 模式
202 - Accepted	`Node` 模式
401 - Unauthorized	空

16.2.2. /apis/config.openshift.io/v1/nodes/{name}
复制链接

Expand

表 16.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	节点的名称

Expand

表 16.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除节点

Expand

表 16.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 16.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 16.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的节点

Expand

表 16.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 16.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定节点

Expand

表 16.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 16.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 16.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的节点

Expand

表 16.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 16.20. 主体参数
参数	类型	描述
`正文（body）`	`Node` 模式

Expand

表 16.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
201 - Created	`Node` 模式
401 - Unauthorized	空

16.2.3. /apis/config.openshift.io/v1/nodes/{name}/status
复制链接

Expand

表 16.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	节点的名称

Expand

表 16.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定节点的读取状态

Expand

表 16.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 16.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定节点的状态

Expand

表 16.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 16.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 16.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定节点的状态

Expand

表 16.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 16.30. 主体参数
参数	类型	描述
`正文（body）`	`Node` 模式

Expand

表 16.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Node` 模式
201 - Created	`Node` 模式
401 - Unauthorized	空

第 17 章 OAuth [config.openshift.io/v1]
复制链接

描述

OAuth 包含有关 OAuth 的集群范围信息。规范名称 为集群。它用于配置集成的 OAuth 服务器。只有在顶层身份验证配置类型设置为 IntegratedOAuth 时，才会满足此配置。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

17.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

17.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`identityProviders`	`array`	identityProviders 是用户标识自身的方式的有序列表。当此列表为空时，不会为用户置备身份。
`identityProviders[]`	`对象`	IdentityProvider 为使用凭证进行身份验证的用户提供身份
`templates`	`对象`	模板允许您自定义登录页面等页面。
`tokenConfig`	`对象`	tokenConfig 包含授权和访问令牌的选项

17.1.2. .spec.identityProviders
复制链接

描述: identityProviders 是用户标识自身的方式的有序列表。当此列表为空时，不会为用户置备身份。
类型: array

17.1.3. .spec.identityProviders[]
复制链接

描述: IdentityProvider 为使用凭证进行身份验证的用户提供身份
类型: object

Expand

属性	类型	描述
`basicAuth`	`对象`	basicAuth 包含 BasicAuth IdP 的配置选项
`github`	`对象`	GitHub 使用 GitHub 凭证启用用户身份验证
`gitlab`	`对象`	GitLab 使用 GitLab 凭证启用用户身份验证
`google`	`对象`	Google 使用 Google 凭证启用用户身份验证
`htpasswd`	`对象`	htpasswd 使用 HTPasswd 文件启用用户身份验证来验证凭证
`keystone`	`对象`	Keystone 使用 Keystone 密码凭证启用用户身份验证
`ldap`	`对象`	LDAP 使用 LDAP 凭证启用用户身份验证
`mappingMethod`	`字符串`	mappingMethod 决定此提供程序的身份如何映射到用户 Defaults 到 "claim"
`name`	`字符串`	name 用于验证此提供程序返回的身份。- 它必须是唯一的且不由所使用的任何其他身份提供程序共享 - 它必须是有效的路径片段：name cannot equal "." 或 ".."。或者包含 "/" 或 "%" 或 ":" Ref: https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName
`openID`	`对象`	OpenID 启用使用 OpenID 凭证进行用户身份验证
`requestHeader`	`对象`	requestHeader 使用请求标头凭证启用用户身份验证
`type`	`字符串`	type 标识此条目的身份提供程序类型。

17.1.4. .spec.identityProviders[].basicAuth
复制链接

描述: basicAuth 包含 BasicAuth IdP 的配置选项
类型: object

Expand

属性	类型	描述
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。"ca.crt"键用于查找数据。如果指定且未找到配置映射或预期的密钥，则不会满足身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。若为空，则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
`tlsClientCert`	`对象`	tlsClientCert 是按名称对 secret 的可选引用，其中包含连接到服务器时可用的 PEM 编码 TLS 客户端证书。键 "tls.crt" 用于查找数据。如果指定且未找到 secret 或预期密钥，则不会遵守身份提供程序。如果指定的证书数据无效，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`tlsClientKey`	`对象`	tlsClientKey 是名称对 secret 的可选引用，其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。"tls.key"键用于查找数据。如果指定且未找到 secret 或预期密钥，则不会遵守身份提供程序。如果指定的证书数据无效，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`url`	`字符串`	URL 是要连接的远程 URL

17.1.5. .spec.identityProviders[].basicAuth.ca
复制链接

描述

CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。"ca.crt"键用于查找数据。如果指定且未找到配置映射或预期的密钥，则不会满足身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。若为空，则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

17.1.6. .spec.identityProviders[].basicAuth.tlsClientCert
复制链接

描述

tlsClientCert 是按名称对 secret 的可选引用，其中包含连接到服务器时可用的 PEM 编码 TLS 客户端证书。键 "tls.crt" 用于查找数据。如果指定且未找到 secret 或预期密钥，则不会遵守身份提供程序。如果指定的证书数据无效，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.7. .spec.identityProviders[].basicAuth.tlsClientKey
复制链接

描述

tlsClientKey 是名称对 secret 的可选引用，其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。"tls.key"键用于查找数据。如果指定且未找到 secret 或预期密钥，则不会遵守身份提供程序。如果指定的证书数据无效，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.8. .spec.identityProviders[].github
复制链接

描述: GitHub 使用 GitHub 凭证启用用户身份验证
类型: object

Expand

属性	类型	描述
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。"ca.crt"键用于查找数据。如果指定且未找到配置映射或预期的密钥，则不会满足身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。若为空，则使用默认的系统根证书。这只能在主机名设置为非空值时才进行配置。此配置映射的命名空间是 openshift-config。
`clientID`	`字符串`	clientId 是 oauth 客户端 ID
`clientSecret`	`对象`	clientSecret 是包含 oauth 客户端 secret 的名称所需的 secret 引用。"clientSecret"键用于查找数据。如果没有找到 secret 或预期密钥，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`主机名`	`字符串`	hostname 是可选域（如 "mycompany.com"）用于托管 GitHub Enterprise 实例。它必须与在 /setup/settings"hostname 中配置的 GitHub Enterprise 设置值匹配。
`机构`	`数组（字符串）`	机构（可选）限制允许哪些机构登录
`团队`	`数组（字符串）`	团队（可选）限制允许哪些团队登录。格式为 <org>/<team>。

17.1.9. .spec.identityProviders[].github.ca
复制链接

描述

CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。"ca.crt"键用于查找数据。如果指定且未找到配置映射或预期的密钥，则不会满足身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。若为空，则使用默认的系统根证书。这只能在主机名设置为非空值时才进行配置。此配置映射的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

17.1.10. .spec.identityProviders[].github.clientSecret
复制链接

描述

clientSecret 是包含 oauth 客户端 secret 的名称所需的 secret 引用。"clientSecret"键用于查找数据。如果没有找到 secret 或预期密钥，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.11. .spec.identityProviders[].gitlab
复制链接

描述: GitLab 使用 GitLab 凭证启用用户身份验证
类型: object

Expand

属性	类型	描述
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。"ca.crt"键用于查找数据。如果指定且未找到配置映射或预期的密钥，则不会满足身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。若为空，则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
`clientID`	`字符串`	clientId 是 oauth 客户端 ID
`clientSecret`	`对象`	clientSecret 是包含 oauth 客户端 secret 的名称所需的 secret 引用。"clientSecret"键用于查找数据。如果没有找到 secret 或预期密钥，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`url`	`字符串`	URL 是 oauth 服务器基本 URL

17.1.12. .spec.identityProviders[].gitlab.ca
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

17.1.13. .spec.identityProviders[].gitlab.clientSecret
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.14. .spec.identityProviders[].google
复制链接

描述: Google 使用 Google 凭证启用用户身份验证
类型: object

Expand

属性	类型	描述
`clientID`	`字符串`	clientId 是 oauth 客户端 ID
`clientSecret`	`对象`	clientSecret 是包含 oauth 客户端 secret 的名称所需的 secret 引用。"clientSecret"键用于查找数据。如果没有找到 secret 或预期密钥，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`hostedDomain`	`字符串`	hostedDomain 是可选的 Google App 域（如 "mycompany.com"），用于限制登录

17.1.15. .spec.identityProviders[].google.clientSecret
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.16. .spec.identityProviders[].htpasswd
复制链接

描述: htpasswd 使用 HTPasswd 文件启用用户身份验证来验证凭证
类型: object

Expand

属性	类型	描述
`fileData`	`对象`	fileData 是按照名称引用 secret，其中包含要用作 htpasswd 文件的数据。"htpasswd"键用于查找数据。如果没有找到 secret 或预期密钥，则不会遵守身份提供程序。如果指定的 htpasswd 数据无效，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

17.1.17. .spec.identityProviders[].htpasswd.fileData
复制链接

描述

fileData 是按照名称引用 secret，其中包含要用作 htpasswd 文件的数据。"htpasswd"键用于查找数据。如果没有找到 secret 或预期密钥，则不会遵守身份提供程序。如果指定的 htpasswd 数据无效，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.18. .spec.identityProviders[].keystone
复制链接

描述: Keystone 使用 Keystone 密码凭证启用用户身份验证
类型: object

Expand

属性	类型	描述
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。"ca.crt"键用于查找数据。如果指定且未找到配置映射或预期的密钥，则不会满足身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。若为空，则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
`domainName`	`字符串`	keystone v3 需要 domainname
`tlsClientCert`	`对象`	tlsClientCert 是按名称对 secret 的可选引用，其中包含连接到服务器时可用的 PEM 编码 TLS 客户端证书。键 "tls.crt" 用于查找数据。如果指定且未找到 secret 或预期密钥，则不会遵守身份提供程序。如果指定的证书数据无效，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`tlsClientKey`	`对象`	tlsClientKey 是名称对 secret 的可选引用，其中包含 tlsClientCert 中引用的客户端证书的 PEM 编码 TLS 私钥。"tls.key"键用于查找数据。如果指定且未找到 secret 或预期密钥，则不会遵守身份提供程序。如果指定的证书数据无效，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`url`	`字符串`	URL 是要连接的远程 URL

17.1.19. .spec.identityProviders[].keystone.ca
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

17.1.20. .spec.identityProviders[].keystone.tlsClientCert
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.21. .spec.identityProviders[].keystone.tlsClientKey
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.22. .spec.identityProviders[].ldap
复制链接

描述: LDAP 使用 LDAP 凭证启用用户身份验证
类型: object

Expand

属性	类型	描述
`属性`	`对象`	属性将 LDAP 属性映射到身份
`bindDN`	`字符串`	bindDN 是一个在搜索阶段要绑定的可选 DN。
`bindPassword`	`对象`	bindPassword 是按照名称对 secret 的可选引用，其中包含要在搜索阶段绑定的密码。键"bindPassword"用于查找数据。如果指定且未找到 secret 或预期密钥，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。"ca.crt"键用于查找数据。如果指定且未找到配置映射或预期的密钥，则不会满足身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。若为空，则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
`insecure`	`布尔值`	insecure，如果为 true，则表示连接不应使用 TLS WARNING: Should not be set to `true`，URL scheme "ldaps://" URL 总是尝试使用 TLS 进行连接，即使 `insecure` 设为 `true` ，"ldap://" URLS 连接不安全时也是如此。当为 `false` 时，使用 https://tools.ietf.org/html/rfc2830 中指定的 StartTLS 将 "ldap://" URL 升级到 TLS 连接。
`url`	`字符串`	URL 是 RFC 2255 URL，指定要使用的 LDAP 搜索参数。URL 的语法为： ldap://host:port/basedn?attribute?scope?filter

17.1.23. .spec.identityProviders[].ldap.attributes
复制链接

描述: 属性将 LDAP 属性映射到身份
类型: object

Expand

属性	类型	描述
`email`	`数组（字符串）`	email 是属性列表，其值应用作电子邮件地址。可选。如果未指定，则不会为身份设置电子邮件
`id`	`数组（字符串）`	id 是值应用作用户 ID 的属性列表。必需。使用第一个非空属性。至少需要一个属性。如果列出的属性都没有值，身份验证会失败。LDAP 标准身份属性是 "dn"
`name`	`数组（字符串）`	name 是属性的列表，其值应用作显示名称。可选。如果未指定，则不会为身份 LDAP 标准显示名称属性设置显示名称"cn"
`preferredUsername`	`数组（字符串）`	preferredUsername 是属性列表，其值应用作首选用户名。LDAP 标准登录属性是"uid"

17.1.24. .spec.identityProviders[].ldap.bindPassword
复制链接

描述

bindPassword 是按照名称对 secret 的可选引用，其中包含要在搜索阶段绑定的密码。键"bindPassword"用于查找数据。如果指定且未找到 secret 或预期密钥，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.25. .spec.identityProviders[].ldap.ca
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

17.1.26. .spec.identityProviders[].openID
复制链接

描述: OpenID 启用使用 OpenID 凭证进行用户身份验证
类型: object

Expand

属性	类型	描述
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。"ca.crt"键用于查找数据。如果指定且未找到配置映射或预期的密钥，则不会满足身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。若为空，则使用默认的系统根证书。此配置映射的命名空间是 openshift-config。
`声明`	`对象`	声明映射
`clientID`	`字符串`	clientId 是 oauth 客户端 ID
`clientSecret`	`对象`	clientSecret 是包含 oauth 客户端 secret 的名称所需的 secret 引用。"clientSecret"键用于查找数据。如果没有找到 secret 或预期密钥，则不会遵守身份提供程序。此 secret 的命名空间是 openshift-config。
`extraAuthorizeParameters`	`对象（字符串）`	extraAuthorizeParameters 是添加到授权请求的任何自定义参数。
`extraScopes`	`数组（字符串）`	extraScope 除了标准"openid"范围外，还具有请求的任何范围。
`Issuer`	`字符串`	issuer 是 OpenID 提供程序断言作为其颁发者标识符的 URL。它必须使用没有查询或片段组件的 https 方案。

17.1.27. .spec.identityProviders[].openID.ca
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

17.1.28. .spec.identityProviders[].openID.claims
复制链接

描述: 声明映射
类型: object

Expand

属性	类型	描述
`email`	`数组（字符串）`	email 是应将其值用作电子邮件地址的声明列表。可选。如果未指定，则不会为身份设置电子邮件
`groups`	`数组（字符串）`	groups 是操作的声明值列表，用于为用户将组从 OIDC 供应商同步到 OpenShift。如果指定了多个声明，则使用第一个带有非空值的声明。
`name`	`数组（字符串）`	name 是应用作显示名称的声明的列表。可选。如果未指定，则不会为身份设置显示名称
`preferredUsername`	`数组（字符串）`	preferredUsername 是应用作首选用户名的声明列表。如果未指定，则首选用户名由子声明的值决定

17.1.29. .spec.identityProviders[].openID.clientSecret
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.30. .spec.identityProviders[].requestHeader
复制链接

描述: requestHeader 使用请求标头凭证启用用户身份验证
类型: object

Expand

属性	类型	描述
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的必要引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。具体来说，它允许验证传入的请求以防止标头欺骗。"ca.crt"键用于查找数据。如果没有找到配置映射或预期密钥，则不会遵守身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。此配置映射的命名空间是 openshift-config。
`challengeURL`	`字符串`	challengeURL 是一个 URL，用于将未经身份验证的 /authorize 请求重定向到来自 OAuth 客户端的未验证请求，该请求希望在此处重定向 WWW-Authenticate 质询。${url} 替换为当前的 URL，进行转义，在查询参数 https://www.example.com/sso-login?then=${url} ${query} 替换为当前查询字符串 https://www.example.com/auth-proxy/oauth/authorize?${query} 必需（当 challenge 设置为 true 时）。
`clientCommonNames`	`数组（字符串）`	clientCommonNames 是需要匹配的一个可选名称列表。如果为空，则针对 clientCA 捆绑包验证的任何客户端证书都将被视为权威。
`emailHeaders`	`数组（字符串）`	emailHeaders 是一组用于检查电子邮件地址的标头
`标头`	`数组（字符串）`	标头是一组用于检查身份信息的标头
`loginURL`	`字符串`	loginURL 是一个 URL，用于将未经身份验证的 /authorize 请求重定向到来自 OAuth 客户端的 Unauthenticated 请求，预期在此 ${url} 被重定向为当前 URL，进行转义以在查询参数中安全 https://www.example.com/sso-login?then=${url} ${query} 替换为当前查询字符串 https://www.example.com/auth-proxy/oauth/authorize?${query} 必需。
`nameHeaders`	`数组（字符串）`	nameHeaders 是一组用于检查显示名称的标头
`preferredUsernameHeaders`	`数组（字符串）`	preferredUsernameHeaders 是一组用于检查首选用户名的标头

17.1.31. .spec.identityProviders[].requestHeader.ca
复制链接

描述

CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的必要引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。具体来说，它允许验证传入的请求以防止标头欺骗。"ca.crt"键用于查找数据。如果没有找到配置映射或预期密钥，则不会遵守身份提供程序。如果指定的 ca 数据无效，则不会遵守身份提供程序。此配置映射的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

17.1.32. .spec.templates
复制链接

描述: 模板允许您自定义登录页面等页面。
类型: object

Expand

属性	类型	描述
`错误`	`对象`	error 是 secret 的名称，用于指定在身份验证或授权流期间用来呈现错误页面的 go 模板。"errors.html"键用于查找模板数据。如果指定且未找到 secret 或预期键，则会使用默认错误页面。如果指定的模板无效，则使用默认错误页面。如果未指定，则使用默认错误页面。此 secret 的命名空间是 openshift-config。
`login`	`对象`	login 是 secret 的名称，用于指定用来呈现登录页面的 go 模板。"login.html"密钥用于查找模板数据。如果指定且未找到 secret 或预期密钥，则会使用默认的登录页面。如果指定的模板无效，则使用默认登录页面。如果未指定，则使用默认登录页面。此 secret 的命名空间是 openshift-config。
`providerSelection`	`对象`	providerSelection 是 secret 的名称，用于指定用来呈现供应商选择页面的 go 模板。"providers.html" 键用于查找模板数据。如果指定且未找到 secret 或预期密钥，则会使用默认供应商选择页面。如果指定模板无效，则使用默认供应商选择页面。如果未指定，则使用默认供应商选择页面。此 secret 的命名空间是 openshift-config。

17.1.33. .spec.templates.error
复制链接

描述

error 是 secret 的名称，用于指定在身份验证或授权流期间用来呈现错误页面的 go 模板。"errors.html"键用于查找模板数据。如果指定且未找到 secret 或预期键，则会使用默认错误页面。如果指定的模板无效，则使用默认错误页面。如果未指定，则使用默认错误页面。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

描述

login 是 secret 的名称，用于指定用来呈现登录页面的 go 模板。"login.html"密钥用于查找模板数据。如果指定且未找到 secret 或预期密钥，则会使用默认的登录页面。如果指定的模板无效，则使用默认登录页面。如果未指定，则使用默认登录页面。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.35. .spec.templates.providerSelection
复制链接

描述

providerSelection 是 secret 的名称，用于指定用来呈现供应商选择页面的 go 模板。"providers.html" 键用于查找模板数据。如果指定且未找到 secret 或预期密钥，则会使用默认供应商选择页面。如果指定模板无效，则使用默认供应商选择页面。如果未指定，则使用默认供应商选择页面。此 secret 的命名空间是 openshift-config。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

17.1.36. .spec.tokenConfig
复制链接

描述: tokenConfig 包含授权和访问令牌的选项
类型: object

Expand

属性	类型	描述
`accessTokenInactivityTimeout`	`字符串`	accessTokenInactivityTimeout 为任何客户端授予的令牌定义令牌不活跃超时。该值代表令牌连续使用之间可持续发生的最长时间。如果在这个时时窗口中不使用令牌，则令牌将变为无效。用户将在令牌超时后获取新令牌，以便重新获得访问。使用有效的持续时间字符串，如 "5m", "1.5h" 或 "2h45m"。持续时间允许的最小值为 300s (5 分钟)。如果为每个客户端配置了超时，则该值将具有优先权。如果没有指定超时值，且客户端不会覆盖值，则令牌在其生命周期前有效。警告：通过更改此值，现有令牌的超时时间不会受到影响（降低）
`accessTokenInactivityTimeoutSeconds`	`整数`	accessTokenInactivityTimeoutSeconds - DEPRECATED: 设置此字段无效。
`accessTokenMaxAgeSeconds`	`整数`	accessTokenMaxAgeSeconds 定义访问令牌的最长期限

17.1.37. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

17.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/oauths
- DELETE ：删除 OAuth 集合
- GET: 列出类型为 OAuth 的对象
- POST ：创建 OAuth
/apis/config.openshift.io/v1/oauths/{name}
- DELETE ：删除 OAuth
- GET ：读取指定的 OAuth
- PATCH: 部分更新指定的 OAuth
- PUT ：替换指定的 OAuth
/apis/config.openshift.io/v1/oauths/{name}/status
- GET ：指定 OAuth 的读取状态
- PATCH: 部分更新指定 OAuth 的状态
- PUT ：替换指定 OAuth 的状态

17.2.1. /apis/config.openshift.io/v1/oauths
复制链接

Expand

表 17.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 OAuth 集合

Expand

表 17.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 17.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 OAuth 类型的对象

Expand

表 17.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 17.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OAuthList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 OAuth

Expand

表 17.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 17.7. 主体参数
参数	类型	描述
`正文（body）`	`OAuth` 模式

Expand

表 17.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OAuth` 模式
201 - Created	`OAuth` 模式
202 - Accepted	`OAuth` 模式
401 - Unauthorized	空

17.2.2. /apis/config.openshift.io/v1/oauths/{name}
复制链接

Expand

表 17.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	OAuth 的名称

Expand

表 17.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 OAuth

Expand

表 17.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 17.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 17.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的 OAuth

Expand

表 17.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 17.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OAuth` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 OAuth

Expand

表 17.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 17.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 17.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OAuth` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 OAuth

Expand

表 17.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 17.20. 主体参数
参数	类型	描述
`正文（body）`	`OAuth` 模式

Expand

表 17.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OAuth` 模式
201 - Created	`OAuth` 模式
401 - Unauthorized	空

17.2.3. /apis/config.openshift.io/v1/oauths/{name}/status
复制链接

Expand

表 17.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	OAuth 的名称

Expand

表 17.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 OAuth 的读取状态

Expand

表 17.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 17.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OAuth` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 指定 OAuth 的部分更新状态

Expand

表 17.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 17.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 17.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OAuth` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 OAuth 的状态

Expand

表 17.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 17.30. 主体参数
参数	类型	描述
`正文（body）`	`OAuth` 模式

Expand

表 17.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OAuth` 模式
201 - Created	`OAuth` 模式
401 - Unauthorized	空

第 18 章 OperatorHub [config.openshift.io/v1]
复制链接

描述: OperatorHub 是 operatorhubs API 的 Schema。它可用于将集群中 OperatorHub 的默认 hub 源的状态从 enabled 改为 disabled，反之亦然。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
类型: 对象

18.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	OperatorHubSpec 定义 OperatorHub 的所需状态
`status`	`对象`	OperatorHubStatus 定义 OperatorHub 的观察状态。默认 hub 源的当前状态将始终反映在此处。

18.1.1. .spec
复制链接

描述: OperatorHubSpec 定义 OperatorHub 的所需状态
类型: object

Expand

属性	类型	描述
`disableAllDefaultSources`	`布尔值`	disableAllDefaultSources 允许您禁用所有默认 hub 源。如果这是 true，则可以使用源中的特定条目来启用默认源。如果这是 false，则可以使用源中的特定条目来禁用或启用默认源。
`sources`	`array`	sources 是默认 hub 源及其配置列表。如果列表为空，这表示集群中启用了默认 hub 源，除非 disableAllDefaultSources 为 true。如果 disableAllDefaultSources 为 true，且源不为空，则源中的配置将具有优先权。默认 hub 源及其当前状态列表将始终反映在 status 块中。
`sources[]`	`对象`	HubSource 用于指定 hub 源及其配置

18.1.2. .spec.sources
复制链接

描述: sources 是默认 hub 源及其配置列表。如果列表为空，这表示集群中启用了默认 hub 源，除非 disableAllDefaultSources 为 true。如果 disableAllDefaultSources 为 true，且源不为空，则源中的配置将具有优先权。默认 hub 源及其当前状态列表将始终反映在 status 块中。
类型: array

18.1.3. .spec.sources[]
复制链接

描述: HubSource 用于指定 hub 源及其配置
类型: object

Expand

属性	类型	描述
`disabled`	`布尔值`	禁用用于在集群中禁用默认的 hub 源
`name`	`字符串`	name 是默认 hub 源之一的名称

18.1.4. .status
复制链接

描述: OperatorHubStatus 定义 OperatorHub 的观察状态。默认 hub 源的当前状态将始终反映在此处。
类型: object

Expand

属性	类型	描述
`sources`	`array`	源封装为每个 hub 源应用配置的结果
`sources[]`	`对象`	HubSourceStatus 用于反映将配置应用到默认源的当前状态

18.1.5. .status.sources
复制链接

描述: 源封装为每个 hub 源应用配置的结果
类型: array

18.1.6. .status.sources[]
复制链接

描述: HubSourceStatus 用于反映将配置应用到默认源的当前状态
类型: object

Expand

属性	类型	描述
`disabled`	`布尔值`	禁用用于在集群中禁用默认的 hub 源
`message`	`字符串`	Message 提供有关失败的更多信息
`name`	`字符串`	name 是默认 hub 源之一的名称
`status`	`字符串`	Status 表示应用配置中的成功或失败

18.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/operatorhubs
- DELETE ：删除 OperatorHub 集合
- GET ：列出 OperatorHub 类型的对象
- POST ：创建一个 OperatorHub
/apis/config.openshift.io/v1/operatorhubs/{name}
- DELETE ：删除 OperatorHub
- GET ：读取指定的 OperatorHub
- PATCH: 部分更新指定的 OperatorHub
- PUT ：替换指定的 OperatorHub
/apis/config.openshift.io/v1/operatorhubs/{name}/status
- GET ：指定 OperatorHub 的读取状态
- PATCH: 部分更新指定 OperatorHub 的状态
- PUT ：替换指定 OperatorHub 的状态

18.2.1. /apis/config.openshift.io/v1/operatorhubs
复制链接

Expand

表 18.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 OperatorHub 集合

Expand

表 18.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 18.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 OperatorHub 类型的对象

Expand

表 18.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 18.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OperatorHubList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建一个 OperatorHub

Expand

表 18.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 18.7. 主体参数
参数	类型	描述
`正文（body）`	`OperatorHub` 模式

Expand

表 18.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OperatorHub` 模式
201 - Created	`OperatorHub` 模式
202 - Accepted	`OperatorHub` 模式
401 - Unauthorized	空

18.2.2. /apis/config.openshift.io/v1/operatorhubs/{name}
复制链接

Expand

表 18.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	OperatorHub 的名称

Expand

表 18.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 OperatorHub

Expand

表 18.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 18.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 18.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 OperatorHub

Expand

表 18.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 18.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OperatorHub` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 OperatorHub

Expand

表 18.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 18.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 18.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OperatorHub` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 OperatorHub

Expand

表 18.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 18.20. 主体参数
参数	类型	描述
`正文（body）`	`OperatorHub` 模式

Expand

表 18.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OperatorHub` 模式
201 - Created	`OperatorHub` 模式
401 - Unauthorized	空

18.2.3. /apis/config.openshift.io/v1/operatorhubs/{name}/status
复制链接

Expand

表 18.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	OperatorHub 的名称

Expand

表 18.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 OperatorHub 的读取状态

Expand

表 18.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 18.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OperatorHub` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 OperatorHub 的状态

Expand

表 18.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 18.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 18.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OperatorHub` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 OperatorHub 的状态

Expand

表 18.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 18.30. 主体参数
参数	类型	描述
`正文（body）`	`OperatorHub` 模式

Expand

表 18.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`OperatorHub` 模式
201 - Created	`OperatorHub` 模式
401 - Unauthorized	空

第 19 章 Project [config.openshift.io/v1]
复制链接

描述

项目包含有关项目的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

19.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

19.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`projectRequestMessage`	`字符串`	如果无法通过 projectrequest api 端点请求项目，则向用户显示的字符串
`projectRequestTemplate`	`对象`	ProjectRequestTemplate 是响应 projectrequest 以创建项目时使用的模板。这必须指向 'openshift-config' 命名空间中的模板。它是可选的。如果没有指定，则使用默认模板。

19.1.2. .spec.projectRequestTemplate
复制链接

描述: ProjectRequestTemplate 是响应 projectrequest 以创建项目时使用的模板。这必须指向 'openshift-config' 命名空间中的模板。它是可选的。如果没有指定，则使用默认模板。
类型: object

Expand

属性	类型	描述
`name`	`字符串`	name 是引用项目请求模板的 metadata.name

19.1.3. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

19.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/projects
- DELETE ：删除项目集合
- GET: 列出类型为 Project 的对象
- POST ：创建项目
/apis/config.openshift.io/v1/projects/{name}
- DELETE ：删除项目
- GET ：读取指定的项目
- PATCH: 部分更新指定的项目
- PUT ：替换指定的项目
/apis/config.openshift.io/v1/projects/{name}/status
- GET ：指定项目的读取状态
- PATCH: 部分更新指定项目的状态
- PUT ：替换指定项目的状态

19.2.1. /apis/config.openshift.io/v1/projects
复制链接

Expand

表 19.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除项目集合

Expand

表 19.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 19.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出类型为 Project 的对象

Expand

表 19.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 19.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建一个项目

Expand

表 19.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 19.7. 主体参数
参数	类型	描述
`正文（body）`	`Project` 模式

Expand

表 19.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Project` 模式
201 - Created	`Project` 模式
202 - Accepted	`Project` 模式
401 - Unauthorized	空

19.2.2. /apis/config.openshift.io/v1/projects/{name}
复制链接

Expand

表 19.9. 全局路径参数
参数	类型	描述
`name`	`字符串`	项目的名称

Expand

表 19.10. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除项目

Expand

表 19.11. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 19.12. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 19.13. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 读取指定的项目

Expand

表 19.14. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 19.15. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Project` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的项目

Expand

表 19.16. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 19.17. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 19.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Project` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的项目

Expand

表 19.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 19.20. 主体参数
参数	类型	描述
`正文（body）`	`Project` 模式

Expand

表 19.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Project` 模式
201 - Created	`Project` 模式
401 - Unauthorized	空

19.2.3. /apis/config.openshift.io/v1/projects/{name}/status
复制链接

Expand

表 19.22. 全局路径参数
参数	类型	描述
`name`	`字符串`	项目的名称

Expand

表 19.23. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定项目的读取状态

Expand

表 19.24. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 19.25. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Project` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定项目的状态

Expand

表 19.26. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 19.27. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 19.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Project` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定项目的状态

Expand

表 19.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 19.30. 主体参数
参数	类型	描述
`正文（body）`	`Project` 模式

Expand

表 19.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Project` 模式
201 - Created	`Project` 模式
401 - Unauthorized	空

第 20 章 ProjectHelmChartRepository [helm.openshift.io/v1beta1]
复制链接

描述

ProjectHelmChartRepository 包含代理 Helm Chart 仓库兼容性级别 2 的命名空间范围的配置：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

20.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于配置的用户可设置值
`status`	`object`	观察命名空间中存储库的状态。

20.1.1. .spec
复制链接

描述: spec 包含用于配置的用户可设置值
类型: object

Expand

属性	类型	描述
`connectionConfig`	`对象`	连接到 chart 仓库所需的配置
`description`	`字符串`	可选人类可读的存储库描述，UI 可用于显示目的
`disabled`	`布尔值`	如果设置为 true，请在命名空间中禁用存储库使用情况
`名称`	`字符串`	可选关联的人类可读的存储库名称，供 UI 用于显示目的

20.1.2. .spec.connectionConfig
复制链接

描述: 连接到 chart 仓库所需的配置
类型: object

Expand

属性	类型	描述
`basicAuthConfig`	`object`	basicauthconfig 是按名称对 secret 的可选引用，其中包含连接服务器时要出现的基本身份验证凭证。使用键 "username" 找到用户名。键"password"用于查找密码。此 secret 的命名空间必须与项目 helm chart 存储库被实例化的命名空间相同。
`ca`	`对象`	CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。键 "ca-bundle.crt" 用于查找数据。若为空，则使用默认的系统根证书。此 configmap 的命名空间必须与项目 helm chart 存储库被实例化的命名空间相同。
`tlsClientConfig`	`对象`	tlsClientConfig 是按名称对 secret 的可选引用，其中包含连接到服务器时可用的 PEM 编码 TLS 客户端证书和私钥。键 "tls.crt" 用于查找客户端证书。"tls.key"密钥用于查找私钥。此 secret 的命名空间必须与项目 helm chart 存储库被实例化的命名空间相同。
`url`	`字符串`	Chart 仓库 URL

20.1.3. .spec.connectionConfig.basicAuthConfig
复制链接

描述

basicauthconfig 是按名称对 secret 的可选引用，其中包含连接服务器时要出现的基本身份验证凭证。使用键 "username" 找到用户名。键"password"用于查找密码。此 secret 的命名空间必须与项目 helm chart 存储库被实例化的命名空间相同。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

20.1.4. .spec.connectionConfig.ca
复制链接

描述

CA 是包含 PEM 编码 CA 捆绑包的名称对配置映射的可选引用。它被用作信任定位符，以验证远程服务器出示的 TLS 证书。键 "ca-bundle.crt" 用于查找数据。若为空，则使用默认的系统根证书。此 configmap 的命名空间必须与项目 helm chart 存储库被实例化的命名空间相同。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

20.1.5. .spec.connectionConfig.tlsClientConfig
复制链接

描述

tlsClientConfig 是按名称对 secret 的可选引用，其中包含连接到服务器时可用的 PEM 编码 TLS 客户端证书和私钥。键 "tls.crt" 用于查找客户端证书。"tls.key"密钥用于查找私钥。此 secret 的命名空间必须与项目 helm chart 存储库被实例化的命名空间相同。

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的 secret 的 metadata.name

20.1.6. .status
复制链接

描述: 观察命名空间中存储库的状态。
类型: object

Expand

属性	类型	描述
`conditions`	`array`	条件(Condition)是条件及其状态列表
`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 }

20.1.7. .status.conditions
复制链接

描述: 条件(Condition)是条件及其状态列表
类型: array

20.1.8. .status.conditions[]
复制链接

描述

类型

object

必填

lastTransitionTime
message
reason
status
type

Expand

属性	类型	描述
`lastTransitionTime`	`字符串`	lastTransitionTime 是条件从一个状态转换到另一个状态最后一次的时间。这应该是底层条件变化的时间。如果为未知，则使用 API 字段更改的时间是可以接受的。
`message`	`字符串`	Message 是人类可读的消息，指示有关转换的详细信息。这可能是一个空字符串。
`observedGeneration`	`整数`	observedGeneration 代表 .metadata.generation，这是条件设置所基于的条件。例如，如果 .metadata.generation 目前为 12，但 .status.conditions[x].observedGeneration 是 9，则代表条件与实例的当前状态已不匹配。
`reason`	`字符串`	reason 包含程序标识符，指示条件最后一次转换的原因。特定条件类型的制作者可能会定义预期的值和此字段的含义，以及这些值是否被视为有保证的 API。该值应该是 CamelCase 字符串。此字段可能不是空的。
`status`	`字符串`	条件的状态，True, False, Unknown 之一。
`type`	`字符串`	CamelCase 或 foo.example.com/CamelCase 中的条件类型。-- Many .condition.type 值在资源间是一致的，但因为任意条件可能很有用（请参阅 .node.status.conditions），deconflict 的能力非常重要。它匹配的正则表达式是 (dns1123SubdomainFmt/)? (qualifiedNameFmt)

20.2. API 端点
复制链接

可用的 API 端点如下：

/apis/helm.openshift.io/v1beta1/projecthelmchartrepositories
- GET: 列出类型为 ProjectHelmChartRepository 的对象
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories
- DELETE: 删除 ProjectHelmChartRepository 集合
- GET: 列出类型为 ProjectHelmChartRepository 的对象
- POST ：创建一个 ProjectHelmChartRepository
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}
- DELETE ：删除 ProjectHelmChartRepository
- GET ：读取指定的 ProjectHelmChartRepository
- PATCH: 部分更新指定的 ProjectHelmChartRepository
- PUT ：替换指定的 ProjectHelmChartRepository
/apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status
- GET ：指定 ProjectHelmChartRepository 的读取状态
- PATCH: 部分更新指定 ProjectHelmChartRepository 的状态
- PUT ：替换指定 ProjectHelmChartRepository 的状态

20.2.1. /apis/helm.openshift.io/v1beta1/projecthelmchartrepositories
复制链接

Expand

表 20.1. 全局查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

HTTP 方法: GET
描述: 列出类型为 ProjectHelmChartRepository 的对象

Expand

表 20.2. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepositoryList` 模式
401 - Unauthorized	空

20.2.2. /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories
复制链接

Expand

表 20.3. 全局路径参数
参数	类型	描述
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

Expand

表 20.4. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ProjectHelmChartRepository 集合

Expand

表 20.5. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 20.6. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出类型为 ProjectHelmChartRepository 的对象

Expand

表 20.7. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 20.8. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepositoryList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建 ProjectHelmChartRepository

Expand

表 20.9. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 20.10. 主体参数
参数	类型	描述
`正文（body）`	`ProjectHelmChartRepository` 模式

Expand

表 20.11. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepository` 模式
201 - Created	`ProjectHelmChartRepository` 模式
202 - Accepted	`ProjectHelmChartRepository` 模式
401 - Unauthorized	空

20.2.3. /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}
复制链接

Expand

表 20.12. 全局路径参数
参数	类型	描述
`name`	`string`	ProjectHelmChartRepository 的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

Expand

表 20.13. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除 ProjectHelmChartRepository

Expand

表 20.14. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`gracePeriodSeconds`	`整数`	应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值为零表示立即删除。如果这个值是 nil，则会使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。
`orphanDependents`	`布尔值`	弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。如果依赖对象是孤立的。如果为 true/false，则 "orphan" finalizer 将添加到对象的终结器列表中。可以设置此字段或 PropagationPolicy，但不能同时设置。
`propagationPolicy`	`字符串`	是否执行垃圾回收。可以设置此字段或 OrphanDependents，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值有： 'Orphan' - 孤立的依赖项; 'Background' - 允许垃圾收集器删除依赖项，"Foreground' - 删除前台所有依赖的级联策略。

Expand

表 20.15. 主体参数
参数	类型	描述
`正文（body）`	`DeleteOptions` 模式

Expand

表 20.16. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
202 - Accepted	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 阅读指定的 ProjectHelmChartRepository

Expand

表 20.17. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 20.18. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepository` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定的 ProjectHelmChartRepository

Expand

表 20.19. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 20.20. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 20.21. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepository` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定的 ProjectHelmChartRepository

Expand

表 20.22. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 20.23. 主体参数
参数	类型	描述
`正文（body）`	`ProjectHelmChartRepository` 模式

Expand

表 20.24. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepository` 模式
201 - Created	`ProjectHelmChartRepository` 模式
401 - Unauthorized	空

20.2.4. /apis/helm.openshift.io/v1beta1/namespaces/{namespace}/projecthelmchartrepositories/{name}/status
复制链接

Expand

表 20.25. 全局路径参数
参数	类型	描述
`name`	`string`	ProjectHelmChartRepository 的名称
`namespace`	`字符串`	对象名称和身份验证范围，如团队（team）和项目（project）

Expand

表 20.26. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: GET
描述: 指定 ProjectHelmChartRepository 的读取状态

Expand

表 20.27. 查询参数
参数	类型	描述
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置

Expand

表 20.28. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepository` 模式
401 - Unauthorized	空

HTTP 方法: PATCH
描述: 部分更新指定 ProjectHelmChartRepository 的状态

Expand

表 20.29. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 20.30. 主体参数
参数	类型	描述
`正文（body）`	`Patch` 模式

Expand

表 20.31. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepository` 模式
401 - Unauthorized	空

HTTP 方法: PUT
描述: 替换指定 ProjectHelmChartRepository 的状态

Expand

表 20.32. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 20.33. 主体参数
参数	类型	描述
`正文（body）`	`ProjectHelmChartRepository` 模式

Expand

表 20.34. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProjectHelmChartRepository` 模式
201 - Created	`ProjectHelmChartRepository` 模式
401 - Unauthorized	空

第 21 章 Proxy [config.openshift.io/v1]
复制链接

描述

代理包含有关如何配置集群的默认代理的集群范围信息。规范名称是 集群兼容性级别 1：在主发行版本中至少为 12 个月或 3 个次版本（以更长的时间为准）。

类型

object

必填

spec

21.1. 规格
复制链接

Expand

属性	类型	描述
`apiVersion`	`字符串`	APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`字符串`	kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`spec`	`对象`	spec 包含用于代理配置的用户可设置值
`status`	`对象`	status 包含从集群中观察到的值。它们可能无法被覆盖。

21.1.1. .spec
复制链接

描述: spec 包含用于代理配置的用户可设置值
类型: object

Expand

属性	类型	描述
`httpProxy`	`字符串`	httpProxy 是 HTTP 请求的代理 URL。空表示未设置，不会导致 env var。
`httpsProxy`	`字符串`	httpsProxy 是 HTTPS 请求的代理 URL。空表示未设置，不会导致 env var。
`noProxy`	`字符串`	noProxy 是不应使用代理的主机名和/或 CIDR 和/或 IP 的逗号分隔列表。空表示未设置，不会导致 env var。
`readinessEndpoints`	`数组（字符串）`	readinessEndpoints 是用于验证代理的就绪状态的端点列表。
`trustedCA`	`对象`	trustedCA 是对包含 CA 证书捆绑包的 ConfigMap 的引用。trustedCA 字段应当仅由代理验证器使用。验证器负责从所需的键 "ca-bundle.crt" 中读取证书捆绑包，将其与系统默认信任捆绑包合并，并在 "openshift-config-managed" 命名空间中写入名为 "trusted-ca-bundle" 的 ConfigMap 中。希望进行代理连接的客户端必须将 trusted-ca-bundle 用于代理的所有 HTTPS 请求，并将 trusted-ca-bundle 用于非代理 HTTPS 请求。被 trustedCA 引用的 ConfigMap 的命名空间为 "openshift-config"。以下是一个 ConfigMap 示例（在 yaml 中）： apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

21.1.2. .spec.trustedCA
复制链接

描述

类型

object

必填

name

Expand

属性	类型	描述
`name`	`字符串`	name 是引用的配置映射的 metadata.name

21.1.3. .status
复制链接

描述: status 包含从集群中观察到的值。它们可能无法被覆盖。
类型: object

Expand

属性	类型	描述
`httpProxy`	`字符串`	httpProxy 是 HTTP 请求的代理 URL。
`httpsProxy`	`字符串`	httpsProxy 是 HTTPS 请求的代理 URL。
`noProxy`	`字符串`	noProxy 是不应使用代理的主机名和/或 CIDR 的逗号分隔列表。

21.2. API 端点
复制链接

可用的 API 端点如下：

/apis/config.openshift.io/v1/proxies
- DELETE ：删除代理集合
- GET: 列出类型为 Proxy 的对象
- POST ：创建代理
/apis/config.openshift.io/v1/proxies/{name}
- DELETE ：删除代理
- GET ：读取指定的代理
- PATCH: 部分更新指定的代理
- PUT ：替换指定的代理
/apis/config.openshift.io/v1/proxies/{name}/status
- GET ：指定代理的读取状态
- PATCH: 部分更新指定代理的状态
- PUT ：替换指定代理的状态

21.2.1. /apis/config.openshift.io/v1/proxies
复制链接

Expand

表 21.1. 全局查询参数
参数	类型	描述
`pretty`	`字符串`	如果为 'true'，则输出会经过 pretty print 处理。

HTTP 方法: DELETE
描述: 删除代理集合

Expand

表 21.2. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 21.3. HTTP 响应
HTTP 代码	响应正文
200 - OK	`Status` 模式
401 - Unauthorized	空

HTTP 方法: GET
描述: 列出 Proxy 类型的对象

Expand

表 21.4. 查询参数
参数	类型	描述
`allowWatchBookmarks`	`布尔值`	allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。不实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。
`继续`	`字符串`	从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误接收的令牌的列表请求，服务器将以从下一个密钥开始开始的列表响应，但从最新的快照开始，这与上一个列表结果中不一致 - 在第一个列表请求后将包含在响应中，只要它们的密钥位于 "next key" 后。当 watch 为 true 时不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不丢失任何修改。
`fieldSelector`	`字符串`	一个选择器，用于限制其字段返回的对象列表。默认为任何内容。
`labelSelector`	`字符串`	一个选择器，用于限制其标签返回的对象列表。默认为任何内容。
`limit`	`整数`	limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 `continue` 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤所有请求的对象，则设置限制可能会返回少于请求项目数量（最多为零项），并且客户端只应使用 continue 字段的存在，以确定是否有更多结果可用。服务器可能会选择不支持 limit 参数，并返回所有可用的结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假定没有更多结果可用。如果 watch 为 true，则不支持此字段。服务器保证，在使用时返回的对象将与在没有限制限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后没有创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制来接收非常大结果的较小的块的客户端可确保它们看到所有可能的对象。如果在块列表中更新对象，则返回第一个列表结果时存在的对象版本。
`resourceVersion`	`字符串`	resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置
`resourceVersionMatch`	`字符串`	resourceVersionMatch 决定如何将 resourceVersion 应用到列表调用。强烈建议您为设置 resourceVersion 的 list 调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。默认为未设置
`timeoutSeconds`	`整数`	列表/watch 调用的超时。这限制了调用的持续时间，无论任何活动或不活跃。
`watch`	`布尔值`	观察对所描述资源的更改，并将它们作为添加、更新和删除通知的流返回。指定 resourceVersion。

Expand

表 21.5. HTTP 响应
HTTP 代码	响应正文
200 - OK	`ProxyList` 模式
401 - Unauthorized	空

HTTP 方法: POST
描述: 创建代理

Expand

表 21.6. 查询参数
参数	类型	描述
`dryRun`	`字符串`	出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理
`fieldManager`	`字符串`	fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。
`fieldValidation`	`string`	fieldValidation 指示服务器如何处理请求(POST/PUT/PATCH)中包含未知或重复字段的对象，只要 `ServerSideFieldValidation` 功能门也被启用。有效值为： - Ignore ：忽略从对象中静默丢弃的未知字段，并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 之前的默认行为，是 `ServerSideFieldValidation` 功能门被禁用时的默认行为。- Warn: 这将通过从对象丢弃的每个未知字段的标准警告响应标头发送警告，以及遇到的每个重复字段。如果没有其他错误，请求仍会成功，且只保留重复字段的最后一个。当 `ServerSideFieldValidation` 功能门被启用时，这是默认设置。- Strict: 如果从对象中丢弃任何未知字段，则会失败并带有 BadRequest 错误，或者存在任何重复字段。从服务器返回的错误将包含遇到的，以及重复的字段。

Expand

表 21.7. 主体参数
参数	类型	描述
`正文（body）`	`proxy` 模式

Expand

配置 API

配置 API 的参考指南

第 1 章 配置 API复制链接链接已复制到粘贴板!

1.1. APIServer [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.2. Authentication [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.3. Build [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.4. ClusterOperator [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.5. ClusterVersion [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.6. Console [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.7. DNS [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.8. FeatureGate [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.9. HelmChartRepository [helm.openshift.io/v1beta1]复制链接链接已复制到粘贴板!

1.10. Image [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.11. ImageContentPolicy [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.12. Infrastructure [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.13. Ingress [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.14. Network [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.15. Node [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.16. OAuth [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.17. OperatorHub [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.18. Project [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.19. ProjectHelmChartRepository [helm.openshift.io/v1beta1]复制链接链接已复制到粘贴板!

1.20. Proxy [config.openshift.io/v1]复制链接链接已复制到粘贴板!

1.21. Scheduler [config.openshift.io/v1]复制链接链接已复制到粘贴板!

第 2 章 APIServer [config.openshift.io/v1]复制链接链接已复制到粘贴板!

2.1. 规格复制链接链接已复制到粘贴板!

2.1.1. .spec复制链接链接已复制到粘贴板!

2.1.2. .spec.audit复制链接链接已复制到粘贴板!

2.1.3. .spec.audit.customRules复制链接链接已复制到粘贴板!

2.1.4. .spec.audit.customRules[]复制链接链接已复制到粘贴板!

2.1.5. .spec.clientCA复制链接链接已复制到粘贴板!

2.1.6. .spec.encryption复制链接链接已复制到粘贴板!

2.1.7. .spec.servingCerts复制链接链接已复制到粘贴板!

2.1.8. .spec.servingCerts.namedCertificates复制链接链接已复制到粘贴板!

2.1.9. .spec.servingCerts.namedCertificates[]复制链接链接已复制到粘贴板!

2.1.10. .spec.servingCerts.namedCertificates[].servingCertificate复制链接链接已复制到粘贴板!

2.1.11. .spec.tlsSecurityProfile复制链接链接已复制到粘贴板!

2.1.12. .status复制链接链接已复制到粘贴板!

2.2. API 端点复制链接链接已复制到粘贴板!

2.2.1. /apis/config.openshift.io/v1/apiservers复制链接链接已复制到粘贴板!

2.2.2. /apis/config.openshift.io/v1/apiservers/{name}复制链接链接已复制到粘贴板!

2.2.3. /apis/config.openshift.io/v1/apiservers/{name}/status复制链接链接已复制到粘贴板!

第 3 章 Authentication [config.openshift.io/v1]复制链接链接已复制到粘贴板!

3.1. 规格复制链接链接已复制到粘贴板!

3.1.1. .spec复制链接链接已复制到粘贴板!

3.1.2. .spec.oauthMetadata复制链接链接已复制到粘贴板!

3.1.3. .spec.webhookTokenAuthenticator复制链接链接已复制到粘贴板!

3.1.4. .spec.webhookTokenAuthenticator.kubeConfig复制链接链接已复制到粘贴板!

3.1.5. .spec.webhookTokenAuthenticators复制链接链接已复制到粘贴板!

3.1.6. .spec.webhookTokenAuthenticators[]复制链接链接已复制到粘贴板!

3.1.7. .spec.webhookTokenAuthenticators[].kubeConfig复制链接链接已复制到粘贴板!

3.1.8. .status复制链接链接已复制到粘贴板!

3.1.9. .status.integratedOAuthMetadata复制链接链接已复制到粘贴板!

3.2. API 端点复制链接链接已复制到粘贴板!

3.2.1. /apis/config.openshift.io/v1/authentications复制链接链接已复制到粘贴板!

3.2.2. /apis/config.openshift.io/v1/authentications/{name}复制链接链接已复制到粘贴板!

3.2.3. /apis/config.openshift.io/v1/authentications/{name}/status复制链接链接已复制到粘贴板!

第 4 章 Build [config.openshift.io/v1]复制链接链接已复制到粘贴板!

4.1. 规格复制链接链接已复制到粘贴板!

4.1.1. .spec复制链接链接已复制到粘贴板!

4.1.2. .spec.additionalTrustedCA复制链接链接已复制到粘贴板!

4.1.3. .spec.buildDefaults复制链接链接已复制到粘贴板!

4.1.4. .spec.buildDefaults.defaultProxy复制链接链接已复制到粘贴板!

4.1.5. .spec.buildDefaults.defaultProxy.trustedCA复制链接链接已复制到粘贴板!

4.1.6. .spec.buildDefaults.env复制链接链接已复制到粘贴板!

4.1.7. .spec.buildDefaults.env[]复制链接链接已复制到粘贴板!

4.1.8. .spec.buildDefaults.env[].valueFrom复制链接链接已复制到粘贴板!

4.1.9. .spec.buildDefaults.env[].valueFrom.configMapKeyRef复制链接链接已复制到粘贴板!

4.1.10. .spec.buildDefaults.env[].valueFrom.fieldRef复制链接链接已复制到粘贴板!

4.1.11. .spec.buildDefaults.env[].valueFrom.resourceFieldRef复制链接链接已复制到粘贴板!

4.1.12. .spec.buildDefaults.env[].valueFrom.secretKeyRef复制链接链接已复制到粘贴板!

4.1.13. .spec.buildDefaults.gitProxy复制链接链接已复制到粘贴板!

4.1.14. .spec.buildDefaults.gitProxy.trustedCA复制链接链接已复制到粘贴板!

4.1.15. .spec.buildDefaults.imageLabels复制链接链接已复制到粘贴板!

4.1.16. .spec.buildDefaults.imageLabels[]复制链接链接已复制到粘贴板!

4.1.17. .spec.buildDefaults.resources复制链接链接已复制到粘贴板!

4.1.18. .spec.buildOverrides复制链接链接已复制到粘贴板!

4.1.19. .spec.buildOverrides.imageLabels复制链接链接已复制到粘贴板!

4.1.20. .spec.buildOverrides.imageLabels[]复制链接链接已复制到粘贴板!

4.1.21. .spec.buildOverrides.tolerations复制链接链接已复制到粘贴板!

第 1 章配置 API
复制链接

1.1. APIServer [config.openshift.io/v1]
复制链接

1.2. Authentication [config.openshift.io/v1]
复制链接

1.3. Build [config.openshift.io/v1]
复制链接

1.4. ClusterOperator [config.openshift.io/v1]
复制链接

1.5. ClusterVersion [config.openshift.io/v1]
复制链接

1.6. Console [config.openshift.io/v1]
复制链接

1.7. DNS [config.openshift.io/v1]
复制链接

1.8. FeatureGate [config.openshift.io/v1]
复制链接

1.9. HelmChartRepository [helm.openshift.io/v1beta1]
复制链接

1.10. Image [config.openshift.io/v1]
复制链接

1.11. ImageContentPolicy [config.openshift.io/v1]
复制链接

1.12. Infrastructure [config.openshift.io/v1]
复制链接

1.13. Ingress [config.openshift.io/v1]
复制链接

1.14. Network [config.openshift.io/v1]
复制链接

1.15. Node [config.openshift.io/v1]
复制链接

1.16. OAuth [config.openshift.io/v1]
复制链接

1.17. OperatorHub [config.openshift.io/v1]
复制链接

1.18. Project [config.openshift.io/v1]
复制链接

1.19. ProjectHelmChartRepository [helm.openshift.io/v1beta1]
复制链接

1.20. Proxy [config.openshift.io/v1]
复制链接

1.21. Scheduler [config.openshift.io/v1]
复制链接

第 2 章 APIServer [config.openshift.io/v1]
复制链接

2.1. 规格
复制链接

2.1.1. .spec
复制链接

2.1.2. .spec.audit
复制链接

2.1.3. .spec.audit.customRules
复制链接

2.1.4. .spec.audit.customRules[]
复制链接

2.1.5. .spec.clientCA
复制链接

2.1.6. .spec.encryption
复制链接

2.1.7. .spec.servingCerts
复制链接

2.1.8. .spec.servingCerts.namedCertificates
复制链接

2.1.9. .spec.servingCerts.namedCertificates[]
复制链接

2.1.10. .spec.servingCerts.namedCertificates[].servingCertificate
复制链接

2.1.11. .spec.tlsSecurityProfile
复制链接

2.1.12. .status
复制链接

2.2. API 端点
复制链接

2.2.1. /apis/config.openshift.io/v1/apiservers
复制链接

2.2.2. /apis/config.openshift.io/v1/apiservers/{name}
复制链接

2.2.3. /apis/config.openshift.io/v1/apiservers/{name}/status
复制链接

第 3 章 Authentication [config.openshift.io/v1]
复制链接

3.1. 规格
复制链接

3.1.1. .spec
复制链接

3.1.2. .spec.oauthMetadata
复制链接

3.1.3. .spec.webhookTokenAuthenticator
复制链接

3.1.4. .spec.webhookTokenAuthenticator.kubeConfig
复制链接

3.1.5. .spec.webhookTokenAuthenticators
复制链接

3.1.6. .spec.webhookTokenAuthenticators[]
复制链接

3.1.7. .spec.webhookTokenAuthenticators[].kubeConfig
复制链接

3.1.8. .status
复制链接

3.1.9. .status.integratedOAuthMetadata
复制链接

3.2. API 端点
复制链接

3.2.1. /apis/config.openshift.io/v1/authentications
复制链接

3.2.2. /apis/config.openshift.io/v1/authentications/{name}
复制链接

3.2.3. /apis/config.openshift.io/v1/authentications/{name}/status
复制链接

第 4 章 Build [config.openshift.io/v1]
复制链接

4.1. 规格
复制链接

4.1.1. .spec
复制链接

4.1.2. .spec.additionalTrustedCA
复制链接

4.1.3. .spec.buildDefaults
复制链接

4.1.4. .spec.buildDefaults.defaultProxy
复制链接

4.1.5. .spec.buildDefaults.defaultProxy.trustedCA
复制链接

4.1.6. .spec.buildDefaults.env
复制链接

4.1.7. .spec.buildDefaults.env[]
复制链接

4.1.8. .spec.buildDefaults.env[].valueFrom
复制链接

4.1.9. .spec.buildDefaults.env[].valueFrom.configMapKeyRef
复制链接

4.1.10. .spec.buildDefaults.env[].valueFrom.fieldRef
复制链接

4.1.11. .spec.buildDefaults.env[].valueFrom.resourceFieldRef
复制链接

4.1.12. .spec.buildDefaults.env[].valueFrom.secretKeyRef
复制链接

4.1.13. .spec.buildDefaults.gitProxy
复制链接

4.1.14. .spec.buildDefaults.gitProxy.trustedCA
复制链接

4.1.15. .spec.buildDefaults.imageLabels
复制链接

4.1.16. .spec.buildDefaults.imageLabels[]
复制链接

4.1.17. .spec.buildDefaults.resources
复制链接

4.1.18. .spec.buildOverrides
复制链接

4.1.19. .spec.buildOverrides.imageLabels
复制链接

4.1.20. .spec.buildOverrides.imageLabels[]
复制链接

4.1.21. .spec.buildOverrides.tolerations
复制链接

4.1.22. .spec.buildOverrides.tolerations[]
复制链接

4.2. API 端点
复制链接