OpenShift 文档正在迁移，不久后将只可在 docs.redhat.com（所有 Red Hat 产品文档的中心）访问。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

镜像 [config.openshift.io/v1]

描述

Image 管理与 imagestream 导入和外部注册表的运行时配置相关的策略。它允许集群管理员配置 OpenShift 允许从中导入镜像的注册表、外部注册表的额外 CA 信任捆绑包以及阻止或允许注册表主机名的策略。在向公众公开 OpenShift 的镜像注册表时，这也允许集群管理员指定外部主机名。兼容性级别 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 包含用户可设置的配置值

类型

对象

属性 类型 描述

additionalTrustedCA

对象

additionalTrustedCA 是对 ConfigMap 的引用，其中包含在 imagestream 导入、Pod 镜像拉取、构建镜像拉取和 imageregistry 拉取过程中应信任的其他 CA。此 ConfigMap 的命名空间是 openshift-config。

allowedRegistriesForImport

数组

allowedRegistriesForImport 限制普通用户可以从中导入容器镜像的镜像仓库。将此列表设置为您信任的包含有效 Docker 镜像并希望应用程序能够从中导入的仓库。拥有通过 API 创建镜像或 ImageStreamMappings 权限的用户不受此策略影响——通常只有管理员或系统集成才会拥有这些权限。

allowedRegistriesForImport[]

对象

RegistryLocation 包含由注册表域名指定的注册表位置。域名可能包含通配符，例如 '*' 或 '??'。

externalRegistryHostnames

数组 (字符串)

externalRegistryHostnames 提供默认外部镜像仓库的主机名。只有当镜像仓库在外部公开时，才应设置外部主机名。第一个值用于 ImageStreams 中的 'publicDockerImageRepository' 字段。该值必须采用 "主机名[:端口]" 格式。

registrySources

对象

registrySources 包含确定容器运行时在访问构建+Pod 的镜像时如何处理各个镜像仓库的配置（例如，是否允许不安全访问）。它不包含内部集群注册表的配置。

.spec.additionalTrustedCA

描述

additionalTrustedCA 是对 ConfigMap 的引用，其中包含在 imagestream 导入、Pod 镜像拉取、构建镜像拉取和 imageregistry 拉取过程中应信任的其他 CA。此 ConfigMap 的命名空间是 openshift-config。

类型

对象

必需

  • 名称

属性 类型 描述

名称

字符串

name 是引用的 ConfigMap 的 metadata.name

.spec.allowedRegistriesForImport

描述

allowedRegistriesForImport 限制普通用户可以从中导入容器镜像的镜像仓库。将此列表设置为您信任的包含有效 Docker 镜像并希望应用程序能够从中导入的仓库。拥有通过 API 创建镜像或 ImageStreamMappings 权限的用户不受此策略影响——通常只有管理员或系统集成才会拥有这些权限。

类型

数组

.spec.allowedRegistriesForImport[]

描述

RegistryLocation 包含由注册表域名指定的注册表位置。域名可能包含通配符，例如 '*' 或 '??'。

类型

对象

属性 类型 描述

域名

字符串

domainName 指定注册表的域名。如果注册表使用非标准 (80 或 443) 端口，则端口也应包含在域名中。

不安全

布尔值

insecure 指示注册表是安全的 (https) 还是不安全的 (http)。默认情况下（如果未指定），则假定注册表是安全的。

.spec.registrySources

描述

registrySources 包含确定容器运行时在访问构建+Pod 的镜像时如何处理各个镜像仓库的配置（例如，是否允许不安全访问）。它不包含内部集群注册表的配置。

类型

对象

属性 类型 描述

允许的注册表

数组 (字符串)

allowedRegistries 是唯一允许进行镜像拉取和推送操作的注册表。所有其他注册表都被拒绝。只能设置 BlockedRegistries 或 AllowedRegistries 中的一个。

被阻止的注册表

数组 (字符串)

blockedRegistries 不能用于镜像拉取和推送操作。所有其他注册表都是允许的。只能设置 BlockedRegistries 或 AllowedRegistries 中的一个。

容器运行时搜索注册表

数组 (字符串)

containerRuntimeSearchRegistries 是在拉取拉取规范中没有完全限定域名的镜像时将搜索的注册表。将按照列表中提供的顺序搜索注册表。注意：此搜索列表仅适用于容器运行时，即 CRI-O。不适用于构建或 imagestream 导入。

不安全的注册表

数组 (字符串)

insecureRegistries 是没有有效 TLS 证书或仅支持 HTTP 连接的注册表。

.status

描述

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

类型

对象

属性 类型 描述

externalRegistryHostnames

数组 (字符串)

externalRegistryHostnames 提供默认外部镜像仓库的主机名。只有当镜像仓库在外部公开时，才应设置外部主机名。第一个值用于 ImageStreams 中的 'publicDockerImageRepository' 字段。该值必须采用 "主机名[:端口]" 格式。

内部注册表主机名

字符串

internalRegistryHostname 设置默认内部镜像仓库的主机名。该值必须采用 "主机名[:端口]" 格式。此值由控制内部注册表主机名的镜像注册表操作符设置。

API 端点

提供以下 API 端点

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

    • DELETE：删除 Image 集合

    • GET：列出 Image 类型的对象

    • POST：创建一个 Image

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

    • DELETE：删除一个 Image

    • GET：读取指定的 Image

    • PATCH：部分更新指定的 Image

    • PUT：替换指定的 Image

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

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

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

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

/apis/config.openshift.io/v1/images

HTTP 方法

DELETE

描述

删除 Image 集合

表 1. HTTP 响应
HTTP 代码 响应正文

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 Image 类型的对象

表 2. HTTP 响应
HTTP 代码 响应正文

200 - OK

ImageList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 Image

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

Image 模式
表 5. HTTP 响应
HTTP 代码 响应正文

200 - OK

Image 模式

201 - 已创建

Image 模式

202 - 已接受

Image 模式

401 - 未授权

空

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

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

名称

字符串

Image 的名称
HTTP 方法

DELETE

描述

删除一个 Image

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 Image

表 9. HTTP 响应
HTTP 代码 响应正文

200 - OK

Image 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Image

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Image 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Image

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

Image 模式
表 14. HTTP 响应
HTTP 代码 响应正文

200 - OK

Image 模式

201 - 已创建

Image 模式

401 - 未授权

空

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

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

名称

字符串

Image 的名称
HTTP 方法

GET

描述

读取指定的 Image 的状态

表 16. HTTP 响应
HTTP 代码 响应正文

200 - OK

Image 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Image 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Image 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Image 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

Image 模式
表 21. HTTP 响应
HTTP 代码 响应正文

200 - OK

Image 模式

201 - 已创建

Image 模式

401 - 未授权

空