diff options
author | James Cammarata <jimi@sngx.net> | 2013-09-13 17:39:14 -0500 |
---|---|---|
committer | James Cammarata <jimi@sngx.net> | 2013-09-13 17:39:14 -0500 |
commit | 8283183023b81f066f42c54826637bbde710d7e5 (patch) | |
tree | a5f752e2172e80c73c5945e4290bf9b58b38d9a1 /docs | |
parent | 2ddbc82639ccc573b3d7212ba50ff8372fab1454 (diff) | |
download | ansible-8283183023b81f066f42c54826637bbde710d7e5.tar.gz |
Adding sshpass as packaging requirement and fixing VERSION
Diffstat (limited to 'docs')
-rw-r--r-- | docs/man/man1/ansible-doc.1 | 17 | ||||
-rw-r--r-- | docs/man/man1/ansible-playbook.1 | 17 | ||||
-rw-r--r-- | docs/man/man1/ansible-pull.1 | 54 | ||||
-rw-r--r-- | docs/man/man1/ansible.1 | 21 |
4 files changed, 84 insertions, 25 deletions
diff --git a/docs/man/man1/ansible-doc.1 b/docs/man/man1/ansible-doc.1 index 16d5759b58..842bacf91e 100644 --- a/docs/man/man1/ansible-doc.1 +++ b/docs/man/man1/ansible-doc.1 @@ -1,13 +1,22 @@ '\" t .\" Title: ansible-doc .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 04/02/2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 09/13/2013 .\" Manual: System administration commands -.\" Source: Ansible 1.2 +.\" Source: Ansible 1.4 .\" Language: English .\" -.TH "ANSIBLE\-DOC" "1" "04/02/2013" "Ansible 1\&.2" "System administration commands" +.TH "ANSIBLE\-DOC" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- diff --git a/docs/man/man1/ansible-playbook.1 b/docs/man/man1/ansible-playbook.1 index 85187cdbcf..996d1c9448 100644 --- a/docs/man/man1/ansible-playbook.1 +++ b/docs/man/man1/ansible-playbook.1 @@ -1,13 +1,22 @@ '\" t .\" Title: ansible-playbook .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 06/03/2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 09/13/2013 .\" Manual: System administration commands -.\" Source: Ansible 1.2 +.\" Source: Ansible 1.4 .\" Language: English .\" -.TH "ANSIBLE\-PLAYBOOK" "1" "06/03/2013" "Ansible 1\&.2" "System administration commands" +.TH "ANSIBLE\-PLAYBOOK" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- diff --git a/docs/man/man1/ansible-pull.1 b/docs/man/man1/ansible-pull.1 index a66fac5900..10e9fd40f2 100644 --- a/docs/man/man1/ansible-pull.1 +++ b/docs/man/man1/ansible-pull.1 @@ -1,13 +1,22 @@ '\" t .\" Title: ansible .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 04/02/2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 09/13/2013 .\" Manual: System administration commands -.\" Source: Ansible 1.2 +.\" Source: Ansible 1.4 .\" Language: English .\" -.TH "ANSIBLE" "1" "04/02/2013" "Ansible 1\&.2" "System administration commands" +.TH "ANSIBLE" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -22,32 +31,55 @@ ansible-pull \- set up a remote copy of ansible on each managed node .SH "SYNOPSIS" .sp -ansible \-d DEST \-U URL [ \-C CHECKOUT ] +ansible \-d DEST \-U URL [options] [ <filename\&.yml> ] .SH "DESCRIPTION" .sp -\fBAnsible\fR is an extra\-simple tool/framework/API for doing \'remote things\' over SSH\&. +\fBAnsible\fR is an extra\-simple tool/framework/API for doing \*(Aqremote things\*(Aq over SSH\&. .sp -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 \fBpush\fR architecture of ansible into a \fBpull\fR architecture, which has near\-limitless scaling potential\&. +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 a source repository\&. This inverts the default \fBpush\fR architecture of ansible into a \fBpull\fR architecture, which has near\-limitless scaling potential\&. .sp The setup playbook can be tuned to change the cron frequency, logging locations, and parameters to ansible\-pull\&. .sp This is useful both for extreme scale\-out as well as periodic remediation\&. Usage of the \fIfetch\fR module to retrieve logs from ansible\-pull runs would be an excellent way to gather and analyze remote logs from ansible\-pull\&. +.SH "OPTIONAL ARGUMENT" +.PP +\fBfilename\&.yml\fR +.RS 4 +The name of one the YAML format files to run as an ansible playbook\&. This can be a relative path within the checkout\&. If not provided, ansible\-pull will look for a playbook based on the host\(cqs fully\-qualified domain name and finally a playbook named +\fBlocal\&.yml\fR\&. +.RE .SH "OPTIONS" .PP \fB\-d\fR \fIDEST\fR, \fB\-\-directory=\fR\fIDEST\fR .RS 4 -Directory to checkout git repository into\&. +Directory to checkout repository into\&. .RE .PP \fB\-U\fR \fIURL\fR, \fB\-\-url=\fR\fIURL\fR .RS 4 -URL of git repository to clone\&. +URL of the playbook repository to checkout\&. .RE .PP \fB\-C\fR \fICHECKOUT\fR, \fB\-\-checkout=\fR\fICHECKOUT\fR .RS 4 -Branch/Tag/Commit to checkout\&. Defaults to -\fIHEAD\fR\&. +Branch/Tag/Commit to checkout\&. If not provided, uses default behavior of module used to check out playbook repository\&. +.RE +.PP +\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR +.RS 4 +The +\fIPATH\fR +to the inventory hosts file\&. This can be a relative path within the checkout\&. +.RE +.PP +\fB\-\-purge\fR +.RS 4 +Purge the checkout after the playbook is run\&. +.RE +.PP +\fB\-m\fR \fINAME\fR, \fB\-\-module\-name=\fR\fINAME\fR +.RS 4 +Module used to checkout playbook repository\&. Defaults to git\&. .RE .SH "AUTHOR" .sp diff --git a/docs/man/man1/ansible.1 b/docs/man/man1/ansible.1 index 813f1a8cc0..5ca174e7f6 100644 --- a/docs/man/man1/ansible.1 +++ b/docs/man/man1/ansible.1 @@ -1,13 +1,22 @@ '\" t .\" Title: ansible .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 05/29/2013 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 09/13/2013 .\" Manual: System administration commands -.\" Source: Ansible 1.2 +.\" Source: Ansible 1.4 .\" Language: English .\" -.TH "ANSIBLE" "1" "05/29/2013" "Ansible 1\&.2" "System administration commands" +.TH "ANSIBLE" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -25,7 +34,7 @@ ansible \- run a command somewhere else ansible <host\-pattern> [\-f forks] [\-m module_name] [\-a args] .SH "DESCRIPTION" .sp -\fBAnsible\fR is an extra\-simple tool/framework/API for doing \'remote things\' over SSH\&. +\fBAnsible\fR is an extra\-simple tool/framework/API for doing \*(Aqremote things\*(Aq over SSH\&. .SH "ARGUMENTS" .PP \fBhost\-pattern\fR @@ -73,7 +82,7 @@ search path to load modules from\&. The default is \fI/usr/share/ansible\fR\&. This can also be set with the ANSIBLE_LIBRARY environment variable\&. .RE .PP -\fB\-a\fR \'\fIARGUMENTS\fR\', \fB\-\-args=\fR\'\fIARGUMENTS\fR\' +\fB\-a\fR \*(Aq\fIARGUMENTS\fR\*(Aq, \fB\-\-args=\fR\*(Aq\fIARGUMENTS\fR\*(Aq .RS 4 The \fIARGUMENTS\fR |