ansible-pull

VCS リポジトリーから Playbooks を取得し、ローカルホストで実行します。

概要

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]
                 [--ask-vault-password | --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 のデフォルトの push アーキテクチャーが pull アーキテクチャーに反転します。これには、スケーリングの可能性がほぼ無限あります。

セットアップ Playbook は、cron 頻度、ロギングの場所、およびパラメーターを ansible-pull に変更します。これは、急なスケールアウトと定期的な修復にも便利です。ansible-pull からログを取得するために「fetch」モジュールを使用することは、ansible-pull からログを収集し、分析するための優れた方法です。

共通オプション

--accept-host-key

リポジトリー URL のホストキーが追加されていない場合はホストキーを追加します。

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

Vault のパスワード入力を尋ねます。

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

become パスワードファイル

--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

Playbook の実行後にチェックアウトをパージします。

--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

サブモジュールでは最新の変更を追跡します。これは、--remote フラグを git サブモジュール更新に指定するのと同じです。

--vault-id

使用する Vault アイデンティティー

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

Vault パスワードファイル

--verify-commit

チェックアウトしたコミットの GPG 署名を確認します。Playbook の実行を中断できない場合に、このような操作をサポートするには、対応する VCS モジュールが必要になります。

--version

プログラムバージョン番号、設定ファイルの場所、設定したモジュール検索パス、モジュールの場所、実行可能な場所、および終了を表示します。

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

チェックアウトするブランチ、タグ、またはコミット。デフォルトは、リポジトリーモジュールの動作です。

-K, --ask-become-pass

権限昇格のパスワードを要求します。

-M, --module-path

モジュールライブラリーへのコロン区切りパス (デフォルトは ~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules) を先頭に追加します。

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

接続タイムアウトを秒単位で上書きします (デフォルトは 10)。

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

Playbook リポジトリーの URL

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

使用する接続タイプ (デフォルトは smart)

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

リポジトリーチェックアウトディレクトリーの絶対パス (相対パスはサポートされません)

-e, --extra-vars

ファイル名の前に @ を付ける場合は、追加の変数を key=value または YAML/JSON に設定します。

-f, --force

リポジトリーを更新できなかった場合でも、Playbook を実行します。

-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

リポジトリーが更新されている場合にのみ Playbook を実行します。

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

開始前のランダムな間隔 (0 ~ n 秒間) をスリープ状態にします。これは、git 要求を分散させるための便利な方法です。

-t, --tags

それらの値でタグ付けされたプレイとタスクのみを実行します。

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

このユーザーとして接続します (デフォルトは None)。

-v, --verbose

詳細モード (-vvv の場合はより詳細になり、-vvvv の場合は接続のデバッグを有効にします)

環境

以下の環境変数を指定できます。

ANSIBLE_CONFIG -- デフォルトの Ansible 設定ファイルを上書きします。

ansible.cfg のほとんどのオプションで、さらに多くのものが利用できます。

ファイル

/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-pull(1)ansible-vault(1)