diff options
| author | Stephen Fromm <stephenf@nero.net> | 2013-07-23 10:45:40 -0700 |
|---|---|---|
| committer | James Cammarata <jimi@sngx.net> | 2013-08-20 13:43:26 -0500 |
| commit | 77b8ee1f84e0416f82012c1dca9ae43bb6204a7f (patch) | |
| tree | 2504538f381d05f71de93e448a0977c4658dd2a1 /docs | |
| parent | cc3651592b28acfeb58e4aa1b59b9f40dded4d29 (diff) | |
| download | ansible-77b8ee1f84e0416f82012c1dca9ae43bb6204a7f.tar.gz | |
Update ansible-pull man page doc (issue #3372)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/man1/ansible-pull.1.asciidoc.in | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/docs/man/man1/ansible-pull.1.asciidoc.in b/docs/man/man1/ansible-pull.1.asciidoc.in index 19ed537dea..6d73f4104d 100644 --- a/docs/man/man1/ansible-pull.1.asciidoc.in +++ b/docs/man/man1/ansible-pull.1.asciidoc.in @@ -12,7 +12,7 @@ ansible-pull - set up a remote copy of ansible on each managed node SYNOPSIS -------- -ansible -d DEST -U URL [ -C CHECKOUT ] [ -i INVENTORY ] [ <filename.yml> ] +ansible -d DEST -U URL [options] [ <filename.yml> ] DESCRIPTION @@ -23,8 +23,9 @@ SSH. Use ansible-pull to set up a remote copy of ansible on each managed node, each set to run via cron and update playbook source via -git. This inverts the default *push* architecture of ansible into a -*pull* architecture, which has near-limitless scaling potential. +a source repository. This inverts the default *push* architecture of +ansible into a *pull* architecture, which has near-limitless scaling +potential. The setup playbook can be tuned to change the cron frequency, logging locations, and parameters to ansible-pull. @@ -41,7 +42,7 @@ OPTIONAL ARGUMENT *filename.yml*:: The name of one the YAML format files to run as an ansible playbook. This can -be a relative path within the git checkout. If not provided, ansible-pull +be a relative path within the checkout. If not provided, ansible-pull will look for a playbook based on the host's fully-qualified domain name and finally a playbook named *local.yml*. @@ -51,24 +52,29 @@ OPTIONS *-d* 'DEST', *--directory=*'DEST':: -Directory to checkout git repository into. +Directory to checkout repository into. *-U* 'URL', *--url=*'URL':: -URL of git repository to clone. +URL of the playbook repository to checkout. *-C* 'CHECKOUT', *--checkout=*'CHECKOUT':: -Branch/Tag/Commit to checkout. Defaults to 'HEAD'. +Branch/Tag/Commit to checkout. If not provided, uses default behavior +of module used to check out playbook repository. *-i* 'PATH', *--inventory=*'PATH':: The 'PATH' to the inventory hosts file. This can be a relative path within -the git checkout. +the checkout. *--purge*:: -Purge the git checkout after the playbook is run. +Purge the checkout after the playbook is run. + +*-m* 'NAME', *--module-name=*'NAME':: + +Module used to checkout playbook repository. Defaults to git. AUTHOR |