community.general.atomic_image 模块 – 管理 atomic 主机平台上的容器镜像

注意

此模块是 community.general 集合(版本 10.1.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install community.general。您需要进一步的要求才能使用此模块,请参阅 要求 获取详细信息。

要在 Playbook 中使用它,请指定:community.general.atomic_image

概要

  • 管理 atomic 主机平台上的容器镜像。

  • 允许在存在时执行容器镜像中 RUN 标签指定的命令。

要求

在执行此模块的主机上需要满足以下要求。

  • atomic

参数

参数

注释

后端

字符串

定义拉取镜像的后端。

选择

  • "docker"

  • "ostree"

名称

字符串 / 必需

容器镜像的名称。

已启动

布尔值

启动或停止容器。

选择

  • ← (默认)

状态

字符串

容器镜像的状态。

状态 latest 将确保容器镜像升级到最新版本,并在运行时强制重启容器。

选择

  • "absent"

  • "latest" ← (默认)

  • "present"

属性

属性

支持

描述

check_mode

支持:

可以在 check_mode 中运行,并在不修改目标的情况下返回更改状态预测。

diff_mode

支持:

当处于差异模式时,将返回有关已更改(或可能需要在 check_mode 中更改)的详细信息。

注释

注意

  • 主机应支持 atomic 命令。

示例

- name: Execute the run command on rsyslog container image (atomic run rhel7/rsyslog)
  community.general.atomic_image:
    name: rhel7/rsyslog
    state: latest

- name: Pull busybox to the OSTree backend
  community.general.atomic_image:
    name: busybox
    state: latest
    backend: ostree

返回值

常见的返回值记录在 此处,以下是此模块特有的字段

描述

msg

字符串

命令标准输出

返回: 总是

示例: "使用默认标签: latest ..."

作者

  • Saravanan KR (@krsacme)