ansible-pull

从某个版本控制系统代码库中拉取 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] [-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 可被调整为改变 ansible-pullcron 频率、日志记录位置及参数等。这对极端扩展,以及定期修复都很有用。使用 fetch 模组,从 ansible-pull 的运行中检索日志,是收集和分析 ansible-pull 远端日志的绝佳方法。

常用选项

  • --accept-host-key,如果尚未添加,则网址添加代码仓库 URL 的主机密钥;
  • --become-password-file <BECOME_PASSWORD_FILE>, --become-pass-file <BECOME_PASSWORD_FILE>become 的口令文件;
  • --check,不做任何改变,而是尝试预测可能发生的一些变化;
  • --clean,处于工作中代码仓库下,被修改的文件将被丢弃;
  • --become-password-file <BECOME_PASSWORD_FILE>, --become-pass-file <BECOME_PASSWORD_FILE>become 的口令文件;
  • --clean,处于工作中代码仓库下,被修改的文件将被丢弃;
  • --diff,更改(小)文件和模板时,显示这些文件的差异;与 --check 一起使用效果极佳;
  • --full,进行完整克隆,而不是浅层克隆;
  • --connection-password-file <CONNECTION_PASSWORD_FILE>, --conn-pass-file <CONNECTION_PASSWORD_FILE>,连接的口令文件;
  • --diff,更改(小)文件和模板时,显示这些文件的差异;与 --check 一起使用效果极佳;
  • --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-password-file, --vault-pass-file,保险库口令文件;
  • --verify-commit,验证已签出提交的 GPG 签名,如果验证失败,则中止运行该 playbook。这需要相应的 VCS 模组,来支持此类操作;
  • --version,显示程序的版本号、配置文件位置、所配置的模组搜索路径、模组位置、可执行文件位置并退出;
  • -C <CHECKOUT>, --checkout <CHECKOUT>,要签出的分支/标签/提交。默认值为版本库模组的行为方式;
  • -J, --ask-vault-password, --ask-vault-pass,询问保险库口令;
  • -K, --ask-become-pass,询问权限提升口令;
  • -M, --module-path,添加以冒号分隔的路径,作为模组库(default={{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }})。此参数可指定多次;
  • -T <TIMEOUT>, --timeout <TIMEOUT>,覆盖连接超时,以秒为单位(默认值取决于连接方式);
  • -U <URL>, --url <URL>,playbook 源码库的 URL;
  • -c <CONNECTION>, --connection <CONNECTION>,要使用的连接类型(default=ssh);
  • -d <DEST>, --directory <DEST>,Ansible 将签出版本库到的目录路径;
  • -e, --extra-vars,以 key=value 方式, 或文件名前添加了 @ 的 YAML/JSON 方式,设置一些额外变量。此参数可指定多次;
  • -f, --force,即使版本库无法更新,也要运行 playbook;
  • -h, --help,打印此帮助消息并退出;
  • -i, --inventory,指定仓库主机路径,或逗号分隔的主机列表。--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,仅在版本库已更新的情况下运行 playbook;
  • -s <SLEEP>, --sleep <SLEEP>,启动前的随机睡眠时间间隔(0n 秒之间)。这是分散 git 请求的有效方法;
  • -t, --tags,只运行标记了这些值的 play 和任务。该参数可指定多次;
  • -u <REMOTE_USER>, --user <REMOTE_USER>,以该用户身份连接(default=None);
  • -v, --verbose,会导致 Ansible 打印更多调试信息。添加多个 -v 会增加调试信息的冗余度,内置插件目前最多会评估到 -vvvvv。 开始时的合理级别是 -vvv,连接的调试则可能需要 -vvvv。可以多次指定此参数;

参数,arguments

  • playbook.yaml,要作为 Ansible playbook 运行的 YAML 格式文件的名称。可以是签出中的相对路径。默认情况下,Ansible 会根据主机的 FQDN、主机名和名为 local.yml 的 playbook 顺序,查找 playbook。

环境

可以指定以下环境变量。

  • ANSIBLE_INVENTORY - 覆盖默认的 ansible 仓库文件;
  • ANSIBLE_LIBRARY - 覆盖默认的 ansible 模组库路径;
  • ANSIBLE_CONFIG - 覆盖默认的 ansible 配置文件。

ansible.cfg 中的大多数选项,都有更多可用选项。

文件

  • /etc/ansible/hosts - 默认的仓库文件;
  • /etc/ansible/ansible.cfg - 若存在,就会用到的配置文件;
  • ~/.ansible.cfg - 用户配置文件,会覆盖存在的默认配置。

(End)

(End)

Last change: 2025-01-10, commit: 8449e5a

小额打赏,赞助 xfoss.com 长存......

微信 | 支付宝

若这里内容有帮助到你,请选择上述方式向 xfoss.com 捐赠。