community.okd.openshift_import_image 模块 – 从容器镜像注册表中的标签导入最新的镜像信息。

注意

此模块是 community.okd 集合（版本 4.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.okd。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：community.okd.openshift_import_image。

community.okd 2.2.0 中的新功能

概要

• 镜像流允许您控制哪些镜像会部署到您的构建和应用程序。

• 此模块从远程存储库中获取镜像的最新版本，如果它与先前的值不匹配，则更新镜像流标签。

• 多次运行该模块不会创建重复的条目。

• 导入镜像时，仅复制镜像元数据，而不复制镜像内容。

• 类似于 oc import-image。

要求

执行此模块的主机需要以下要求。

• python >= 3.6

• kubernetes >= 12.0.0

• docker-image-py

参数

参数	注释
all 布尔值	如果设置为 true，则在创建时或指定 source 时，从提供的源导入所有标签。 选择 false ←（默认） true
api_key 字符串	用于与 API 进行身份验证的令牌。也可以通过 K8S_AUTH_API_KEY 环境变量指定。
ca_cert 别名：ssl_ca_cert 路径	用于与 API 进行身份验证的 CA 证书的路径。必须提供完整的证书链以避免证书验证错误。也可以通过 K8S_AUTH_SSL_CA_CERT 环境变量指定。
client_cert 别名：cert_file 路径	用于与 API 进行身份验证的证书的路径。也可以通过 K8S_AUTH_CERT_FILE 环境变量指定。
client_key 别名：key_file 路径	用于与 API 进行身份验证的密钥文件的路径。也可以通过 K8S_AUTH_KEY_FILE 环境变量指定。
context 字符串	在配置文件中找到的上下文的名称。也可以通过 K8S_AUTH_CONTEXT 环境变量指定。
host 字符串	提供用于访问 API 的 URL。也可以通过 K8S_AUTH_HOST 环境变量指定。
impersonate_groups 列表 / 元素=字符串 在 kubernetes.core 2.3.0 中添加	要模拟操作的组。 也可以通过 K8S_AUTH_IMPERSONATE_GROUPS 环境指定。示例：Group1,Group2
impersonate_user 字符串 在 kubernetes.core 2.3.0 中添加	要模拟操作的用户名。 也可以通过 K8S_AUTH_IMPERSONATE_USER 环境指定。
kubeconfig 任何	现有 Kubernetes 配置文件的路径。如果未提供，并且未提供其他连接选项，Kubernetes 客户端将尝试从 ~/.kube/config 加载默认配置文件。也可以通过 K8S_AUTH_KUBECONFIG 环境变量指定。 可以使用分隔符“;”用于 Windows 平台或“:”用于其他平台，提供多个 Kubernetes 配置文件。 可以将 Kubernetes 配置作为字典提供。此功能需要 python Kubernetes 客户端版本 >= 17.17.0。在版本 2.2.0 中添加。
name 任何 / 必需	要将标签导入的镜像流。 这可以作为镜像流列表或单个值提供。
namespace 字符串 / 必需	用于指定要创建/更新的镜像流的命名空间。
no_proxy 字符串 在 kubernetes.core 2.3.0 中添加	不应通过代理的以逗号分隔的主机/域/IP/CIDR 列表。也可以通过 K8S_AUTH_NO_PROXY 环境变量指定。 请注意，此模块不会从环境中获取典型的代理设置（例如 NO_PROXY）。 此功能需要 kubernetes>=19.15.0。当 kubernetes 库版本低于 19.15.0 时，即使正确设置了 no_proxy 也会失败。 示例值为“localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16”
密码 字符串	提供用于与 API 进行身份验证的密码。也可以通过 K8S_AUTH_PASSWORD 环境变量指定。 请阅读 username 选项的说明，了解何时适用此选项。
persist_config 布尔值	是否保存 kube 配置刷新令牌。也可以通过 K8S_AUTH_PERSIST_CONFIG 环境变量指定。 当 k8s 上下文使用带有刷新令牌的用户凭据（如 oidc 或 gke/gcloud 身份验证）时，令牌由 k8s Python 客户端库刷新，但默认情况下不会保存。因此，旧的刷新令牌可能会过期，并且下次身份验证可能会失败。将此标志设置为 true 将告诉 k8s Python 客户端将新的刷新令牌保存到 kube 配置文件中。 默认为 false。 请注意，当前版本的 k8s Python 客户端库尚不支持将此标志设置为 True。 此 k8s Python 库的修复程序在此处：https://github.com/kubernetes-client/python-base/pull/169 选择 false true
proxy 字符串	用于连接的 HTTP 代理 URL。也可以通过 K8S_AUTH_PROXY 环境变量指定。 请注意，此模块不会从环境中获取典型的代理设置（例如 HTTP_PROXY）。
proxy_headers 字典 在 kubernetes.core 2.0.0 中添加	用于 HTTP 代理的标头。 文档可在此处找到 https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers。
basic_auth 字符串	用于基本身份验证标头的以冒号分隔的用户名:密码。 也可以通过 K8S_AUTH_PROXY_HEADERS_BASIC_AUTH 环境变量指定。
proxy_basic_auth 字符串	用于代理基本身份验证标头的以冒号分隔的用户名:密码。 也可以通过 K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH 环境变量指定。
user_agent 字符串	表示您想要的 User-Agent 的字符串，例如 foo/1.0。 也可以通过 K8S_AUTH_PROXY_HEADERS_USER_AGENT 环境变量指定。
reference_policy 字符串	设置为local时，允许请求拉取外部镜像。 选择 "source" ← (默认) "local"
scheduled 布尔值	将每个导入的 Docker 镜像设置为定期从远程存储库导入。 选择 false ←（默认） true
source 字符串	要从中导入镜像的 Docker 镜像存储库。 应以“registry.io/repo/image”的形式提供
username 字符串	提供用于与 API 进行身份验证的用户名。也可以通过 K8S_AUTH_USERNAME 环境变量指定。 请注意，这仅适用于配置为使用 HTTP 基本身份验证的集群。如果您的集群具有不同的身份验证形式（例如 OpenShift 中的 OAuth2），则此选项将无法按预期工作，您应该查看 community.okd.k8s_auth 模块，因为它可能会满足您的需求。
validate_certs 别名: verify_ssl 布尔值	是否验证 API 服务器的 SSL 证书。也可以通过 K8S_AUTH_VERIFY_SSL 环境变量指定。 选择 false true
validate_registry_certs 布尔值	如果设置为 true，则允许从具有无效 HTTPS 证书或通过 HTTP 托管的注册表导入。此参数将优先于不安全注释。 选择 false true

说明

注意

• 要避免 validate_certs 为 True 时的 SSL 证书验证错误，必须通过 ca_cert 或在 kubeconfig 文件中提供 API 服务器的完整证书链。

示例

# Import tag latest into a new image stream.
- name: Import tag latest into new image stream
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream
    source: registry.io/repo/image:latest

# Update imported data for tag latest in an already existing image stream.
- name: Update imported data for tag latest
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream

# Update imported data for tag 'stable' in an already existing image stream.
- name: Update imported data for tag latest
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream:stable

# Update imported data for all tags in an existing image stream.
- name: Update imported data for all tags
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream
    all: true

# Import all tags into a new image stream.
- name: Import all tags into a new image stream.
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream
    source: registry.io/repo/image:latest
    all: true

# Import all tags into a new image stream for a list of image streams
- name: Import all tags into a new image stream.
  community.okd.openshift_import_image:
    namespace: testing
    name:
      - mystream1
      - mystream2
      - mystream3
    source: registry.io/repo/image:latest
    all: true

返回值

常见的返回值在此处记录 这里，以下是此模块独有的字段

键	描述
result 列表 / elements=字典	包含所有已创建的 ImageStreamImport 的列表。 返回: 成功
api_version 字符串	此对象表示的版本化模式。 返回: 成功
kind 字符串	表示此对象表示的 REST 资源。 返回: 成功
metadata 字典	标准对象元数据。包括名称、命名空间、注释、标签等。 返回: 成功
spec 字典	对象的特定属性。将根据 api_version 和 kind 而变化。 返回: 成功
status 字典	对象的当前状态详细信息。 返回: 成功

作者

• Aubin Bikouo (@abikouo)

集合链接

• 问题跟踪器
• 存储库（来源）