92 lines
3.6 KiB
Groff
92 lines
3.6 KiB
Groff
'\" t
|
|
.\" Title: ansible
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
|
|
.\" Date: 11/27/2013
|
|
.\" Manual: System administration commands
|
|
.\" Source: Ansible 1.4.1
|
|
.\" Language: English
|
|
.\"
|
|
.TH "ANSIBLE" "1" "11/27/2013" "Ansible 1\&.4\&.1" "System administration commands"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
ansible-pull \- set up a remote copy of ansible on each managed node
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
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\&.
|
|
.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 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, on the host hostname 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 repository into\&. If not provided, a subdirectory of ~/\&.ansible/pull/ will be used\&.
|
|
.RE
|
|
.PP
|
|
\fB\-U\fR \fIURL\fR, \fB\-\-url=\fR\fIURL\fR
|
|
.RS 4
|
|
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\&. If not provided, uses default behavior of module used to check out playbook repository\&.
|
|
.RE
|
|
.PP
|
|
\fB\-f\fR, \fB\-\-force\fR
|
|
.RS 4
|
|
Force running of playbook even if unable to update playbook repository\&. This can be useful, for example, to enforce run\-time state when a network connection may not always be up or possible\&.
|
|
.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
|
|
Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&.
|
|
.SH "COPYRIGHT"
|
|
.sp
|
|
Copyright \(co 2012, Michael DeHaan
|
|
.sp
|
|
Ansible is released under the terms of the GPLv3 License\&.
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBansible\fR(1), \fBansible\-playbook\fR(1), \fBansible\-doc\fR(1)
|
|
.sp
|
|
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
|