OpenShift 文档正在迁移，很快将只在 docs.redhat.com（所有 Red Hat 产品文档的中心）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

代理 [config.openshift.io/v1]

描述

Proxy 保存关于如何为集群配置默认代理的集群范围信息。规范名称为 cluster 兼容性级别 1：在主要版本中稳定至少 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

  • spec

规范

属性 类型 描述

apiVersion

字符串

APIVersion 定义此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰式大小写。更多信息：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 包含来自集群的观察值。它们不能被覆盖。

.spec

描述

Spec 包含用户可设置的代理配置值。

类型

对象

属性 类型 描述

httpProxy

字符串

httpProxy 是 HTTP 请求的代理 URL。空表示未设置，不会导致环境变量。

httpsProxy

字符串

httpsProxy 是 HTTPS 请求的代理 URL。空表示未设置，不会导致环境变量。

noProxy

字符串

noProxy 是一个逗号分隔的主机名和/或 CIDR 和/或 IP 列表，对于这些主机名和/或 CIDR 和/或 IP，不应使用代理。空表示未设置，不会导致环境变量。

readinessEndpoints

数组 (字符串)

readinessEndpoints 是用于验证代理就绪状态的端点列表。

trustedCA

对象

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

.spec.trustedCA

描述

trustedCA 指的是包含 CA 证书捆绑包的 ConfigMap。trustedCA 字段只能被代理验证器使用。验证器负责从必需的键“ca-bundle.crt”读取证书捆绑包，将其与系统默认信任捆绑包合并，并将合并后的信任捆绑包写入“openshift-config-managed”命名空间中名为“trusted-ca-bundle”的 ConfigMap。预期进行代理连接的客户端必须对所有指向代理的 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----- 自定义 CA 证书捆绑包。 -----END CERTIFICATE-----

类型

对象

必需

  • 名称

属性 类型 描述

名称

字符串

name 是引用的 config map 的 metadata.name

.状态

描述

status 包含来自集群的观察值。它们不能被覆盖。

类型

对象

属性 类型 描述

httpProxy

字符串

httpProxy 是 HTTP 请求的代理 URL。

httpsProxy

字符串

httpsProxy 是 HTTPS 请求的代理 URL。

noProxy

字符串

noProxy 是一个逗号分隔的主机名和/或 CIDR 列表，代理不应为此列表中的主机名和/或 CIDR 使用。

API 端点

提供以下 API 端点

  • /apis/config.openshift.io/v1/proxies

    • DELETE：删除 Proxy 集合

    • GET：列出 Proxy 对象

    • POST：创建 Proxy

  • /apis/config.openshift.io/v1/proxies/{name}

    • DELETE：删除 Proxy

    • GET：读取指定的 Proxy

    • PATCH：部分更新指定的 Proxy

    • PUT：替换指定的 Proxy

  • /apis/config.openshift.io/v1/proxies/{name}/status

    • GET：读取指定的 Proxy 的状态

    • PATCH：部分更新指定的 Proxy 的状态

    • PUT：替换指定的 Proxy 的状态

/apis/config.openshift.io/v1/proxies

HTTP 方法

DELETE

描述

删除 Proxy 集合

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 Proxy 对象

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

ProxyList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建 Proxy

表 3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则此操作将使用 BadRequest 错误使请求失败。从服务器返回的错误将包含遇到的所有未知和重复字段。
表 4. 请求体参数
参数 类型 描述

body

Proxy 模式
表 5. HTTP 响应
HTTP 代码 响应体

200 - OK

Proxy 模式

201 - 已创建

Proxy 模式

202 - 已接受

Proxy 模式

401 - 未授权

空

/apis/config.openshift.io/v1/proxies/{name}

表 6. 全局路径参数
参数 类型 描述

名称

字符串

Proxy 的名称
HTTP 方法

DELETE

描述

删除 Proxy

表 7. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 8. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 Proxy

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

Proxy 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Proxy

表 10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则此操作将使用 BadRequest 错误使请求失败。从服务器返回的错误将包含遇到的所有未知和重复字段。
表 11. HTTP 响应
HTTP 代码 响应体

200 - OK

Proxy 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Proxy

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则此操作将使用 BadRequest 错误使请求失败。从服务器返回的错误将包含遇到的所有未知和重复字段。
表 13. 请求体参数
参数 类型 描述

body

Proxy 模式
表 14. HTTP 响应
HTTP 代码 响应体

200 - OK

Proxy 模式

201 - 已创建

Proxy 模式

401 - 未授权

空

/apis/config.openshift.io/v1/proxies/{name}/status

表 15. 全局路径参数
参数 类型 描述

名称

字符串

Proxy 的名称
HTTP 方法

GET

描述

读取指定的 Proxy 的状态

表 16. HTTP 响应
HTTP 代码 响应体

200 - OK

Proxy 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Proxy 的状态

表 17. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则此操作将使用 BadRequest 错误使请求失败。从服务器返回的错误将包含遇到的所有未知和重复字段。
表 18. HTTP 响应
HTTP 代码 响应体

200 - OK

Proxy 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Proxy 的状态

表 19. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默丢弃的未知字段，并将忽略解码器遇到的所有重复字段中的最后一个字段之前的默认行为。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中丢弃的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值- Strict：如果任何未知字段将从对象中删除，或者存在任何重复字段，则此操作将使用 BadRequest 错误使请求失败。从服务器返回的错误将包含遇到的所有未知和重复字段。
表 20. 请求体参数
参数 类型 描述

body

Proxy 模式
表 21. HTTP 响应
HTTP 代码 响应体

200 - OK

Proxy 模式

201 - 已创建

Proxy 模式

401 - 未授权

空