Commit graph

343 commits

Author SHA1 Message Date
Ferenc Grecu
b93c23d4c7 Fix typos in configuration documentation 2013-12-12 18:51:09 +02:00
Tim Gerla
1063cbea39 tweak some links and phrasing 2013-12-08 19:40:21 -08:00
Tim Gerla
101e8c0a31 flesh out the CI/CD and load balancer sections a bit 2013-12-08 13:19:09 -08:00
Maykel Moya
9018d53a3c Fix link to playbooks loops 2013-12-08 22:09:54 +01:00
Tim Gerla
4da5d267d5 initial commit of a basic rolling upgrade guide, based on the lamp_haproxy example 2013-12-08 12:56:57 -08:00
Maykel Moya
bddb1e3115 Add blank line before rst directive 2013-12-03 11:51:44 +01:00
Michael F. Booth
8a19b595c7 Fix "manual" ansible-playbook example in guide_vagrant.rst
The given example is trying to load an inventory file with the -i option, so it should probably be given the actual Vagrant-written inventory file name. I contemplated using 'vagrant_ansible_inventory_default' instead (which is what my Vagrant demo actually creates) but 'vagrant_ansible_inventory_machinename' is more consistent with the existing example in the docs.
2013-12-01 23:25:23 -05:00
Michael DeHaan
3541bfcb09 Merge pull request #5074 from pcraston/devel
Fix for documentation playbook loops
2013-12-01 14:29:47 -08:00
Tim Gerla
af42f0b771 fix heading name syntax in AWS guide 2013-11-27 12:36:49 -08:00
Patrick Craston
8de0b88c1c Updated Fix for documentation playbook loops
if key is used with lookup parameter needs quotes as
otherwise it will load "ssh-rsa" "<the key>" "<the comment>" as separate
values and fail with "this module requires key=value arguments"
2013-11-27 13:12:50 +00:00
Patrick Craston
20c5b7f800 Fix for documentation playbook loops
if key is used with lookup parameter that needs to be in quotes as
otherwise it will load "ssh-rsa" "<the key>" "<the comment>" as separate
values and fail with "this module requires key=value arguments"
2013-11-27 11:59:11 +00:00
Tim Gerla
fb3d5d6589 elaborate on a couple of sections 2013-11-23 14:59:35 -08:00
Tim Gerla
461afa2b25 remove Vagrant from the list of pending topics 2013-11-23 11:13:56 -08:00
Tim Gerla
1cd71b7899 fix up word wrapping 2013-11-23 11:10:43 -08:00
Tim Gerla
7adf33ed41 add a topical guide for Vagrant integration 2013-11-23 11:07:51 -08:00
James Tanner
2a58c2bbe3 Update files for 1.4 release 2013-11-21 15:11:16 -05:00
Brian Coca
246689c2fd added version added + union, diff and sym_diff filters
Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-11-19 14:37:53 -05:00
Brian Coca
79145b6a78 updated docs to add new filters
Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-11-18 23:40:29 -05:00
Senmiao Liu
d1082af817 Correct the constant name "remote_temp" to "remote_tmp" 2013-11-17 15:37:17 -08:00
Michael Scherer
f290c2aec0 fix various typos in the documentation 2013-11-17 00:26:06 +01:00
James Tanner
48ded5e493 Fix typos in docsite password lookup section 2013-11-12 08:54:19 -05:00
James Tanner
e2b75abb1d Add char parameter to password lookup plugin docs on docsite 2013-11-11 14:54:11 -05:00
James Tanner
9e8eef84e8 Revert "Revert "Delete extra word in index.rst""
This reverts commit 8532263890.
2013-11-11 13:23:27 -05:00
James Tanner
54c510335a Revert "Revert "Tiny RST link fix in modules documentation""
This reverts commit 658dc7a366.
2013-11-11 13:23:03 -05:00
James Tanner
f347133d85 Revert "Move info on limit from the ad hoc command page to the pattern page"
This reverts commit cda707f99e.
2013-11-08 10:51:28 -05:00
James Tanner
658dc7a366 Revert "Tiny RST link fix in modules documentation"
This reverts commit e052251662.
2013-11-08 10:46:13 -05:00
James Tanner
8532263890 Revert "Delete extra word in index.rst"
This reverts commit f52b401755.
2013-11-08 10:45:56 -05:00
James Tanner
66d68b30f2 Revert "Fixes #4092 Add documentation for yaml format of tasks and all keywords"
This reverts commit 3e351b4727.
2013-11-08 10:31:28 -05:00
James Tanner
4169f1b07c Revert "Fixes #4771 Add 1.4.x example of registered var properties to the docsite"
This reverts commit dc74e700ce.
2013-11-08 10:30:45 -05:00
James Tanner
dc74e700ce Fixes #4771 Add 1.4.x example of registered var properties to the docsite 2013-11-08 10:20:05 -05:00
James Tanner
3cdb968ebe Fix some information in the docsite for the password lookup plugin 2013-11-07 16:45:52 -05:00
Steve Tjoa
9ac012bb94 adding link to up-to-date ansible-examples github repo. Also using proper capitalization for GitHub. 2013-11-07 11:44:54 -08:00
jctanner
e9ad19f593 Merge pull request #4824 from mattwillsh/devel
Correct docsite typo hash_behavior -> hash_behaviour
2013-11-06 22:48:12 -08:00
James Tanner
3e351b4727 Fixes #4092 Add documentation for yaml format of tasks and all keywords 2013-11-07 01:43:55 -05:00
James Tanner
c39daed422 Merge pull request #4607 and fix merge conflicts for documentation fixes. 2013-11-06 22:20:58 -05:00
jctanner
1b89abe176 Merge pull request #4669 from SegFaultAX/docs/ssh-ansible-cfg
Change ssh header to ssh_connection header
2013-11-06 19:04:33 -08:00
Matt Willsher
a7d0056a53 Correct type hash_behavior -> hash_behaviour 2013-11-06 17:01:37 +00:00
jctanner
8d9b53b445 Merge pull request #4733 from sivel/4323-sudo-pass
Add ansible_sudo_pass hostvar support. Fixes #4323
2013-11-05 15:01:19 -08:00
James Tanner
a66cfed166 Addresses #4763 list python >= 2.5 as a requirement for accelerate mode 2013-11-04 18:15:11 -05:00
Tomas Thor Jonsson
23bf570bad typo ---- (4) instead of --- (3) 2013-11-04 14:16:33 +01:00
Michael DeHaan
4bb34d006e Merge pull request #4793 from ilkka/patch-2
Fix code block quoting in documentation
2013-11-03 08:55:33 -08:00
Ilkka Laukkanen
31d55e03b0 Fix code block quoting
Add double colons where necessary to get code blocks, not blockquotes.
2013-11-03 18:31:25 +02:00
Ilkka Laukkanen
e0e01ddbe4 Clarify cobbler.py usage and testing instructions
The doc incorrectly advised executing the static inventory, not the `cobbler.py` script. Also fixes minor language issue.
2013-11-03 18:26:28 +02:00
Rhett Sutphin
aa475d337a Document env dependency for test-module.
You need to source hacking/env-setup before running hacking/test-module;
otherwise you get an error like this:

    ImportError: No module named ansible.utils
2013-11-01 12:32:15 -05:00
Matt Martz
ea2ec6237a Add ansible_sudo_pass hostvar support 2013-10-30 13:18:35 -05:00
Tim Gerla
0f80364994 fix command to make a debian package 2013-10-28 15:04:16 -07:00
Tim Gerla
b7899b5e35 Add a clarifying heading to installation docs 2013-10-28 08:55:25 -07:00
Matt Jaynes
8fa003eadb Fix typos. Prevent double-dashes from being reduced to single dash. 2013-10-27 11:51:42 -04:00
Michael-Keith Bernard
d1d4af8b11 Change ssh header to ssh_connection header 2013-10-24 11:24:24 -07:00
Lars Francke
f52b401755 Delete extra word in index.rst 2013-10-22 01:14:24 +02:00
Lars Francke
e052251662 Tiny RST link fix in modules documentation 2013-10-22 01:10:54 +02:00
Lars Francke
d7478e591c Update intro_configuration.rst
Minor RST fixes
2013-10-22 01:05:40 +02:00
Lars Francke
cda707f99e Move info on limit from the ad hoc command page to the pattern page 2013-10-21 11:17:25 +02:00
Lars Francke
544458e859 Update intro_adhoc.rst
Update link texts (hopefully got those correct from Sphinx documentation) and remove section on Limiting hosts as that's covered elsewhere
2013-10-21 11:17:16 +02:00
Lars Francke
afbc2b448d Update intro_dynamic_inventory.rst
Minor fixes, style and typos
2013-10-21 00:17:26 +02:00
Lars Francke
5c905fd165 Fix a few minor issues in the Getting started document 2013-10-20 23:44:19 +02:00
awiddersheim
9d141c5f34 Fixed typo in docsite/rst/playbooks_tags.rst 2013-10-18 23:00:50 -04:00
Adam Miller
5b2338b2bf fix change_when example for False 2013-10-18 13:13:13 -05:00
Greg Karékinian
86f4e03bb5 Fix typo 2013-10-17 16:00:58 +02:00
Jérémie Augustin
ddf1d71b7d [doc] duplicate group in usa:children group 2013-10-15 17:18:07 +02:00
James Tanner
6b60267898 Document per task remote_user, based on #3932 2013-10-15 09:40:37 -04:00
Michael DeHaan
0cd09dd54f Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
Michael DeHaan
26819d707d Reorganize docs structure to support snapshots. 2013-04-12 17:50:50 -04:00
Michael DeHaan
148d8859ba Docs on parameterized roles, make document generation output less noisy 2013-04-12 17:45:27 -04:00
Michael DeHaan
a0a2ef3d9d Merge pull request #2640 from trevor/devel
make json valid
2013-04-11 09:35:46 -07:00
Trevor Wennblom
b779fa4fe9 make json valid 2013-04-10 23:43:16 -05:00
Michael DeHaan
c5d9823467 Fix some items related to playbook includes and indentation. 2013-04-10 15:04:41 -04:00
gw0
80a4e02372 Improved Lookup plugins documentation 2013-04-05 20:00:23 +03:00
Michael DeHaan
f9890c9973 Show other way to ignore command/shell errors 2013-03-29 21:38:33 -04:00
Michael DeHaan
bccab0f2b7 Merge pull request #2514 from raphinou/patch-1
replaced && by ||
2013-03-29 18:36:53 -07:00
Michael DeHaan
cdf5e006ff Merge pull request #2508 from tgerla/devel
Add some examples for local_action and rsync
2013-03-29 05:46:40 -07:00
Victor Castell
ceede2f71f Place ad-hoc stuff from docs under context 2013-03-28 16:39:06 +01:00
raphinou
ba2582fff6 replaced && by ||
In the example, you want /bin/true to be executed if the first command has an error return code. Combining command with && will run the second only if the first is successful. Combining them with ||, the second will be run only of the first fails, what is wanted here.
2013-03-27 14:37:31 +01:00
Tim Gerla
d3a7c729ab Add a note regarding rsync and ssh-agent/passphrase-less keys 2013-03-26 19:37:06 -07:00
Tim Gerla
0e01085ab6 Add some examples for local_action and rsync 2013-03-26 13:34:16 -07:00
Michael DeHaan
783a12cc0e Resolve merge commit. 2013-03-25 22:32:01 -04:00
Michael DeHaan
518007a1ba Fix version added attribute, update docs URL 2013-03-25 10:56:32 -04:00
Michael DeHaan
3d5aa5dc2c Merge pull request #2487 from dorfsmay/20130322
fixed doc regarding wild card pattern on groups.
2013-03-24 14:26:07 -07:00
michael@ansibleworks.com
ecda87cb63 Fixup docsite links 2013-03-24 16:41:20 -04:00
michael@ansibleworks.com
e086d6fd89 Doc updates 2013-03-24 16:41:20 -04:00
Yves Dorfsman
5485451ddb fix doc regarding wild card pattern on groups. 2013-03-22 23:05:40 -06:00
Tim Gerla
242f988daf Add links to the ansible-examples repository 2013-03-20 09:45:41 -07:00
Yves Dorfsman
8b10cc5946 Mention of ansible-doc and man pages for modules. 2013-03-18 20:31:42 -06:00
Michael DeHaan
22cd10bc6f Add note about wanting to do crypted passwords with $PASSWORD plugin. 2013-03-17 11:48:27 -04:00
Michael DeHaan
afb9ad1358 Fix duplicate Sphinx target in documentation. 2013-03-17 11:46:25 -04:00
Michael DeHaan
64a3839511 Fixup documentation formatting 2013-03-17 11:45:22 -04:00
Lorin Hochstein
efd3cbe8b4 Document how to implement check mode
Fixes #2410
2013-03-16 21:45:22 -04:00
bfx81
649dc25d46 Updated getting ansible on gentoo 2013-03-16 15:21:04 +01:00
Michael DeHaan
7d6d009d15 Merge pull request #2411 from tyll/docs
glossary.rst: fix type regarding file mode
2013-03-15 18:07:28 -07:00
Lorin Hochstein
c7cf2bc343 Docfix: ANSIBLE_LIBRARY_PATH -> ANSIBLE_LIBRARY 2013-03-15 14:55:53 -04:00
Till Maas
2b4621d8d7 glossary.rst: fix typo regarding file mode 2013-03-15 19:43:47 +01:00
Yves Dorfsman
2d0df2f233 Rephrased an awkward sentence. 2013-03-12 10:25:44 -06:00
Yves Dorfsman
d1d7d56315 typo in playbooks2.rst 2013-03-12 10:21:57 -06:00
Michael DeHaan
c53653dc0d Merge pull request #2348 from candeira/password-plugin
password lookup plugin, with working tests and documentation
2013-03-10 16:31:17 -07:00
Michael DeHaan
daf7419f3a Make Python 3 instructions a bit more clear. 2013-03-17 23:26:57 -04:00
Javier Candeira
ca6c36e1ac password lookup plugin, with working tests and documentation 2013-03-10 13:36:53 +11:00
Michel Blanc
9c6b28c218 Update gettingstarted.rst
Adds note on python 3 incompatibility
Added note about ansible_python_interpreter for people having python3 as default interpreter (mainly Arch users ?)
Should fix #2344
2013-03-08 23:09:28 +01:00
Jim Kleckner
92844d3dcd Minor spelling fixes 2013-03-06 10:41:19 -08:00
Michel Blanc
aeed04b73f Cosmetic fixes
Fixed typo in passlib URL link
Fixed style in cryp scheme list
Fixed bullet 7 in variable precedence section
Adds statement regarding passlib requirement
2013-03-05 17:28:09 +01:00
Michel Blanc
f3b06a3008 Adds crypt scheme list for vars_prompt
Added more details on encrypt usage for vars_prompt, including a list of
crypt schemes and a ling to the passlib documentation.
2013-03-05 17:19:14 +01:00
Michel Blanc
d03954a24b Update playbooks2.rst
Added doc on encrypt capability of vars_prompt.
Assuming the example in https://github.com/ansible/ansible/blob/devel/examples/playbooks/prompts.yml is still valid.
2013-03-05 16:26:24 +01:00
Daniel Hokka Zakrisson
b130716b61 YAML requires quoting the entire value when it starts with a quote
Fixes #2280.
2013-03-02 21:35:51 +01:00
Michael DeHaan
de09e9dade Update doc reference to clarify that $item isn't expanded here. 2013-03-02 11:47:43 -05:00
Brian Coca
372b60a5f7 Added tip about ANSIBLE_KEEP_REMOTE_FILES to docsite
Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-03-01 19:13:37 -05:00
Michael DeHaan
a19a0ca91b Update documentation on complex args to new simpler format. 2013-03-01 17:08:36 -05:00
Michael DeHaan
ff32e404d5 Most people are better off doing looping inside the playbook versus
outside, and get confused about scope.  As a result simply this documentation
feature by not talking about it :)
2013-03-01 16:20:50 -05:00
Daniel Hokka Zakrisson
52c9a7af24 Fix references to user.username to be user.name 2013-02-28 14:02:59 +01:00
Cliffano Subagio
19082f7b20 Fix proxy env format
The incorrect format (e.g. http_proxy=http://proxy.bos.example.com:8080) gave this error: "environment must be a dictionary".
2013-02-28 10:39:08 +11:00
Michael DeHaan
f6e3583b9b Fix path to DOCUMENTATION.yml 2013-02-25 09:36:50 -05:00
Michael DeHaan
3aceae57af Fixup documentation formatting 2013-02-25 09:35:05 -05:00
Michael DeHaan
a5e4f4461e Add linode example, remove macports since it didn't do changed=True/etc 2013-02-25 09:35:05 -05:00
Michael DeHaan
7a6f3e6a6a Missing colon in docs. 2013-02-25 09:22:10 -05:00
Lorin Hochstein
2e8533aec2 Add a missing :: in an .rst file
Other changes are just eating trailing whitespace.
2013-02-23 16:47:47 -05:00
Michael DeHaan
908a192736 Documentation updates 2013-02-23 15:17:50 -05:00
Michael DeHaan
c86b34dae1 Lots of docsite additions for new features + cleanup lineinfile YAML docs 2013-02-23 15:08:33 -05:00
Michael DeHaan
3422ae6737 Document how to do task includes using with_items and externalized data. 2013-02-23 14:56:25 -05:00
Michael DeHaan
9a04c7eabc Add more 1.1 features 2013-02-23 14:37:50 -05:00
Michael DeHaan
d8a77c0468 Add some 1.1 feature documentation 2013-02-23 14:34:29 -05:00
Michael DeHaan
69f0ce422e temporarily disabled, want to re-layout this later. 2013-02-23 13:37:41 -05:00
Michael DeHaan
7650d7c20e Explain ansible_python_interp. a little better 2013-02-23 13:33:21 -05:00
Michael DeHaan
1c6b0f93f1 Best practices doc updates 2013-02-23 13:33:21 -05:00
Michael DeHaan
a2915bff8d Fix typo in svc docs 2013-02-23 13:33:21 -05:00
Michael DeHaan
e51707711c Merge pull request #2120 from jpmens/doc_ex1
Add support for additional EXAMPLES string in Ansible modules
2013-02-23 08:58:34 -08:00
jibs
fbe0b2ab43 minor docs tweak: link directly to ec2 ini file 2013-02-21 15:24:45 +00:00
Jimmy Tang
7f980bba8f Added more users of ansible (TCHPC and DRI) 2013-02-20 14:19:12 +00:00
Michael DeHaan
7f9bb9084f Rewrite best practices section. 2013-02-18 23:29:27 -05:00
Jan-Piet Mens
396a07bcc7 Add support for additional EXAMPLES string in Ansible modules
return DOC and EXAMPLES as a list
add moduledev explanation
more
2013-02-18 20:02:46 +01:00
Lorin Hochstein
c6778e796c Specified when PIPE_ONCE was added.
Also, now shows when "Getting values from files" was added, a sphinx
directive was missing a colon.
2013-02-17 12:55:47 -05:00
Lorin Hochstein
ec16b854a5 Document new PIPE_ONCE macro 2013-02-17 12:47:51 -05:00
Michael DeHaan
c000bd846b Hate to do this, but URI module docs were constructing messed up RST files, so removing examples for now. Will ask someone to work on them. 2013-02-16 18:45:59 -05:00
Michael DeHaan
ae2d7eb7af Rough cut at adding a glossary section. This could definitely use some improvements, proof reading, and lots of cross linking. 2013-02-16 18:36:06 -05:00
Michael DeHaan
a6653a8723 Clean up the installation section and mention pip. 2013-02-16 16:06:30 -05:00
Michael DeHaan
4d880ec69a Updating links to useful articles 2013-02-16 15:54:05 -05:00
Michael DeHaan
02db951708 Update releases link on getting started page. 2013-02-16 15:51:31 -05:00
Michael DeHaan
8333b4eb03 Better explain magic variables 2013-02-16 15:49:42 -05:00
Michael DeHaan
408deab4e0 Slight doc tweak 2013-02-16 15:28:52 -05:00
Michael DeHaan
32f682946f Add video link to docsite 2013-02-16 15:18:42 -05:00
Michael DeHaan
c79f8cc316 add user to who uses page 2013-02-16 14:53:52 -05:00
Michael DeHaan
6f0c9592bb Additions to Who Uses Ansible 2013-02-09 23:05:09 -05:00
Michael DeHaan
85b52ca625 Resort the who uses ansible page 2013-02-09 22:49:00 -05:00
Michael DeHaan
f41cf5528c Add complex networking setup to docs! 2013-02-09 22:47:19 -05:00
Michael DeHaan
550a1b5f02 Remove mercurial module reference now that we have a cleaned up hg module in core now! 2013-02-09 14:13:46 -05:00
Michael DeHaan
5457e969db Add a reference to Coderwall for tips & tricks! 2013-02-09 14:13:46 -05:00
Lorin Hochstein
44084a83a4 Document :& host notation and using variables with hosts 2013-02-09 10:47:52 -05:00
Michael DeHaan
7d43865e13 Merge pull request #1986 from jcftang/devel
Documentation Fixes relating to OSX and macports
2013-02-07 05:04:03 -08:00
Stoned Elipot
312ba593fd Fix yum module examples: the 'pkg' parameter is now 'name' 2013-02-07 13:27:53 +01:00
Jimmy Tang
7a40ed41f7 Documentation Fixes relating to OSX and macports
Insert some notes about installing on OSX via macports
2013-02-04 19:57:33 +00:00
Michael DeHaan
5cdc25ec47 Tweak documentation example about lookup plugins 2013-02-02 12:56:56 -05:00
Michael DeHaan
f4dddfdbab Fixup inventory docs 2013-02-02 12:43:05 -05:00
Michael DeHaan
dd91452eda Better explain precedence. 2013-02-02 12:29:49 -05:00