ansible-pull
从 VCS 仓库拉取剧本并在目标主机上执行
概要
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] [-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 运行，并通过源代码库更新剧本源。这将 Ansible 的默认推送架构反转为拉取架构，具有几乎无限的扩展潜力。
所有 CLI 工具都不设计为与自身并发运行，您应该使用外部调度程序和/或锁定来确保没有冲突的操作。
设置剧本可以调整以更改 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 一起使用效果很好
- --full
执行完整的克隆，而不是浅克隆。
- --list-hosts
输出匹配主机的列表；不执行任何其他操作
- --private-key <PRIVATE_KEY_FILE>, --key-file <PRIVATE_KEY_FILE>
使用此文件验证连接
- --purge
在剧本运行后清除检出
- --scp-extra-args <SCP_EXTRA_ARGS>
指定要传递给 scp 的额外参数（例如 -l）
- --sftp-extra-args <SFTP_EXTRA_ARGS>
指定要传递给 sftp 的额外参数（例如 -f、-l）
- --skip-tags
仅运行标签与这些值不匹配的剧本和任务。此参数可以多次指定。
- --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 签名，如果失败，则中止运行剧本。这需要相应的 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 在 GPLv3+ 许可证条款下发布。
另请参阅
ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-vault(1)