community.general.gem 模块 – 管理 Ruby gem

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.gem。

概要

  • 管理 Ruby gem 的安装和卸载。

参数

参数

注释

bindir

路径

在 community.general 3.3.0 中添加

将可执行文件安装到特定目录中。

build_flags

字符串

允许为 gem 编译添加构建标志

env_shebang

布尔值

重写已安装脚本中的 shebang 行，以使用 /usr/bin/env。

选项

  • false ← (默认)

  • true

executable

路径

覆盖 gem 可执行文件的路径

force

布尔值

强制 gem 进行（卸）安装，绕过依赖检查。

选项

  • false ← (默认)

  • true

gem_source

路径

用作安装源的本地 gem 的路径。

include_dependencies

布尔值

是否包含依赖项。

选项

  • false

  • true ← (默认)

include_doc

布尔值

安装时是否包含文档。

选项

  • false ← (默认)

  • true

install_dir

路径

将 gem 安装到特定目录中。这些 gem 将独立于全局安装的 gem。指定此项需要将 user_install 设置为 false。

name

字符串 / 必需

要管理的 gem 的名称。

norc

布尔值

在 community.general 3.3.0 中添加

避免加载任何 .gemrc 文件。对于 2.5.2 之前的 RubyGems 版本将被忽略。

默认值在 community.general 6.0.0 中从 false 更改为 true。

选项

  • false

  • true ← (默认)

pre_release

布尔值

允许安装 gem 的预发布版本。

选项

  • false ← (默认)

  • true

repository

别名: source

字符串

将从中安装 gem 的仓库

state

字符串

gem 的期望状态。latest 确保安装最新版本。

选项

  • "present" ← (默认)

  • "absent"

  • "latest"

user_install

布尔值

在用户的本地 gem 缓存中安装 gem 还是为所有用户安装

选项

  • false

  • true ← (默认)

version

字符串

要安装/删除的 gem 的版本。

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。

diff_mode

支持: 无

当处于 diff 模式时，将返回有关已更改（或可能需要在 check_mode 中更改）的详细信息。

示例

- name: Install version 1.0 of vagrant
  community.general.gem:
    name: vagrant
    version: 1.0
    state: present

- name: Install latest available version of rake
  community.general.gem:
    name: rake
    state: latest

- name: Install rake version 1.0 from a local gem on disk
  community.general.gem:
    name: rake
    gem_source: /path/to/gems/rake-1.0.gem
    state: present

作者

  • Ansible 核心团队

  • Johan Wiren (@johanwiren)