Commit graph

658 commits

Author SHA1 Message Date
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
bd6852eda0 Merge branch 'doc_html_tweaks' of git://github.com/nigelm/ansible into devel 2013-02-25 09:24:56 -05:00
Michael DeHaan
7a6f3e6a6a Missing colon in docs. 2013-02-25 09:22:10 -05:00
Nigel Metheringham
9ae64ffba9 Added top padding to h2 elements so not under menubar 2013-02-24 13:01:09 +00:00
Nigel Metheringham
86d55c1c4d Tweak maximum length of drop down menu 2013-02-24 12:20:16 +00: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
f01def384f Nothing references DOCUMENTATION.yaml, and it's incomplete, so remove it. 2013-02-23 13:36:15 -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
Nigel Metheringham
185790e32a Change title of localtoc menu from Page to Section 2013-02-22 21:18:43 +00: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
Michael DeHaan
bf088a50aa Add when_failed/changed dates 2013-02-02 12:26:26 -05:00
Michael DeHaan
cde5b4b80c Reference sudo flag changeability. 2013-02-02 12:24:48 -05:00
Michael DeHaan
1e3df3b5ab Show how to assign lookup plugins in variables 2013-02-02 12:19:21 -05:00
Michael DeHaan
fe5ab64b62 Document lookup plugin shorthand 2013-02-02 12:03:48 -05:00
Michael DeHaan
78ecc45d4d Document other syntaxes 2013-02-02 12:02:08 -05:00
Michael DeHaan
0ae7f996f5 Make sure all the lookup plugins are documented. 2013-02-02 11:51:25 -05:00
Jeff Blaine
aaf6173fbe Correct python module name for jinja2 2013-01-28 12:52:47 -05:00
Lester Wade
33cc9719ba Update docsite/rst/who_uses_ansible.rst
Added Eucalyptus.
2013-01-25 15:20:43 +00:00
Daniel Hokka Zakrisson
950e3052b8 Merge pull request #1890 from elventear/rabbitmq_contrib
RabbitMQ Contrib
2013-01-23 02:36:45 -08:00
Brendan Taylor
ab63c24358 Make diagram of Directory Organization best practice match the text.
The text and playbook content assumed a directory structure that didn't
match the diagram.
2013-01-22 16:00:14 -07:00
Pepe Barbe
9dfa3ca88f Add my repo for RabbitMQ stuff 2013-01-22 13:23:58 -06:00
Daniel Hokka Zakrisson
94a1c221bc Update variable precedence section with current rules 2013-01-22 16:56:04 +01:00
Michael DeHaan
ea45423f92 Merge pull request #1885 from vincentvdk/devel
added info of required packages to build rpms
2013-01-21 12:36:29 -08:00
Vincent Van der Kussen
4af54e8a3b stylistic change. 2013-01-21 20:49:43 +01:00
Michael DeHaan
1cae679271 Merge pull request #1881 from fdavis/when_changed_fail
add when_changed when_failed example to docsite
2013-01-21 06:57:02 -08:00
Vincent Van der Kussen
614826bcda Fixed my typo and forgot a package 2013-01-21 15:28:16 +01:00
vincent Van der Kussen
80f82f80d8 added info of required packages to build rpms 2013-01-21 15:22:12 +01:00
fdavis
7899e29395 add when_changed when_failed examples to docsite
whitespace fix
2013-01-20 15:50:21 -08:00
Tim Gerla
b814f3dc66 Correct --private-key argument name in Getting Started 2013-01-20 13:24:03 -08:00
Jan-Piet Mens
fc3f50454d typo in ssh private key name 2013-01-12 15:54:21 +01:00
Jayson Vantuyl
13ddd39db9 add with_sequence lookup plugin
Plugin allows you to do easy counts for items.
2013-01-09 15:30:24 -08:00
Daniel Hokka Zakrisson
073fb21bcb Document that task includes are now infinite depth 2013-01-09 13:41:14 +01:00
Francis Besset
e246304256 [docsite] Added LEMP selected playbook 2012-12-24 12:25:17 +01:00
Michael DeHaan
04195e202d Merge pull request #1747 from njharman/alpharange
Alphabetic inventory hostname patterns.
2012-12-17 16:52:11 -08:00
Javier Candeira
dac83c15a0 fix documentation for authorized_key in advanced playbooks page in docsite 2012-12-18 07:23:40 +11:00
Dag Wieers
66fb7fd9de Make use of yes/no booleans in playbooks
At the moment Ansible prefers yes/no for module booleans, however booleans in playbooks are still using True/False, rather than yes/no. This changes modifies boolean uses in playbooks (and man pages) to favor yes/no rather than True/False.

This change includes:

- Adaptation of documentation and examples to favor yes/no
- Modification to manpage output to favor yes/no (the docsite output already favors yes/no)
2012-12-14 11:56:53 +01:00
jkleint
e363abeca7 Missing colon in $FILE example 2012-12-13 16:21:25 -05:00
Mark Theunissen
660bb43e21 Tweak docs for correct paths and filenames 2012-12-12 11:55:52 +02:00
Norman J. Harman Jr
6603737e4d Alphabetic inventory hostname patterns.
- Code, docs, tests.
  - Also added test of large range 000-142 to verify alpha range did not
    break this.
2012-12-10 20:48:38 -06:00
Daniel Hokka Zakrisson
8d309e0fa3 Allow inventory scripts to define groups of groups and group vars 2012-11-28 23:37:29 +01:00
Michael DeHaan
21d858f36d Document new types of plugins. 2012-11-26 18:47:33 -05:00
Michael DeHaan
da90c5f75e Document 'when' and tweak the code to be a little more comprehensive on what is false. 2012-11-26 18:37:44 -05:00
Michael DeHaan
08b3c77dc7 Tweak docs 2012-11-26 18:29:54 -05:00
Michael DeHaan
c8d004434f Limit seperator docs. 2012-11-26 18:29:27 -05:00
Michael DeHaan
9870224991 Tweak fireball docs for 0.9 2012-11-26 18:27:55 -05:00
Jens Rantil
6e3e1c74c9 Fix minor spelling mistake in docsite 2012-11-24 22:55:56 +01:00
Jan-Piet Mens
caf003c813 DOCUMENTATION strings 2012-11-21 18:49:30 +01:00
Michael DeHaan
b46505d59d Update changelog and contrib.rst 2012-11-19 14:18:55 -05:00
Daniel Hokka Zakrisson
b95bcf1b9d Use single-quotes to contain SSH keys as they may contain double-quotes
Fixes #1624.
2012-11-18 18:31:57 +01:00
Michael DeHaan
89bb1b8368 Fixup fireball installation playbook 2012-11-14 18:39:01 -05:00
Michael DeHaan
096607eea4 Allow fireball to transfer binary files, fixup fireball docs, make fetch work with fireball. 2012-11-14 18:37:17 -05:00
Michael DeHaan
8c0f83a2c9 Update "Who Uses Ansible" 2012-11-14 18:21:06 -05:00
Fabian Arrotin
fba75aac0a Added Action.IO to who_uses_ansible and ansible-provisioning to contribs 2012-11-09 17:52:54 +01:00
Fabian Arrotin
2b3aeda33b Added jp_mens' presentation and removed dead links 2012-11-09 17:30:36 +01:00
Dag Wieers
2bccd7b1ac Fix example where imported ssh keys contain spaces
This fixes #1521
2012-11-07 23:58:16 +01:00
Michael DeHaan
aa0af271d6 Quote some stuff in docs 2012-11-03 19:27:14 -04:00
Michael DeHaan
5bda1fc6cc Fix broken link 2012-11-03 19:25:17 -04:00
Michael DeHaan
ac3983a249 revise docs text 2012-11-03 19:19:14 -04:00
Fabian Arrotin
c5a66e96a2 Added the ansible_ssh_host and ansible_ssh_port variable in the patterns/inventory file 2012-10-31 14:43:06 +01:00
Michael DeHaan
2ae090b1db Update 'who uses' page 2012-10-27 18:10:24 -04:00
Michael DeHaan
8dbe6b6a74 Add HP on request 2012-10-25 23:26:24 -04:00
Michael DeHaan
ebd9673ceb Tweak docsite re: resources/contrib page 2012-10-25 23:17:05 -04:00
Jan-Piet Mens
2d4e5ced90 Move contrib to .rst off the main docsite 2012-10-25 14:14:34 +02:00
Jeroen Hoekx
b6ead4d9f8 Add D square to who_uses_ansible. 2012-10-24 15:05:35 +02:00
Nigel Metheringham
ccd8d7c287 Spelling fixes 2012-10-23 15:54:16 +01:00
Nigel Metheringham
dd5629cd51 Correct $last_result example in playbooks doc 2012-10-23 15:51:11 +01:00
Jan-Piet Mens
feab57e270 Reformat code: examples consistently
- added terse syntax to modules.rst
 - added description of special variables to template module
2012-10-23 15:14:01 +02:00
Michael DeHaan
109632e3bc Revert "Vars specified via CLI have the highest priority."
Reverting as this as reported allows some variables to clobber each other.
We'll work on a different fix.

This reverts commit c5469f6367.
2012-10-21 16:42:15 -04:00
Dag Wieers
7d990fa167 Clarify how only_if works, also combined with with_items
- The old documentation stated not to quote the variable in the function, which is obviously wrong. When using lists or integers, we have to quote otherwise the startswith() method will trip over its non-existence.
- It was unclear that the only_if statement is processed for each item when doing with_items, so I added an example making it crystal clear how this can be used in your advantage (or why a non-existing list variable can break your logic if you expected the only_if to be processed once before running the task)
2012-10-22 12:30:47 +02:00
Michael DeHaan
7e2d6c0050 Clarify first_available_file is only for copy/template 2012-10-20 11:16:05 -04:00
Michael DeHaan
ed9f5eed09 Merge pull request #1338 from alopropoz/extra_vars_override
Vars specified via CLI have the highest priority.
2012-10-20 07:29:12 -07:00
Michael DeHaan
31b45479e8 When using delegation, local_action should always use the local connection type. 2012-10-18 20:18:33 -04:00
Michael DeHaan
e59f5d609b Merge pull request #1373 from jpmens/who1
Addition to WhoUses + typo fix
2012-10-18 16:57:50 -07:00
Serge van Ginderachter
d04bd04f80 typo in handlers example yaml 2012-10-18 14:35:35 +02:00
Jan-Piet Mens
b6eacd1631 Addition to WhoUses + typo fix 2012-10-18 14:03:22 +02:00
Michael DeHaan
21b1e6c5a4 Add who uses ansible page back. 2012-10-17 22:28:24 -04:00
Nigel Metheringham
a457d24b97 Added comment about long lines in playbooks
I had trouble finding this information, so though it was worth
adding to docs... but am not sure its easy to find for someone
specifically to find.  At least I think this inclusion matches the
tone of document, but maybe this info should go into a FAQ
instead/as-well?
2012-10-17 15:31:33 +01:00
Michael DeHaan
50abc73bd2 Merge pull request #1353 from jpmens/moduledev1
Indicate module_formatter can produce boilerplate DOCUMENTATION
2012-10-17 05:08:10 -07:00
Jan-Piet Mens
9991dfee6c Indicate module_formatter can produce boilerplate DOCUMENTATION
add ./hacking/
2012-10-17 08:18:39 +02:00
Michael DeHaan
26ee03a43f Searchindex should not be part of source control 2012-10-16 19:14:51 -04:00
Michael DeHaan
2bef84e666 Rebuild docs 2012-10-16 19:14:21 -04:00
Michael DeHaan
97bc11795a more 0.8 docs 2012-10-16 19:12:31 -04:00
Michael DeHaan
0677891fc6 More docs 2012-10-16 19:09:15 -04:00
Michael DeHaan
a98886c77f Further docs hacking 2012-10-16 19:03:54 -04:00
Michael DeHaan
1801ded34d more playbook docs 2012-10-16 18:58:31 -04:00
Michael DeHaan
ca261e8961 more 0.8 documenting 2012-10-16 18:51:10 -04:00
Michael DeHaan
63100c9bc0 Docs + fix variable precedence of environment variables (ok, ok, I give in!) 2012-10-16 18:40:01 -04:00
Michael DeHaan
95db898cde add docs on fireball 2012-10-16 18:30:18 -04:00
Michael DeHaan
618418a440 RST typo 2012-10-16 18:17:04 -04:00
Michael DeHaan
6f14e35c36 Merge pull request #1335 from phgrau/devel
Use && for executing next command if, and only if, command1 returns an e...
2012-10-16 15:16:46 -07:00
Michael DeHaan
4405244224 Docs rebuild 2012-10-16 18:00:47 -04:00
Aleksej Romanov
c5469f6367 Vars specified via CLI have the highest priority. 2012-10-16 04:34:54 +07:00
Philipp Grau
9b15b5d592 Use && for executing next command if, and only if, command1 returns an exit status of zero. 2012-10-15 16:56:55 +02:00
Michael DeHaan
8dadf8a905 Use 'path' in file documentation, though src/dest work, it's less intuitive. 2012-10-12 22:08:07 -04:00
Michael DeHaan
c5d2f6b0d3 implement lookup plugins for arbitrary enumeration over arbitrary things. See the mailing list for some cool examples. 2012-10-12 20:07:05 -04:00
Michael DeHaan
7644dbe330 Update some examples to explain why notify is not used 2012-10-12 18:12:22 -04:00
Michael DeHaan
621708e976 user module should be using module.BOOLEANS for choices 2012-10-12 18:06:36 -04:00
Michael DeHaan
aa98c84a62 HP and vsphere modules are crazy awesome but I am thinking these belong in contrib not core. 2012-10-12 17:49:48 -04:00
Tim Bielawa
4b04d7a914 Add DOCUMENTATION for module documentation. 2012-10-12 17:22:55 -04:00
Michael DeHaan
6d2f003ceb Update formatter to not include orange blocks all over docsite page 2012-10-10 21:25:19 -04:00
Michael DeHaan
e74b9e1d34 Add .gitdir 2012-10-10 20:00:15 -04:00
Michael DeHaan
b505a3796c Fix docsite example 2012-10-10 19:56:53 -04:00
Michael DeHaan
a873e1a467 Don't check in any module RST files as these are generated too. 2012-10-10 19:48:40 -04:00
Michael DeHaan
110244d7b4 Merge branch 'remove-argparse' of git://github.com/dagwieers/ansible into devel
Conflicts:
	hacking/module_formatter.py

Don't run webdocs build when building packages
2012-10-10 18:46:51 -04:00
Michael DeHaan
8ae9831439 Don't check in docsite static HTML, so folks will know to just edit the RST. 2012-10-10 18:41:50 -04:00
Michael DeHaan
dbeb26ad6d Don't check in modules.js either 2012-10-10 18:41:50 -04:00
Michael DeHaan
bbf95abc8f Merge pull request #1276 from mxxcon/patch-1
Typo in example section for 'setup' module docs.
2012-10-10 05:31:22 -07:00
Michael DeHaan
d5bb7258c8 Working on makefile 2012-10-10 08:03:52 -04:00
mxxcon
6b5f19a796 Typo in example section for 'setup' module. 2012-10-09 20:41:26 -03:00
Michael DeHaan
f32778aa93 Update links to contrib 2012-10-08 08:23:11 -04:00
Michael DeHaan
5c09fd4210 update links to plugins 2012-10-08 08:22:05 -04:00
Michael DeHaan
4a95194424 Docs rebuild in new project structure. 2012-10-08 08:09:27 -04:00
Michael DeHaan
87d9eeae57 Remove unused graphics 2012-10-08 07:49:00 -04:00
Michael DeHaan
d6e4b1bf5b Subtree merge of ansible-docs 2012-10-08 07:44:38 -04:00