Commit graph

337 commits

Author SHA1 Message Date
Maykel Moya
db618f837f Fix link to Ansible Resources in moduledev page 2013-05-07 13:01:53 +02:00
Michael DeHaan
1b5dd3f15b Clean up variable examples to say "$x" is still fine for a reference. 2013-05-05 13:21:47 -04:00
Michael DeHaan
63b4eea90b Remove searchindex.js from source control. 2013-05-05 12:51:27 -04:00
Michael DeHaan
d1a59fe62b Merge branch 'when_docs' of git://github.com/tartansandal/ansible into devel
Conflicts:
	docsite/latest/rst/playbooks2.rst
	docsite/latest/searchindex.js
2013-05-05 12:43:06 -04:00
Kahlil (Kal) Hodgson
cabd40b0aa add docs for 'when: var is defined' idiom 2013-05-03 08:57:31 +10:00
Lorin Hochstein
c66b724817 Document: sudo works per-task too
Document that you can use sudo at the task level as well
2013-05-02 15:14:53 -04:00
Michael DeHaan
ce67588dcf Fix module doc organization 2013-05-02 11:35:24 -04:00
Michael DeHaan
627b6a0455 Have 1.2 clear in docs 2013-05-02 11:31:51 -04:00
Tim Gerla
bdf50d1fb7 Fix up a couple of references to 'only_if' and change them to 'when' 2013-05-02 09:22:08 -04:00
Michael DeHaan
4ce6eca8b3 Slight tweak to set_fact variable documentation to clarify scope info. 2013-04-29 19:15:29 -04:00
Michael DeHaan
4bea9a612f Don't use "finally" here as it's not 2.4 compliant. 2013-04-28 16:03:03 -04:00
Michael DeHaan
391fb98ee2 Allow modules to be categorized, and also sort them when generating the documentation. 2013-04-28 15:03:45 -04:00
Michael DeHaan
0fd3af8c3c Document regex patterns. 2013-04-27 12:04:22 -04:00
Michael DeHaan
099e7b39a9 use lookup macro rather than with to demonstrate lookup plugins 2013-04-27 11:59:33 -04:00
Michael DeHaan
a61824470d Update gitignore 2013-04-27 11:55:31 -04:00
Michael DeHaan
b6a8d402c5 Document variables are reserved. 2013-04-27 11:54:30 -04:00
Lars Vogdt
21d9789377 added informations for openSUSE and SUSE Linux Enterprise 2013-04-26 11:08:13 +02:00
Michael DeHaan
13e90c396c Merge pull request #2733 from chadoh/patch-1
Documentation: Mention vars_files before the Roles section in playbooks1 chapter
2013-04-22 21:21:30 -07:00
Stoned Elipot
e1ee257619 Default sudo password to SSH password.
While here factor out password prompting in ansible.utils
2013-04-22 23:57:50 -04:00
Michael DeHaan
b1d40ed064 Merge pull request #2734 from chadoh/patch-2
Documentation: Links are the best kinds of instructions
2013-04-21 14:13:06 -07:00
Jim Kleckner
5e5235a433 Nit fix spelling of separate 2013-04-21 12:33:51 -07:00
Chad Ostrowski
e1396f853b Links are the best kinds of instructions
Link people right to this page on Github, so they can click "edit" right there. No need for them to search for the repo, figure out that the docsite isn't a separate repo, and navigate to the given dir.
2013-04-21 13:58:06 -03:00
Chad Ostrowski
0bb145af40 Mention vars_files before the Roles section
The Roles section assumes some familiarity with vars_files, which this note attempts to briefly provide.
2013-04-21 13:45:45 -03:00
Michael DeHaan
7fabaec55f Fix doc formatting error 2013-04-20 22:48:20 -04:00
Michael DeHaan
c9a128a5c5 Rewrote the precedence docs. 2013-04-20 22:44:40 -04:00
Michael DeHaan
cf3c77661b Document the new handler flushing system. 2013-04-20 18:10:01 -04:00
Michael DeHaan
84781bf185 Add documentation about pre_tasks and post_tasks with roles. 2013-04-20 16:21:52 -04:00
Michael DeHaan
adac8f5312 Showcase the new-style lookup plugin access in the authorized_key docs rather than the old-style $FILE 2013-04-20 09:10:19 -04:00
Michael DeHaan
cce2cad8dc Fix with_sequence doc error 2013-04-16 20:42:06 -04:00
Michael DeHaan
84fb92dac6 Working on the FAQ. 2013-04-14 19:32:06 -04:00
Michael DeHaan
728d81bf12 Add link to prior docs version. 2013-04-12 21:48:00 -04:00
Michael DeHaan
62fe4cc3af Explain conditionals as applied to roles. I could also explain with_items but the scope questions are complex
here, and it is better to include such loops inside the imported tasks.
2013-04-12 20:46:12 -04:00
Michael DeHaan
687a68091f Mention roles in best practices 2013-04-12 18:26:17 -04:00
Michael DeHaan
ffb00d2071 Favor {{ foo }} rather than $foo in documentation. 2013-04-12 18:21:09 -04:00
Michael DeHaan
9ed246e432 Resolve merge conflict. 2013-04-12 17:51:55 -04:00
Michael DeHaan
26819d707d Reorganize docs structure to support snapshots. 2013-04-12 17:50:50 -04:00
Michael DeHaan
e63dac15eb Moving some more files into snapshot directory 2013-04-12 17:47:04 -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
Michael DeHaan
b11cf15b3e Merge pull request #2302 from leucos/patch-1
Update playbooks2.rst
2013-03-05 17:14:47 -08:00
Michael DeHaan
0b1343a281 Merge pull request #2306 from tbielawa/docdepends
Update the Makefile and build-site.py to notify of missing dependencies
2013-03-05 17:14:02 -08:00
Tim Bielawa
badb41390e Update the Makefile and build-site.py to notify of missing dependencies for doc compiling 2013-03-05 13:59:39 -05: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
Dag Wieers
59912b47be Allow 'make rpm' without the need for env-setup
As it used to be before, 'make rpm' from a cloned repository should work without the need to run hacking/env-setup. It's an easy fix, in line with what we already did for the man-pages.
2013-03-05 11:12:00 +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
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