ansible-pull

从VCS仓库拉取playbook并在目标主机上执行

概要

usage: ansible-pull [-h] [--version] [-v] [--private-key PRIVATE_KEY_FILE]
                 [-u REMOTE_USER] [-c CONNECTION] [-T TIMEOUT]
                 [--ssh-common-args SSH_COMMON_ARGS]
                 [--sftp-extra-args SFTP_EXTRA_ARGS]
                 [--scp-extra-args SCP_EXTRA_ARGS]
                 [--ssh-extra-args SSH_EXTRA_ARGS]
                 [-k | --connection-password-file CONNECTION_PASSWORD_FILE]
                 [--vault-id VAULT_IDS]
                 [-J | --vault-password-file VAULT_PASSWORD_FILES]
                 [-e EXTRA_VARS] [-t TAGS] [--skip-tags SKIP_TAGS]
                 [-i INVENTORY] [--list-hosts] [-l SUBSET] [--flush-cache]
                 [-M MODULE_PATH]
                 [-K | --become-password-file BECOME_PASSWORD_FILE]
                 [--purge] [-o] [-s SLEEP] [-f] [-d DEST] [-U URL] [--full]
                 [-C CHECKOUT] [--accept-host-key] [-m MODULE_NAME]
                 [--verify-commit] [--clean] [--track-subs] [--check]
                 [--diff]
                 [playbook.yml ...]

描述

用于在每个受管理节点上拉取Ansible的远程副本,每个副本都设置为通过cron运行并通过源代码库更新playbook源。这将Ansible的默认*推送*架构反转为*拉取*架构,具有几乎无限的扩展潜力。

所有CLI工具都不设计为与自身并发运行,应使用外部调度程序和/或锁来确保没有冲突的操作。

可以调整设置playbook以更改cron频率、日志位置和ansible-pull的参数。这对于极端规模扩展和定期修复都非常有用。使用“fetch”模块检索ansible-pull运行的日志将是收集和分析ansible-pull的远程日志的绝佳方法。

常用选项

--accept-host-key

如果尚未添加,则添加仓库URL的主机密钥

--become-password-file <BECOME_PASSWORD_FILE>, --become-pass-file <BECOME_PASSWORD_FILE>

提升权限密码文件

--check

不进行任何更改;而是尝试预测可能发生的一些更改

--clean

工作存储库中修改的文件将被丢弃

--connection-password-file <CONNECTION_PASSWORD_FILE>, --conn-pass-file <CONNECTION_PASSWORD_FILE>

连接密码文件

--diff

更改(小)文件和模板时,显示这些文件的差异;与–check配合使用效果很好

--flush-cache

清除清单中每个主机的fact缓存

--full

执行完整克隆,而不是浅克隆。

--list-hosts

输出匹配主机的列表;不执行任何其他操作

--private-key <PRIVATE_KEY_FILE>, --key-file <PRIVATE_KEY_FILE>

使用此文件来验证连接

--purge

在playbook运行后清除检出

--scp-extra-args <SCP_EXTRA_ARGS>

指定要传递给scp的额外参数(例如-l)

--sftp-extra-args <SFTP_EXTRA_ARGS>

指定要传递给sftp的额外参数(例如-f,-l)

--skip-tags

仅运行其标签与这些值不匹配的play和任务。此参数可以多次指定。

--ssh-common-args <SSH_COMMON_ARGS>

指定要传递给sftp/scp/ssh的通用参数(例如ProxyCommand)

--ssh-extra-args <SSH_EXTRA_ARGS>

指定要传递给ssh的额外参数(例如-R)

--track-subs

子模块将跟踪最新的更改。这等效于为git submodule update指定–remote标志

--vault-id

要使用的vault身份。此参数可以多次指定。

--vault-password-file, --vault-pass-file

vault密码文件

--verify-commit

验证检出的提交的GPG签名,如果失败则中止运行playbook。这需要相应的VCS模块来支持此类操作

--version

显示程序的版本号、配置文件位置、配置的模块搜索路径、模块位置、可执行文件位置并退出

-C <CHECKOUT>, --checkout <CHECKOUT>

要检出的分支/标签/提交。默认为存储库模块的行为。

-J, --ask-vault-password, --ask-vault-pass

询问vault密码

-K, --ask-become-pass

询问提升权限密码

-M, --module-path

在模块库前添加冒号分隔的路径(默认值为{{ ANSIBLE_HOME ~ “/plugins/modules:/usr/share/ansible/plugins/modules” }})。此参数可以多次指定。

-T <TIMEOUT>, --timeout <TIMEOUT>

覆盖连接超时时间(以秒为单位)(默认值取决于连接方式)。

-U <URL>, --url <URL>

剧本库的URL。

-c <CONNECTION>, --connection <CONNECTION>

要使用的连接类型(默认值为ssh)。

-d <DEST>, --directory <DEST>

Ansible 将检出代码库到的目录路径。

-e, --extra-vars

设置附加变量为 key=value 或 YAML/JSON 格式,如果文件名以 @ 开头。此参数可以多次指定。

-f, --force

即使无法更新代码库,也运行剧本。

-h, --help

显示此帮助信息并退出。

-i, --inventory, --inventory-file

指定清单主机路径或逗号分隔的主机列表。–inventory-file 已弃用。此参数可以多次指定。

-k, --ask-pass

询问连接密码。

-l <SUBSET>, --limit <SUBSET>

将选定的主机进一步限制到附加模式。

-m <MODULE_NAME>, --module-name <MODULE_NAME>

代码库模块名称,Ansible 将使用它来检出代码库。选项包括('git','subversion','hg','bzr')。默认为 git。

-o, --only-if-changed

只有在代码库已更新的情况下才运行剧本。

-s <SLEEP>, --sleep <SLEEP>

在开始之前休眠随机时间间隔(介于 0 和 n 秒之间)。这是一种分散 git 请求的有用方法。

-t, --tags

仅运行标有这些值的剧本和任务。此参数可以多次指定。

-u <REMOTE_USER>, --user <REMOTE_USER>

以该用户身份连接(默认值为 None)。

-v, --verbose

使 Ansible 打印更多调试消息。添加多个 -v 将增加详细程度,内置插件目前最多支持 -vvvvvv。一个合理的起始级别是 -vvv,连接调试可能需要 -vvvv。此参数可以多次指定。

参数

playbook.yml

要作为 Ansible 剧本运行的一个 YAML 格式文件名称。这可以是检出中的相对路径。默认情况下,Ansible 将根据主机的完全限定域名、主机主机名以及最终名为 *local.yml* 的剧本查找剧本。

环境变量

可以指定以下环境变量。

ANSIBLE_INVENTORY – 覆盖默认的 Ansible 清单文件。

ANSIBLE_LIBRARY – 覆盖默认的 Ansible 模块库路径。

ANSIBLE_CONFIG – 覆盖默认的 Ansible 配置文件。

ansible.cfg 中还有更多选项可用。

文件

/etc/ansible/hosts – 默认清单文件。

/etc/ansible/ansible.cfg – 配置文件,如果存在则使用。

~/.ansible.cfg – 用户配置文件,如果存在则覆盖默认配置。

作者

Ansible 最初由 Michael DeHaan 编写。

请参见 AUTHORS 文件以获取完整的贡献者列表。

许可证

Ansible 按照 GPLv3+ 许可证的条款发布。

另见

ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-vault(1)