Commit graph

744 commits

Author SHA1 Message Date
Thomas Tourlourat
050a2dc919 Add missing connection and header 2014-12-09 14:28:57 +01:00
Lorin Hochstein
c4d5e9195b Docfix: checking a background task
Minor changes to wording on how to check a background task with async_status.

Fixes #9740
2014-12-08 21:52:03 -05:00
Michael DeHaan
5890876d72 Merge pull request #9737 from lorin/doc-nopoll
Docfix: running background tasks without polling
2014-12-08 14:04:19 -08:00
Lorin Hochstein
e86259cdf3 Docfix: running background tasks without polling
Fix the example in the doc to explicitly set the poll interval to zero so the
job doesn't poll.

To run a background task without polling, you need to set the poll interval to
zero. However, Ansible's default poll setting is 15 seconds, so not specifying the poll
interval will cause a background job to poll.
2014-12-06 21:24:50 -05:00
Veres Lajos
bf5d8ee678 typofixes - https://github.com/vlajos/misspell_fixer 2014-12-04 22:23:35 +00:00
Brian Coca
2d17d18c1b mentioned gathering settings in fact caching. 2014-12-04 07:44:21 -05:00
Toshio Kuratomi
2b11c2b845 Merge pull request #9691 from nousdefions/devel
changed time.py to timetest.py to avoid keyword usage
2014-12-02 11:48:35 -08:00
James Cammarata
a3b5efadd6 Remove references to "baby JSON" in module developing documentation 2014-12-02 13:42:13 -06:00
Jonathan Davila
1d2e23bc7e changed time.py to timetest.py to avoid keyword usage 2014-12-02 10:09:31 -05:00
Michael DeHaan
9bbfddedf6 Best practices docs tweaks. 2014-12-01 14:31:13 -05:00
Michael DeHaan
fe06241986 AWS Guide overhaul, WIP. 2014-12-01 14:31:13 -05:00
Adrian Lopez
f27ffdcbf0 Is it not possible to set a comment in the same line 2014-11-26 14:41:39 +01:00
Brian Coca
02f6ca034e zpelling fix 2014-11-20 16:32:33 -05:00
Sebastian Göttschkes
9660afd3e0 Adding inventory parameter to documentation
Adding the inventory parameter `ansible_sudo` to the list of behavioural
inventory parameters in the intro_inventory documentation.
2014-11-20 20:18:04 +01:00
James Cammarata
55fd4daf9c Merge pull request #9583 from electroniceagle/devel
change location of ec2.ini example to moved location
2014-11-20 12:58:18 -06:00
Brian Coca
0edaa6f790 Merge pull request #9270 from bcoca/do_the_shuffle
added new 'shuffle' filter
2014-11-20 13:43:00 -05:00
Brian Schott
c8bfc61172 change location of ec2.ini example to moved location 2014-11-20 13:15:38 -05:00
Brian Coca
a897a5ea89 Merge pull request #9561 from bcoca/variable_precedence_clarification
minor clarifications of variable precedence
2014-11-19 12:05:18 -05:00
Michael DeHaan
f8ca975c75 The Guru program has been folded in with Ansible Tower. Have
questions or interested in Ansible support?  We'd love to hear from you.
Email us at info@ansible.com.
2014-11-18 17:20:53 -05:00
Brian Coca
9245acbf44 Merge pull request #9564 from bcoca/start_step_docs
Start step docs
2014-11-17 11:18:52 -05:00
Brian Coca
d1e80ea1e6 removed version added info, too old to matter
small rephrasing for clarification
2014-11-17 11:17:47 -05:00
Chris Church
42c4928cbb Merge pull request #9562 from johnpbatty/devel
Fix documentation link to issue template
2014-11-15 17:29:23 -05:00
Brian Coca
897965ce4d removed start/step from intro, added markers to start n step 2014-11-15 17:09:55 -05:00
Brian Coca
e0110903c7 put start and step docs into their own topic, moved from playbook_intro
which is meant to be kept simple
2014-11-15 17:01:25 -05:00
John Batty
9fa163c565 Fix documentation link to issue template
On the Ansible Community page (http://docs.ansible.com/community.html)
in the "I'd like to report a bug" section, the link to the "issue
template" is broken - it links to URL
https://raw2.github.com/ansible/ansible/devel/ISSUE_TEMPLATE.md, which
results in a GitHub 404 (Page not found) error page .

Fix points link to a URL that works.
2014-11-15 21:40:42 +00:00
Brian Coca
4caed6d450 Merge pull request #9266 from sjahl/step-start-docs
Documents the --step and --start-at options to ansible-playbook.
2014-11-14 21:49:24 -05:00
Brian Coca
8d37c6f091 minor clarifications of variable precedence 2014-11-14 16:20:52 -05:00
Brian Coca
0f2f022bb0 removed YAML as documented local facts format as it is not supported and
would require extra modules on target.
2014-11-12 17:55:58 -05:00
Chris Church
fa953e162e Merge pull request #9193 from vkhramtsov/fix-password-grammar-in-windows-intro
Fix grammar in password (windows-intro)
2014-11-10 22:28:11 -05:00
Brian Coca
5a4a212869 Merge pull request #9495 from AloisMahdal/longer_vid
Fix note about video length
2014-11-07 17:51:09 -05:00
Toshio Kuratomi
f1267c0b05 Move from md5 to sha1 to work on fips-140 enabled systems 2014-11-06 21:28:04 -08:00
Brian Coca
8e2a8c92ac changed examples to not have a non working variable that gets confused
with directives as per #9264
2014-11-06 08:20:01 -05:00
Brian Coca
d25748b037 Merge pull request #9502 from nikut/delegate_docfix
add documentation for the delegate_to magic variable
2014-11-06 08:06:57 -05:00
Niku Toivola
5a11315dc7 add documentation for the delegate_to magic variable 2014-11-06 15:03:03 +02:00
Alexander Ershov
9112f650c0 Fix path to the integration tests
"tests/integration" -> "test/integration"
2014-11-06 13:50:36 +03:00
Alois Mahdal
d1cc49fc55 Fix note about video length
Perhaps due to update mentioned at /resources page, the video is 34
minutes long.
2014-11-06 02:38:21 +01:00
Brian Coca
afd8cca345 Merge pull request #9451 from bcoca/load_aliases
Load aliases
2014-11-04 10:24:11 -05:00
James Cammarata
e1662422bf Merge pull request #9467 from lorin/accel-docs
Docs: accelerate mode -> accelerated mode
2014-11-03 11:49:34 -06:00
James Cammarata
6dbc45042b Merge pull request #9436 from bobobox/patch-2
vars_files haven't been discussed yet
2014-11-03 11:20:40 -06:00
Lorin Hochstein
684cdd0298 Docs: accelerate mode -> accelerated mode
The docs sometimes referred to "accelerated mode" as "accelerate mode".
This patch changes it to "accelerated mode" everywhere.
2014-11-01 19:31:04 -04:00
James Cammarata
fe0ab8e750 Merge pull request #9408 from aklamio/devel
Update playbooks_variables.rst
2014-10-29 13:38:35 -05:00
Brian Coca
cc12c9b226 fixed typo 2014-10-29 10:32:17 -04:00
Praveen Kumar
54ba31aeef As per yum module documents it support 'present, absent and latest'
Current intro doc is pointing older way of using yum module.
2014-10-29 10:29:46 +05:30
Brian Coca
617b6323e2 added info about new deprecated/alias plugin loading 2014-10-28 08:43:18 -07:00
bobobox
f38f1c5663 vars_files haven't been discussed yet
I think this is a chapter ordering thing... vars_files have not actually be explained yet (aside from a mention of them in the note right above, which also might need reconsidering?) I think they do get introduced in the next section 'Variables'.
2014-10-28 10:15:05 -05:00
Juri Glass
9974ba01e3 added fact caching hint 2014-10-28 11:18:32 +01:00
James Cammarata
547c0d8140 Merge pull request #9216 from nmadhok/patch-3
Update playbooks_roles.rst
2014-10-27 12:03:21 -05:00
James Cammarata
29e95d86fb Merge pull request #9425 from bobobox/patch-1
Typo fix in playbooks_intro.rst
2014-10-27 09:58:05 -05:00
bobobox
66f700eb0d Update playbooks_intro.rst
Small punctuation/grammar fix.
2014-10-26 14:44:04 -05:00
Daniel Roberts
2ef2f12472 Update developing_modules.rst 2014-10-23 16:39:09 -04:00
Juri Glass
c16c527923 Update playbooks_variables.rst
There is some kind of duplicated content with http://docs.ansible.com/faq.html#how-do-i-loop-over-a-list-of-hosts-in-a-group-inside-of-a-template and this gotcha isn't listed here.
2014-10-23 16:42:10 +02:00
ronalexander
e265fb85b4 Update intro_installation.rst
Corrected casing of Jinja2 in pip dependencies.
2014-10-21 09:21:31 -05:00
Michael Warkentin
d69aa19206 Fix typo
`Propspective` -> `Prospective`
2014-10-20 20:08:31 -04:00
Lorin Hochstein
17d0022384 Typo: mo[u]dules
Fix typo: moudules -> modules
2014-10-08 20:55:49 -04:00
Brian Coca
12016b95a8 documented type based behaviour 2014-10-08 10:58:48 -04:00
Brian Coca
3534bdf953 added new 'shuffle' filter 2014-10-05 20:53:06 -04:00
CaptTofu
83457e147c Small fix for issue #9275 2014-10-05 03:35:22 -07:00
Stephen Jahl
1d05be82f0 Documents the --step and --start-at options to ansible-playbook. Fixes #9041. 2014-10-03 19:45:35 -04:00
Michael DeHaan
e24825cb58 Merge pull request #9237 from jkleckner/add-limit-from-file-doc
Add doc of @filename in intro_patterns.rst
2014-10-03 08:15:18 -04:00
Michael DeHaan
2ee049992b Merge pull request #9239 from direvus/grammar-its
Fix several it's/its errors in the documentation.
2014-10-03 08:14:49 -04:00
Michael DeHaan
a8a4347d5b Merge pull request #9250 from i5513/patch-2
Add readlink filter doc
2014-10-03 08:13:56 -04:00
Nitin Madhok
a71be1affd Removing hard coded link and replacing with reference 2014-10-02 22:39:32 -04:00
Ahmed Kamal
48ee191379 Add one line example for looking up through etcd 2014-10-02 23:45:46 +03:00
i5513
e98d8c2b5e Add readlink filter doc
As requested at request pull #9213, I'm proposing updathing this doc. Do you have man pages where I can update this too ?

Thanks
2014-10-02 20:30:44 +02:00
Tadej Janež
49c463f98b Added a note about escaping backreferences when using 'regex_replace' filter.
Users will often be puzzled why 'regex_replace' is not working as intended when used inside
YAML arguments. This note explains what they have to do to get it working.
2014-10-02 19:11:48 +02:00
Brendan Jurd
93e398e447 Fix several it's/its errors in the documentation. 2014-10-02 16:52:29 +10:00
Jim Kleckner
93ea369540 Add doc of @filename in intro_patterns.rst
I noticed that the @filename notation for the --limit argument was not
conveniently described.

This patch adds a simple example to the intro_patterns.rst file.
2014-10-01 16:49:33 -07:00
James Cammarata
43eb821d3f Merge pull request #9209 from franckcuny/gce-doc
Update the GCE guide with a working configuration.
2014-10-01 15:08:01 -05:00
James Cammarata
8f75b961ea Merge pull request #9207 from rasputnik/patch-2
Update guide_gce.rst
2014-10-01 15:07:05 -05:00
James Cammarata
7b31ddc360 Merge pull request #9234 from gamename/patch-1
Update developing_modules.rst
2014-10-01 14:42:24 -05:00
James Cammarata
ba603d5926 Merge pull request #9229 from wjimenez5271/patch-1
broken link in developing_modules.rst
2014-10-01 14:26:50 -05:00
James Cammarata
0e52f19a23 Merge pull request #9228 from wsuff/patch-1
Small typo in galaxy.rst
2014-10-01 14:26:13 -05:00
James Cammarata
8ac4a844e7 Merge pull request #9214 from nmadhok/patch-1
Update community.rst
2014-10-01 14:13:40 -05:00
gamename
4dea5c34ab Update developing_modules.rst
The existing description does not make 2 things clear.
1) This is an environment variable
2) It must be set on the _controlling_ host, not the remote host.
2014-10-01 09:54:48 -05:00
William Jimenez
adc238c80b broken link in developing_modules.rst
link to core modules source is broken since restructuring of public ansible repos
2014-09-30 22:23:08 -07:00
wsuff
d5bab777cb Small typo in galaxy.rst
other SCM sourced in line 96
2014-10-01 00:30:37 -04:00
Michael DeHaan
c6bfd05c81 Document pattern ranges on the patterns page. 2014-09-30 15:17:28 -04:00
Toshio Kuratomi
0af750e3e5 Merge pull request #9182 from bbasleeper/feature_sudo_exe_from_inventory
Add a new inventory parameter (ansible_sudo_exe) to specify sudo command...
2014-09-30 14:55:46 -04:00
Nitin Madhok
0a0b741c32 Update playbooks_roles.rst
Fixes https://github.com/ansible/ansible/issues/7241
2014-09-30 05:12:44 -04:00
Nitin Madhok
f6bd0d4841 Update community.rst
Fixes https://github.com/ansible/ansible/issues/9202
2014-09-30 04:57:01 -04:00
Franck Cuny
cc6f10b6ac Update the GCE guide with a working configuration.
Also remove a few whitespaces, improve the bash script and fix a typo.
2014-09-29 19:43:39 -07:00
Dick Davies
fafa44a375 Update guide_gce.rst
Clarify which of the options to pick.
2014-09-30 00:34:02 +01:00
Bruno BAILLUET
4e5dc754fa Added a comment to mention that ansible_sudo_exe is available from version 1.8 and beyond 2014-09-29 19:46:41 +02:00
Vladimir Khramtsov
df78f51b78 Fix grammar in password 2014-09-28 23:34:43 +03:00
Michael DeHaan
4eb26c724b Merge pull request #9189 from nmadhok/patch-3
Update intro_configuration.rst
2014-09-28 13:47:11 -04:00
Michael DeHaan
0e552dbe32 Merge pull request #9188 from nmadhok/patch-2
Doc fix in intro_installation.rst
2014-09-28 13:44:58 -04:00
Nitin Madhok
f811a0f89a Update intro_configuration.rst 2014-09-28 08:30:35 -04:00
Nitin Madhok
88e08cb54d Doc fix in intro_installation.rst
Missing code block
2014-09-28 08:25:08 -04:00
Will Thames
3513c9adc1 Updated installation instructions for submodules
Added `--init --recursive` to installation instructions
as per @bcoca's suggestion on ansible-project mailing list
2014-09-28 10:15:05 +10:00
Bruno BAILLUET
a25da4af05 Add a new inventory parameter (ansible_sudo_exe) to specify sudo command path. 2014-09-27 17:39:49 +02:00
Michael DeHaan
e8fe306cef Some various comments about the new repos, more to likely come. 2014-09-26 17:52:50 -04:00
James Cammarata
cdcbde1cff Fixing version added for the fire/forget check later feature 2014-09-25 19:16:41 -05:00
James Cammarata
8b7e16e4e3 Merge branch 'admiller/async_resume' of https://github.com/maxamillion/ansible into maxamillion-admiller/async_resume 2014-09-25 15:28:53 -05:00
James Cammarata
86edd0381c Adding in docs updates for 1.7.2 release 2014-09-24 15:53:36 -05:00
Jakub Jirutka
e6bf57469e Add Gentoo install notes 2014-09-19 23:49:14 +02:00
Michael Peters
7aa6639c13 documenting extra packages that need to be installed to run the full integration tests 2014-09-18 14:55:03 -04:00
Michael Peters
9c590b30b2 minor tweak to required modules for running tests 2014-09-18 14:32:53 -04:00
James Cammarata
1d3a8bd39c Updating current ansible version on docsite index 2014-09-18 08:01:58 -05:00
Michael DeHaan
489574e072 Docs indentation - this time with feeling 2014-09-16 15:40:00 -04:00
Michael DeHaan
506d4554dc Fix documentation indent levels. 2014-09-16 15:27:40 -04:00
Matt Martz
c319df78f8 Also document force_color 2014-09-16 10:31:50 -05:00
Matt Martz
c1555987d7 Document vault_password_file in intro_configuration 2014-09-16 10:22:32 -05:00
James Cammarata
8d6ed6e613 Merge pull request #8996 from mscherer/improve_doc_defaults
Mention defaults subdirectory in a more visible way
2014-09-15 09:58:34 -05:00
Michael Scherer
8fb14db802 Mention defaults subdirectory in a more visible way
All examples do not show it, so only someone reading the doc from
end to end would know about it.
2014-09-13 13:25:07 +02:00
renning bruns
49aa7ee523 Update playbooks_variables.rst
very small and minor addition, but I couldn't find anywhere that answered this (now obvious) question I had of whether or not facts could also be yaml files.
2014-09-11 14:41:51 -07:00
James Cammarata
6c6a0f068e Updating PR testing document with manual branch checkout steps 2014-09-11 11:05:56 -05:00
James Cammarata
1dc11c9752 Merge pull request #8943 from ycombinator/add-missing-tag
Add missing tag to roles file example.
2014-09-10 21:35:36 -05:00
Michael DeHaan
c05a12472c Add PR testing guide (95% from James). 2014-09-10 17:41:58 -04:00
Michael DeHaan
c681a41bbb Indents in docs. 2014-09-10 12:52:57 -04:00
Michael DeHaan
ae4aa01296 Fix sidebar notation for Galaxy. 2014-09-10 12:38:16 -04:00
Michael DeHaan
4c59bbf633 Fix some link formatting. 2014-09-10 12:34:54 -04:00
Michael DeHaan
322d91568c First pass at updating community page by moving CONTRIBUTING.md content onto docsite. 2014-09-10 12:32:01 -04:00
Michael DeHaan
9f5aeff15b Add version_added info. 2014-09-10 09:39:31 -04:00
Michael DeHaan
2064d26085 Add documentation about bin_ansible_callbacks setting. Standardization and cleanup. 2014-09-10 09:38:24 -04:00
Shaunak Kashyap
e76dd0d06d Add missing version/tag to roles file example. 2014-09-09 18:25:37 -06:00
Isaac Shapira
26a1e20bb2 enviroment -> environment 2014-09-05 08:21:45 -06:00
Richard Barrell
bed2eb36d3 Issue 8872: use getpass.getpass() to read password.
This avoids passing the plaintext raw password into the script as a
command-line argument, which shells such as bash and zsh will
typically log into a file like ~/bash_history.

As a small bonus, this works a LOT more smoothly if the user's
password has characters in it that either the shell or Python syntax
might like to interpret as metacharacters, like '\' or '"'.

getpass.getpass() is part of Python's standard library in all versions
between 2.4 and 3.3 at least.
2014-09-03 12:41:11 +01:00
Isaac Shapira
7dd95e43a4 Document Environment in tasks as well
Googling around for environment variables in Ansible yields this page. It would be useful to have the task version documented here as well.
2014-09-02 19:48:01 -06:00
James Cammarata
c1ce64bd5d Merge pull request #8850 from michalgasek/run-once-docs-fix
docs: Add versionadded for run_once
2014-09-02 13:53:27 -05:00
James Cammarata
64cb88aa3b Merge pull request #8802 from garywu/patch-3
Update playbooks_variables.rst
2014-09-02 11:06:00 -05:00
James Cammarata
4698f85eac Merge pull request #8789 from retr0h/retr0h/add-role-path-to-role-file
Can override each role's install path
2014-09-02 10:44:44 -05:00
Michal Gasek
11d5656fde docs: Add versionadded for run_once 2014-09-02 11:42:32 +02:00
Gary Wu
b0c4897196 Update playbooks_variables.rst 2014-08-28 09:39:14 -05:00
Brian Coca
88daac4971 ternary filter 2014-08-27 22:27:00 -04:00
John Dewey
44b0ee5322 Can override each role's install path
Defaults to the system wide `roles-path` when `path` is not specified in the
provided `role-file`.  An example installing nginx to a relative path specified
by the `role-file`.

    - src: https://github.com/bennojoy/nginx
      path: vagrant/roles/
2014-08-27 16:43:39 -07:00
Michael DeHaan
984d551257 Merge pull request #8761 from mwarkentin/patch-1
Fix typo: `active` -> `activate`
2014-08-27 18:37:14 -04:00
James Cammarata
35dac66afa Adding docs for default+omit 2014-08-27 12:41:49 -05:00
Michael Warkentin
81dd7e9940 Fix typo: active -> activate 2014-08-26 14:19:18 -04:00
Michael DeHaan
7ffa9cecae Docs for command warnings feature. 2014-08-22 15:37:07 -04:00
Michael DeHaan
f54665aa51 Merge pull request #7491 from hkariti/doc_group_vars_dir
Update docs to include directories inside group_vars
2014-08-22 15:09:37 -04:00
Pascal Borreli
fe40a7d88a Fixed typos 2014-08-22 11:39:38 +01:00
Michael DeHaan
8e0af04c3b Add TOC to galaxy docs. 2014-08-21 18:53:36 -04:00
Michael DeHaan
399fe32287 Clarify examples further. 2014-08-21 18:48:02 -04:00
Michael DeHaan
caf4e44be7 Replace examples for requirements file. 2014-08-21 18:26:40 -04:00
Michael DeHaan
56ce56fdbe Fix docs typo. 2014-08-21 17:22:39 -04:00
Michael DeHaan
12ad110205 Add documentation for new ansible-galaxy role options in 1.8. Much rejoicing. 2014-08-21 17:15:23 -04:00
Will Thames
ada9074276 Allow installation of roles from yaml roles file
Added docs
Added more tests
Improved how roles are returned from the parsers
2014-08-21 17:15:23 -04:00
Ian Miell
340a3c68b1 Tense correction 2014-08-15 19:56:11 +01:00
Chad Rhyner
1c01c0c390 Fix some spelling mistakes in intro_windows.rst 2014-08-12 22:10:11 -07:00
Michael DeHaan
99c39b1ff3 By popular request, make the no_log attribute also censor tasks from callbacks. 2014-08-12 13:36:05 -04:00
Michael DeHaan
734548d8b4 Merge pull request #8525 from kamaln7/patch-1
Replace all occurrences of "Digital Ocean" with "DigitalOcean"
2014-08-11 16:04:04 -04:00
Michael DeHaan
160ddf6b04 WIP on fact caching docs. 2014-08-11 15:15:09 -04:00
Kamal Nasser
6e6e039506 Replace all occurrences of "Digital Ocean" with "DigitalOcean" 2014-08-08 22:03:17 +03:00
Michael DeHaan
f8cc5bc24d Merge pull request #7314 from bonifaido/patch-1
Ansible inventory file location fixed
2014-08-08 13:52:36 -04:00
Michael DeHaan
8b00ca5446 Merge pull request #7293 from dhobbs/patch-1
Update user mailing list link in faq.rst
2014-08-08 13:49:19 -04:00
Michael DeHaan
3066cd135e Revise documentation versioning. 2014-08-08 13:46:57 -04:00
Howard Oettle
50c3de3317 Add example of rolling update using a percentage. 2014-08-08 13:46:57 -04:00
Michael DeHaan
7806c5095d Conditional imports are described under conditionals so remove the duplicate section. 2014-08-08 13:20:15 -04:00
Michael DeHaan
f6cd9119b1 Update 'version_added' in docs. 2014-08-08 11:28:48 -04:00
Michael Peters
3ba516ac25 adding min() and max() filters for use in Jinja templates 2014-08-08 11:28:48 -04:00