Commit graph

782 commits

Author SHA1 Message Date
Jérémie Augustin
ddf1d71b7d [doc] duplicate group in usa:children group 2013-10-15 17:18:07 +02:00
Maykel Moya
cd051c4a0d Fix building of docsite
* Fix paths in docsite/Makefile having an additional '..'.
* Ignore generated docsite/rst/modules/*.rst
2013-10-15 16:21:19 +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
d22529bad0 Version added info in docs for do/until was missing. 2013-10-14 08:24:43 -04:00
Michael DeHaan
a956c2019f Add some notes about which features are typically rarely used so folks won't feel like they have to understand them all up front. 2013-10-13 08:57:10 -04:00
Michael DeHaan
44b5b9525f Add documents for some additional iteration types. 2013-10-13 08:54:36 -04:00
Michael DeHaan
a20d5462b6 Fix rst doc macro 2013-10-12 12:41:29 -04:00
Michael DeHaan
8faaae142c Fix REST anchor targets 2013-10-12 11:20:56 -04:00
Michael DeHaan
b119adf684 Add note about role search path. 2013-10-12 11:05:22 -04:00
Michael DeHaan
f27a9986c1 Document standardized task/handler include syntax. 2013-10-12 10:57:11 -04:00
Michael DeHaan
6bec262b8e Add an example of failed_when. 2013-10-12 10:51:32 -04:00
Michael DeHaan
fee360f33e Add example.config and main documentation of the roles_path feature. 2013-10-12 10:15:30 -04:00
Michael DeHaan
61c2eb9cb0 Just clarify there are load balancer modules :) 2013-10-12 08:34:41 -04:00
Michael DeHaan
bd20d3c9be Merge pull request #4382 from jryans/devel
Tweak syntax in intro docs
2013-10-08 05:46:45 -07:00
Michael DeHaan
48f97e16e9 Add doc about password generation for user modules in the FAQ. 2013-10-08 08:38:51 -04:00
Michael DeHaan
c69e19c6a6 Enhance references to logging functionality. Fixes #3431. 2013-10-08 08:26:40 -04:00
Michael DeHaan
19386c43a7 Merge 2013-10-07 10:02:21 -04:00
Michael DeHaan
8604212da9 Merge pull request #4352 from jhoekx/mysql-user-grant
Add grant parameter to MySQL user module
2013-10-07 06:08:39 -07:00
lied
ef4ec735b6 Add local provisioning step notes to EC2 pages (adapted with changes by mpdehaan). 2013-10-07 08:29:03 -04:00
J. Ryan Stinnett
5f0b5e92fa Tweak syntax in intro docs 2013-10-06 23:22:34 -04:00
Chris Church
97e9d980b2 Spelling corrections for docsite. 2013-10-05 21:19:19 -04:00
Michael DeHaan
a8637dbde6 Misc docs tweaking. 2013-10-05 14:57:45 -04:00
Michael DeHaan
f0db5508cd Some design concepts. 2013-10-05 14:22:43 -04:00
Michael DeHaan
572fef3854 Allude to ansible-pull. 2013-10-05 14:18:12 -04:00
Michael DeHaan
95fd533d3c Add info about ansible-doc and ansible-pull. 2013-10-05 14:18:12 -04:00
Michael DeHaan
30ae97c5d0 Fix rst link. 2013-10-05 14:04:25 -04:00
Michael DeHaan
715a07d200 Sphinx formatting. 2013-10-05 13:58:03 -04:00
Michael DeHaan
ade46e9aab Various docs cleanup. 2013-10-05 13:50:53 -04:00
Michael DeHaan
d6168189a7 Add toctrees to pages in the docs that did not have them. 2013-10-05 13:25:05 -04:00
Michael DeHaan
4a93f9ee6d Fix some missing hyperlinks to ansible-examples on github. 2013-10-05 12:49:42 -04:00
Michael DeHaan
7891f32fc7 Does "fix malformed hyperlink target" sound any less Star-Trekky than "realign the main deflector array?". 2013-10-05 12:41:26 -04:00
Michael DeHaan
b62b9bda65 Remove duplicate link to old examples dir. 2013-10-05 12:40:53 -04:00
Michael DeHaan
05321cafe1 Add see also sections to pages that do not have them. 2013-10-05 12:31:42 -04:00
Michael DeHaan
46fe4d4b92 Fix some docs formatting. 2013-10-04 20:04:31 -04:00
Michael DeHaan
6ad43c7268 Remove duplicate section, fix a link. 2013-10-04 19:06:20 -04:00
Michael DeHaan
d3b916ed0a Misc docs work. 2013-10-04 19:04:09 -04:00
Michael DeHaan
7f2253451e More anchors! 2013-10-04 18:41:14 -04:00
Michael DeHaan
41909d7fd5 More exciting anchor tags, document more loop features! 2013-10-04 18:34:39 -04:00
Michael DeHaan
b0d5033386 Add lots of anchor tags. 2013-10-04 18:15:04 -04:00
Michael DeHaan
111b3578d6 add more indexes, AWX blurb. 2013-10-04 18:15:04 -04:00
Michael DeHaan
198c9a5903 Adding some labels so we don't get "#id22" for the links in the docs. 2013-10-04 10:41:44 -04:00
Skylar Saveland
1f2047cc39 (docs) result is registered so would be used in the until param of a do-until loop 2013-10-03 13:28:29 -07:00
Jeroen Hoekx
08b0773da5 Add append_privs parameter to MySQL user module.
This adds the privileges given to the existing list of privileges
instead of overwriting any existing ones.
2013-10-03 14:57:01 +02:00
Michael DeHaan
bf7247c78c Update rst 2013-10-02 22:09:02 -04:00
Michael DeHaan
0c2994f653 Misc rst tweaks 2013-10-02 22:06:56 -04:00
Michael DeHaan
2478c1d44d Explain error handling section better. 2013-10-02 22:03:15 -04:00
Michael DeHaan
fd3fb24fe8 Environment doc cleanup and showing another use case. 2013-10-02 22:02:11 -04:00
Michael DeHaan
e9bd97ea4d Slight accelerate mode page simplification. 2013-10-02 21:59:08 -04:00
Michael DeHaan
8dd5a4f0b2 Minor playbooks doc tweaks. 2013-10-02 21:56:55 -04:00
Michael DeHaan
a9a6206674 Fix rst link format 2013-10-02 21:53:05 -04:00
Michael DeHaan
e9851810ca Misc docs fixes 2013-10-02 21:51:21 -04:00
Michael DeHaan
b7c99ed120 Jinja2 link doc fixes 2013-10-02 21:49:30 -04:00
Michael DeHaan
60134c5c88 Slight tweaks to getting started. 2013-10-02 21:45:57 -04:00
Michael DeHaan
1d86a6f129 Slight tweaks to config file chapter. 2013-10-02 21:43:47 -04:00
Michael DeHaan
e0af80946b Slight cleanup to adhoc chapter. 2013-10-02 21:41:46 -04:00
Michael DeHaan
a8ff828593 Minor AWS doc cleanup 2013-10-02 20:58:10 -04:00
Michael DeHaan
0e7ff1690a Add a note about registered variable lifetime. 2013-10-02 20:48:51 -04:00
Michael DeHaan
5c21e81968 Remove redundant section. 2013-10-02 20:46:59 -04:00
Michael DeHaan
585b4d03a8 An approach to explaining precedence more by convention. 2013-10-02 20:23:05 -04:00
James Cammarata
1d08bcd7c5 Adding some version_added strings to the new accelerate configs docs 2013-10-02 08:51:04 -05:00
James Cammarata
b11e12652e Adding new accelerate settings to default config and docs 2013-10-02 08:37:01 -05:00
Michael DeHaan
596626ad31 asn1 is a dependency so no need to mention this in docs. Also no callouts for other OSes so no need for BSD. 2013-10-02 08:16:00 -04:00
James Cammarata
e3ff824ead Minor tweak to doc formatting regarding accelerate package reqs 2013-10-01 16:12:40 -05:00
Berend de Boer
14cfac6b8b Added comment which two packages are needed on FreeBSD. 2013-10-02 09:09:40 +13:00
James Cammarata
c8fa83c93f Minor tweaks to the skipped config wording and adding documentation 2013-09-30 21:02:09 -05:00
Michael DeHaan
7ecb2b6728 Reinstate missing dynamic inventory content. Edits pending. 2013-09-29 20:39:29 -04:00
Michael DeHaan
b64edfe791 "make webdocs" sphinx output is now clean. Edit passes and additional content in docs still pending. 2013-09-29 20:10:37 -04:00
Michael DeHaan
5d6deb68ae More work fixing doc links. 2013-09-29 20:09:30 -04:00
Michael DeHaan
df8b8fc4d6 Fixing some more doc links. Still not done. 2013-09-29 19:30:10 -04:00
Michael DeHaan
4a0e06dc80 Resolving some doc errors. 2013-09-29 19:16:59 -04:00
Michael DeHaan
71ddb80524 Tweaking doc titles. 2013-09-29 19:10:28 -04:00
Michael DeHaan
ad2736b253 Update tags and async sections, among other changes. 2013-09-29 19:03:51 -04:00
Michael DeHaan
c10904bcef Prompts chapter 2013-09-29 18:44:46 -04:00
Michael DeHaan
d494691398 Start of organizing variable section. This is all still in progress and not done, need to fix links between sections and re-add see-also sections, etc, etc. 2013-09-29 17:19:35 -04:00
Michael DeHaan
4cd3c5472f Refactor looping docs 2013-09-29 17:02:53 -04:00
Michael DeHaan
00c2c0b11c Conditionals chapter and some misc tweaks elsewhere 2013-09-29 16:47:34 -04:00
Michael DeHaan
ddf51154fd Delegation documentation split 2013-09-29 16:22:54 -04:00
Michael DeHaan
c4af4c65c3 Update check mode docs 2013-09-29 16:19:59 -04:00
Michael DeHaan
a0ec399f35 Consolidate docs on accelerated mode 2013-09-29 16:18:01 -04:00
Michael DeHaan
19ac7cfe2a Refactor the roles information and provide a good example of the case for using roles. 2013-09-29 16:11:36 -04:00
Michael DeHaan
102b745b31 Add lots of docs on configuration settings, explaining what goes into ansible.cfg 2013-09-29 15:51:26 -04:00
Michael DeHaan
70dc1ef4e4 Update the /usr/bin/ansible example docs 2013-09-29 14:54:53 -04:00
Michael DeHaan
e0ea3decae The patterns document is now it's own chapter since it applies to playbooks and /usr/bin/ansible alike. 2013-09-29 14:45:00 -04:00
Michael DeHaan
65a7ddc824 Organize dynamic inventory documentation. 2013-09-29 14:24:36 -04:00
Michael DeHaan
1e5edb2e0f Clean up inventory section. 2013-09-29 13:50:10 -04:00
Michael DeHaan
720abcb9ed Cleaunup to the getting started section. 2013-09-29 13:29:11 -04:00
Michael DeHaan
87702d50d8 Add missing file (stub) 2013-09-29 13:13:19 -04:00
Michael DeHaan
74e77bf1d8 Refactor install guide 2013-09-29 13:13:05 -04:00
Michael DeHaan
824a8b9136 Fix index formatting. 2013-09-29 12:39:09 -04:00
Michael DeHaan
759430d1e8 Add new topics to index 2013-09-29 12:36:02 -04:00
Michael DeHaan
858b6c4e64 Restructure the documentation index. 2013-09-29 12:12:31 -04:00
Benno Joy
16d0320408 Update playbooks2.rst 2013-09-25 10:48:43 +05:30
bennojoy
daf2f49116 doc update 2013-09-25 10:22:51 +05:30
bennojoy
0e749611ac doc update and add attempts 2013-09-25 09:56:14 +05:30
James Cammarata
0ebc29d3d4 Merge pull request #4203 from candeira/with_nested
fix documentation examples for with_nested
2013-09-22 06:58:42 -07:00
Javier Candeira
2aae5e53de fix examples for with_nested 2013-09-22 22:17:28 +10:00
Joshua Lund
65de1f1c8b Fixed typo in Role Default Variable documentation 2013-09-20 15:45:22 -06:00
James Cammarata
687753e4cb Fixing up some search/replace errors regarding user/remote_user 2013-09-18 12:22:41 -05:00
James Cammarata
25c102d4d8 Adding a note in the documentation regarding user->remote_user change 2013-09-16 06:03:15 -05:00
Brian Coca
b6be9bce5d fixed typo
Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-09-07 17:19:23 -04:00
Brian Coca
d47c48e30a Added remote_user to plays
Still compatible with user: but deprecating it so we can have
a matching remote_user: in tasks, cannot be user: because of the
module of the same name. #3932

Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-09-07 16:34:22 -04:00
Michael DeHaan
f1eb5b45d9 Merge pull request #4056 from jlaska/libselinux-doc
The required package for selinux is libselinux-python
2013-09-06 18:08:40 -07:00
James Laska
546788a1b6 The required package for selinux is libselinux-python 2013-09-06 16:26:48 -04:00
James Cammarata
2c27aa63e0 Updating docs for max_fail_percentage plus CHANGELOG updates 2013-09-06 15:19:34 -05:00
James Cammarata
06090b5cb6 Merge pull request #4040 from ngrilly/devel
Update documentation about Jinja2 expressions in playbooks
2013-09-05 18:46:16 -07:00
James Cammarata
c093bd4f4f Merge pull request #3975 from jimi1283/role_defaults_docs
Adding documentation for role default variables
2013-09-05 18:33:22 -07:00
Nicolas Grilly
aaafd9b608 Update documentation about Jinja2 expressions in playbooks 2013-09-05 21:38:34 +02:00
James Cammarata
ff203dda45 Adding docs for the new accelerated mode 2013-09-02 23:08:00 -05:00
kiri
633eda957d fix JSON extra vars quotation. 2013-09-01 22:36:30 +09:00
James Cammarata
736c8b19d3 Added ability to limit role dependencies to just one inclusion 2013-08-30 12:42:27 -05:00
James Cammarata
8bfba5c0b4 Adding documentation for role default variables 2013-08-30 10:13:22 -05:00
James Cammarata
deb5f027f0 Fixed up a few other pages that had the same versionadded error 2013-08-23 11:33:57 -05:00
James Cammarata
f8a54d162d Fixing versionadded fields in the playbook doc 2013-08-23 11:04:06 -05:00
James Cammarata
f40d39bc92 Minor formatting change 2013-08-22 23:35:23 -05:00
James Cammarata
e1b1d09210 Remove references to old-style variables
Fixes #3842
2013-08-22 23:33:18 -05:00
James Cammarata
1f42fd9964 Remove references to old-style variables
Fixes #3842
2013-08-22 23:29:13 -05:00
James Cammarata
b33cd0c44f Added a note in the advanced playbooks section regarding YAML extra vars 2013-08-22 20:18:15 -05:00
Stoned Elipot
f0743fc32a Introduce the 'always_run' task clause.
The 'always_run' task clause allows one to execute a task even in
check mode.

While here implement Runner.noop_on_check() to check if a runner
really should execute its task, with respect to check mode option
and 'always_run' clause.

Also add the optional 'jinja2' argument to check_conditional() :
it allows to give this function a jinja2 expression without exposing
the 'jinja2_compare' implementation mechanism.
2013-08-20 23:09:44 +02:00
Jon W
d000f23344 typo
just darting a mistyped "ansible"
2013-08-20 12:11:51 -05:00
Jon W
c4ab7009b2 minor corr pip-install
perhaps there may be pip distribution using "pip-install" but "pip install" is universal afaik
2013-08-20 11:39:04 -05:00
Michael DeHaan
15e2ccd2d9 Moving some role deps stuff around a small amount. 2013-08-16 22:05:26 -04:00
Michael DeHaan
42648e2f0a Merge branch 'role_dependencies' of git://github.com/jimi1283/ansible into jimi1283-role_dependencies 2013-08-16 21:42:57 -04:00
Michael DeHaan
0eb1827936 Some install guide tweaks. 2013-08-16 17:02:35 -04:00
James Cammarata
5429586985 Adding documentation on role dependencies and variable scope/inheritance 2013-08-16 10:34:45 -05:00
Michael DeHaan
11fe4566f8 Document facts.d 2013-08-12 09:49:54 -04:00
Michael DeHaan
6af77226fa Merge pull request #3818 from resmo/feature/docsite-update
update docsite about new variable inventory_file
2013-08-11 12:50:20 -07:00
Abhijit Menon-Sen
1a90d01ba9 Fix some typos discovered during casual reading 2013-08-11 18:41:23 +05:30
René Moser
28267de3fe update docsite about new variable inventory_file 2013-08-11 11:08:57 +02:00
Michael DeHaan
220cc75cd9 Merge pull request #3805 from lwade/docs
Modified playbooks2.rst to include conditional boolean example.
2013-08-10 14:24:31 -07:00
lwade
a46e0f9788 Modified playbooks2.rst to include conditional boolean example. 2013-08-09 13:24:48 +01:00
Michael DeHaan
067cc9274d Add note about python-selinux. 2013-08-08 09:15:24 -04:00
Michael DeHaan
18be6dcb62 Use blockquote in docs. 2013-08-06 16:45:24 -04:00
Michael DeHaan
bcaa983c2f Document inventory script upgrades 2013-08-04 11:45:31 -04:00
Michael DeHaan
d039fbe200 Merge pull request #3649 from dekked/extra-vars-from-file
Extra vars from file
2013-08-03 11:31:58 -07:00
Michael DeHaan
82d6323845 Update docs on action shorthand. 2013-08-01 20:28:37 -04:00
Alan Descoins
d505474832 Updated documentation. 2013-07-23 19:49:27 -03:00
Joshua Lund
be6feee058 Minor cleanup of YAML Syntax documentation 2013-07-22 16:09:18 -06:00
Ches Martin
b35fc42d36 Enhance meta-docs on... contributing to docs.
- Update FAQ entry to refer to docsite README and reduce redundancy.

- Add additional info to docsite README: Sphinx building, link to module
  documentation reference.
2013-07-22 17:20:38 +07:00
Tim Gerla
7e07bca6bf very minor fix to playbooks2 to fix a formatting error 2013-07-21 11:50:12 -07:00
Michael DeHaan
77a4dcca85 Sphinx/docs syntax fixes 2013-07-21 11:18:07 -04:00
Michael DeHaan
feb4a8847d Slight edit to when_changed docs 2013-07-21 10:48:22 -04:00
Michael DeHaan
b603bb0f73 Merge branch 'changed_when-doc' of git://github.com/stoned/ansible into devel 2013-07-21 10:41:35 -04:00
Xiao Hanyu
23ff2f2992 Merging docs 2013-07-20 12:44:37 -04:00
Joshua Lund
e8c6da6045 Cleanup Glossary documentation 2013-07-19 17:32:00 -06:00
Michael DeHaan
9314341923 Merge pull request #3465 from jlund/best-practices
Add documentation for Role Variables to the Best Practices page
2013-07-19 07:33:39 -07:00
Michael DeHaan
ce89382473 Legacy variable removal. 2013-07-19 10:27:37 -04:00
Michael DeHaan
597e5075f1 Merge pull request #3585 from devo-ps/documentation
Minor typo on site about host_key_checking config section.
2013-07-19 06:50:28 -07:00
Michael DeHaan
1867fb4888 Update an example. 2013-07-19 09:49:44 -04:00
Michael DeHaan
10bc6f6d9c Merge pull request #3541 from pol/docs_withitems_regivar
Create with_items example with a registered var
2013-07-19 06:46:31 -07:00
Michael DeHaan
c101d4b30b Documentation indentation fix. 2013-07-19 09:33:31 -04:00
Michael DeHaan
deda5c8ee7 Remove backlinks:top which is setting hyperlinks in docs sections so they are hard to bookmark. 2013-07-19 09:33:31 -04:00
Michael DeHaan
ad5ac71219 Merge pull request #3542 from pol/docs_task_format
Update to conventional task format
2013-07-19 06:26:42 -07:00
Michael DeHaan
f938bc660f Slight documentation tweak. 2013-07-19 09:13:30 -04:00
Michael DeHaan
21e06a87ce Merge pull request #3530 from candeira/with_nested
add documentation for with_nested
2013-07-19 06:11:37 -07:00
Vincent Viallet
6a00cb7b3b Minor typo on site about host_key_checking config section. 2013-07-19 13:26:30 +08:00
Joshua Lund
a5459e8a03 * Added documentation for Role Variables
* Fixed a few minor typos
2013-07-16 14:53:20 -06:00
Pol Llovet
8a0861f804 Create with_items example with a registered var 2013-07-15 17:44:50 -06:00
Pol Llovet
d933fef93f Deprecate only_if in favor of when. 2013-07-15 17:41:09 -06:00
Pol Llovet
bd7448ccf0 Update to conventional task format 2013-07-15 17:35:20 -06:00
Javier Candeira
d3a97bfb07 add documentation for with_nested 2013-07-15 14:28:02 +10:00
Stoned Elipot
60d2ad3642 Document changed_when clause 2013-07-14 21:43:10 +02:00
Michael DeHaan
324a28f3dd Merge pull request #3439 from eest/bestpractices_templates_fix
Fix path to ntp.conf.j2 in example.
2013-07-11 05:31:25 -07:00
Michael DeHaan
90dfc115d6 Merge pull request #3463 from stoned/filterskipped
Add Jinja2 filter 'skipped' to test for a registered variable from a ski...
2013-07-11 05:26:25 -07:00
Joshua Lund
7c78fef1f5 Fixed some minor typos in the Advanced Playbooks documentation 2013-07-10 13:09:12 -06:00
Stoned Elipot
906746b1f0 Add Jinja2 filter 'skipped' to test for a registered variable from a skipped task 2013-07-07 22:13:14 +02:00
Michael DeHaan
d002c2d907 Document 'smart' option and connection type default changes. 2013-07-04 19:10:56 -04:00
Michael DeHaan
107ced7ec5 Mention envrionment variable configuration. 2013-07-04 18:56:46 -04:00
Michael DeHaan
1ead97098d Talk more about transports in documentation. 2013-07-04 18:51:47 -04:00
Patrik Lundin
1f1aa1f0a8 Fix path to ntp.conf.j2 in example.
The "common" role adds "common/templates/" to the src path.
2013-07-04 15:42:46 +02:00
Michael DeHaan
f3dc5707a8 Merge pull request #3282 from jlaska/devel
Reference ansible_lsb.major_release, not ansible_lsb.major_version
2013-06-30 16:43:30 -07:00
Michael DeHaan
39105dc853 Fix RST formatting in documentation (underline too short) 2013-06-30 19:01:06 -04:00
Michael DeHaan
6dd93fa964 Some minor doc tweaks 2013-06-30 18:32:49 -04:00
Michael DeHaan
ee4d9b1516 Merge branch 'devel' of git://github.com/shirou/ansible into devel 2013-06-30 18:28:35 -04:00
Michael DeHaan
f2e3a9a850 Merge pull request #3370 from y-p/PR_role_doc_enh
Add doc example of attaching tags to a role
2013-06-30 14:18:11 -07:00
y-p
a4dfc14a6c Add doc example of attaching tags to a role 2013-06-28 16:28:41 +03:00
shirou
a439afeb8f add description about host parameters in a inventory file. 2013-06-28 17:59:47 +09:00
James Laska
eb2ae8b3c2 Reference major_release, not major_version 2013-06-20 08:23:49 -04:00
Michael DeHaan
85ef79443a Fix a documentation formatting warning. 2013-06-19 22:38:04 -04:00
Joshua Lund
0f81d1630f * Updated all ansible.cc references in the documentation to point
to ansibleworks.com
* Fixed a few misspelled words
2013-06-19 19:34:02 -06:00
Michael DeHaan
58f5bfb4c1 Merge pull request #3252 from tgerla/gettingstarted
Explicitly mention the Linux requirement for the Ansible machine, remove...
2013-06-19 17:08:11 -07:00
Tim Gerla
f2cf8d3e67 Fine-tune Ansible control system OS requirements a bit 2013-06-18 18:19:58 -07:00
Jim Tittsler
240a52906e spelling ansbile->ansible 2013-06-19 10:37:02 +12:00
Tim Gerla
6f426f7986 Explicitly mention the Linux requirement for the Ansible machine, and remove a vestigial heading. 2013-06-18 12:12:37 -07:00
Michael DeHaan
89ee762ab7 Merge pull request #3247 from SirScott/vars_prompt_docs
Document the 'default' argument for vars_prompt.
2013-06-18 11:48:49 -07:00
Joshua Lund
ba853b8c1a Fixed a few small typos 2013-06-18 12:26:40 -06:00
Scott Sturdivant
cc12b85e49 Document the 'default' argument for vars_prompt. 2013-06-18 09:25:51 -06:00
Michael DeHaan
fda74110bd Merge pull request #3202 from trbs/20130613_docs_fix_ansible_cfg_loading_order
docs fix ansible cfg loading order
2013-06-16 20:17:25 -07:00
Michael DeHaan
306caf84f9 Merge pull request #3218 from lorin/fileglob-roles
Document: with_file(glob) relative path and roles
2013-06-16 19:52:22 -07:00
Michael DeHaan
a1d1ce8360 Merge branch 'docs_examples' of git://github.com/jpmens/ansible into standardize_docs 2013-06-16 22:07:20 -04:00
Jan-Piet Mens
5c69918d53 DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition)
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string
  Added deprecation warning to moduledev.rst and remove deprecated example from it
  Fixed up a few typos and uppercased some acronyms.
  add consistency to how EXAMPLES are formatted
2013-06-15 20:54:25 +02:00
Lorin Hochstein
d7ba2e06eb Document: with_file(glob) relative path and roles
Document that with_file and with_fileglob path is relative to
the files directory inside of a role.
2013-06-14 11:15:45 -04:00
trbs
653fac2f5c fix loading order of ansible.cfg in documentation 2013-06-13 23:13:54 +02:00
Ralph Bean
dd5707ddd9 Well, a little more readability. 2013-06-11 14:58:28 -04:00
Ralph Bean
416e72c900 Fix a typo in the docs. 2013-06-11 14:54:42 -04:00
Michael DeHaan
643b5e2c5d Fix dead link, remove redundant section. 2013-06-10 18:37:56 -04:00
Michael DeHaan
1fd863cf5d Update docs to reference release tarball directory on new site. 2013-06-10 16:06:58 -04:00
Tim Gerla
8a9cded133 re-add docs css class required for some theme elements 2013-06-10 07:57:13 -07:00
Michael DeHaan
36e9cf5d7d Mention YAML variable quoting. 2013-06-09 21:35:51 -04:00
Michael DeHaan
36c3c91d6e Add roles to glossary. 2013-06-09 21:20:35 -04:00
Buce
7d2422cf92 Update supported package managers
Ansible has modules for package managers other than yum and apt,
so update the documentation accordingly.
2013-06-09 17:16:08 -04:00
Buce
563147d344 Reference Inventory & Patterns more
Link to the Inventory & Patterns page in places where the Getting
Started guide refer to it, so that users unfamiliar with the
inventory syntax can easily familiarize themselves with it.
2013-06-09 17:16:08 -04:00
Tim Gerla
b3e0071635 show entire doc index in left sidebar on the documentation home page 2013-06-09 11:04:16 -07:00
Michael DeHaan
92dce671bb Resolve merge commit 2013-06-09 13:57:20 -04:00
Michael DeHaan
d706aca82b Merge 2013-06-09 13:55:58 -04:00
Michael DeHaan
2f37314d41 Revise section referencing 1.1 since release is Monday. Will push with release. 2013-06-08 14:15:10 -04:00
Michael DeHaan
cabeafc550 Remove 1.1 reference (docs will be pushed with release of 1.2) 2013-06-08 14:14:12 -04:00
Bartłomiej Piotrowski
cd65bbc1c4 Add info about apk-tools module to contrib.rst. 2013-06-06 15:00:05 +02:00
Tim Gerla
a26cbd957c fix heading styles for 'pending information' to avoid creating a new top-level chapter 2013-06-04 14:57:43 -07:00
Patrick Regan
4e5c0da7d6 Trivial typo fix in Amazon documentation 2013-06-03 13:54:26 -04:00
Serge van Ginderachter
18e7974021 add mention of github.com/ginsys/ansible-plugins in contrib.rst 2013-06-02 17:56:12 +02:00
Michael DeHaan
7f0e89a2f6 Explain when statements with |failure and |success. 2013-06-01 17:41:31 -04:00
Michael DeHaan
754d5f91a3 Show how to set PW length. 2013-06-01 12:36:24 -04:00
Michael DeHaan
bddbdd4881 avoid duplicate hyperlink warning (silly Sphinx) 2013-06-01 12:22:06 -04:00
Michael DeHaan
1de2028677 Update docs about examples, add edX online's configuration repo to examples 2013-06-01 11:46:32 -04:00
Michael DeHaan
9f567f05d6 Document group_vars and host_vars additional paths. 2013-06-01 10:40:39 -04:00
Michael DeHaan
fbba92b61e Add an example of JSON extra variables on the command line. 2013-05-31 16:07:40 -04:00
Jan Duzinkiewicz
8ebd1792eb advanced playbooks docs yaml snippets always use --- 2013-05-31 10:54:13 +02:00
Michael DeHaan
e75ab08e3d Merge pull request #3054 from maxamillion/maxamillion/docsite
provide link to older docs when mentioning older docs
2013-05-29 16:55:30 -07:00
Michael DeHaan
53c490f453 Merge pull request #3050 from lorin/os-grizzly-only
Document: OpenStack inventory script needs grizzly
2013-05-29 15:54:49 -07:00
Michael DeHaan
fd77804bff Merge pull request #3017 from sergevanginderachter/roles-script
Add roles support for the script module
2013-05-29 15:54:18 -07:00
Adam Miller
80bf5d49fe provide link to older docs when mentioning older docs 2013-05-29 17:29:59 -05:00
Michael DeHaan
0a28358ebc Minor docs tweak. 2013-05-29 18:27:16 -04:00
Michael DeHaan
c9b2df619b Merge pull request #3043 from mvo5/feature/document-facts
Feature/document facts
2013-05-29 15:23:15 -07:00
Michael DeHaan
31b31a12e7 Merge pull request #3052 from chelsea/devel
Updated loop documentation with explicit example of hash usage
2013-05-29 15:21:19 -07:00
Adam Miller
33870745b1 fix ambiguous use of automatically automatic in Roles docs 2013-05-29 17:14:20 -05:00
Chelsea Robb
b8045bc29e Updated loop documentation with explicit example of hash usage 2013-05-30 08:05:14 +10:00
Michael DeHaan
b5ed926720 Add AWS doc to table of contents. 2013-05-29 14:17:32 -04:00
Lorin Hochstein
bbe352b544 Document: OpenStack inventory script needs grizzly
The OpenStack Inventory script uses the OS-EXT-IPS:type parameter
to distinguish between fixed and floating IP addresses.
This was only added in the Grizzly release, see
https://bugs.launchpad.net/nova/+bug/1117784

Specify in the docs that this inventory script requires Grizzly
or greater.
2013-05-29 11:38:11 -04:00
Michael DeHaan
267b29cec7 Manpage tweaks, docs rebuild 2013-05-29 10:30:04 -04:00
Michael DeHaan
efee2e2630 Some tweaks to EC2 docs 2013-05-29 10:25:54 -04:00
Michael DeHaan
383b8ce14a Merge branch 'awsdocs' of git://github.com/lwade/ansible into devel 2013-05-29 10:15:02 -04:00
Michael DeHaan
2c433cb707 Add an example of Jinja2 casting. 2013-05-29 09:43:32 -04:00
Michael Vogt
746edecf68 fix indent 2013-05-28 18:32:14 +02:00
Michael Vogt
b625f99938 fix typo 2013-05-28 18:25:44 +02:00
Michael Vogt
e13842fad1 add gathering-facts example 2013-05-28 18:23:12 +02:00
Michael Vogt
03e9d9a742 update info on debian/ubuntu packages 2013-05-28 18:12:33 +02:00
Serge van Ginderachter
5859af7285 script support for roles: use the files/ directory
instead of an additional scripts/ directory
2013-05-25 16:51:59 +02:00
Serge van Ginderachter
0224dc464d roles/x/scripts support: update docs
also added example on where regular tasks fit in
2013-05-24 22:42:24 +02:00
lwade
07a1b2f1c1 Start of aws best practices docs 2013-05-24 16:59:24 +01:00
Michael DeHaan
8475a92dec Merge pull request #2939 from mmoya/lookup-crypted-passwds
Add support for crypted passwords to password lookup
2013-05-18 13:17:41 -07:00
Maykel Moya
96afc3f462 Add support for crypted passwords to password lookup
Added new parameter 'encrypt' with same semantics from that of
vars_prompt. When encryption is requested a random salt will be
generated and stored along the password in the form:
'<password> salt=<salt>'.

Also store passwords with an ending '\n' for easier looking at files
with console tools. File content was being already rstripped so this
is harmless.
2013-05-16 13:24:54 +02:00
Stoned Elipot
2b58e03571 Fix registered variable usage example 2013-05-15 22:11:07 +02:00
Michael DeHaan
8a860779fd Add some notes about 1.2 things, just to make it more obvious. 2013-05-11 16:40:09 -04:00
Michael DeHaan
0748e86f0e Fix documentation about examples in modules so folks use the new style. 2013-05-11 16:32:22 -04:00
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