Commit graph

1436 commits

Author SHA1 Message Date
brianlycett
18e4a02c25 Update YAMLSyntax.rst
Ach - it's double backquotes in this markup.
2016-02-29 16:06:06 +00:00
brianlycett
6c7680b633 Update YAMLSyntax.rst
Small updates loosely based on suggestions. :)
2016-02-29 16:04:45 +00:00
Vladimir Rutsky
35880e6254 fix reference to chapter + trailing dot 2016-02-29 18:21:05 +03:00
Yannik
767856c463 fix typo 2016-02-28 22:19:20 +01:00
Yannik
192e22f6f4 fix typo 2016-02-28 10:11:07 +01:00
Jun Matsushita
de0e7de15c Updated versions with current released and development 2016-02-27 12:39:58 +01:00
Brian Coca
b0bed27211 minor doc fixes 2016-02-26 16:46:26 -05:00
Brian Coca
e60fef4dbe Merge pull request #14660 from dagwieers/doc-hybrid-plugin
Added a section wrt. hybrid plugins and provide an example for lookup…
2016-02-25 17:19:46 -05:00
Brian Coca
fbdcb22e36 now generate list of playbook ojbect directives
TODO: needs links/info and conditionals added
2016-02-25 16:48:37 -05:00
Dag Wieers
e5600ee204 Turn it in correct reStructuredText
Why not AsciiDoc is beyond me, as it is much easier for documentation.
2016-02-25 17:12:24 +01:00
Dag Wieers
c1d90e3f2d Added a section wrt. hybrid plugins and provide an example for lookup plugins 2016-02-25 17:01:28 +01:00
Brian Coca
03c33053aa clarified become options do not imply others
fixes #14635
2016-02-24 10:58:40 -05:00
brianlycett
4160a3f40b Update YAMLSyntax.rst
A brief explanation was added regarding multi-line values.
2016-02-24 15:06:21 +00:00
James Cammarata
8e0c8ffe7b Merge pull request #14512 from scottsb/patch-1
Fix leftover references to sudo instead of become
2016-02-24 09:18:32 -05:00
Matt Martz
3ac0143cf1 Merge pull request #13654 from sivel/paramiko-proxy-command
Add ProxyCommand support to the paramiko connection plugin
2016-02-23 11:30:43 -06:00
Matt Martz
38b663471d Merge pull request #14311 from sivel/unsafe-yaml-constructor
Add new 'unsafe' YAML constructor
2016-02-23 11:29:53 -06:00
Strahinja Kustudić
28b4f2a595 Adds ANSIBLE_VAULT_PASSWORD_FILE to the documentation site 2016-02-23 14:38:47 +01:00
James Cammarata
283532e11d Updating IRC channel list in community doc 2016-02-22 13:24:08 -05:00
Matthew Huxtable
b59b5a286b docsite: add missing closing square bracket 2016-02-22 16:07:48 +00:00
Sandra Wills
11f081cb99 minor typo fix
missing "the" added to 2.x listing to match wording for 1.x
2016-02-19 10:35:43 -05:00
Sandra Wills
c172a289e4 light editing of variable precedence list wording
QA had asked me a while ago to clean up the way the precedence list for 1.x was worded,
as the intro from the list started with "then comes", as if something should preceed
it. The comments from OxABAB were not helpful themselves, but his issue reminded me that
this was on my to do list to make a little cleaner and clearer.  Edits made to remove the
"then comes" intros for each list line, to help with clarity.
2016-02-19 10:32:34 -05:00
Toshio Kuratomi
86b8dc0e79 Add a configuration setting that allows the user to specify printing of task arguments in the header.
Fixes #14554
2016-02-18 04:20:35 -08:00
Michael Scherer
4102812a69 Remove spurious 'either', fix #14520 2016-02-17 11:13:59 +00:00
Scott Buchanan
71dffbc28f Fix leftover references to sudo instead of become
Catching a few places that earlier PR #10788 missed.
2016-02-16 16:19:26 -05:00
brianlycett
665e158ec0 Update YAMLSyntax.rst
Updated to include a bit more depth in explaining the YAML, along with a link the Wikipedia page on YAML syntax.
2016-02-16 16:40:44 +00:00
Adam Hartz
cebf127d68 Change reference to basic.py, where the implementation details live 2016-02-16 10:32:57 -05:00
Adam Hartz
327b27ba1c Update stated location of common_module.py 2016-02-16 09:48:40 -05:00
Kamal Wood
0c1395ed2f Documenting that values passed in using the extra-vars 'key=value' syntax are interpreted as strings. 2016-02-15 14:13:39 +00:00
Illia Krauchanka
889c273ac4 Update playbooks_lookups.rst 2016-02-15 15:53:34 +03:00
Brian Coca
4b953c4b16 extended api example with more options in tasks
also adopted to less requried options
2016-02-13 20:15:56 -05:00
Anton Belonovich
d24761af1b Update playbooks_roles.rst 2016-02-12 00:01:36 +03:00
Timothy Hopper
f014b548e4 Link to /videos instead of the less obvious /resources 2016-02-11 10:34:39 -05:00
Brian Coca
50dfd4b057 fixed bad tag example 2016-02-05 15:48:56 -05:00
Dag Wieers
0a20c53ed6 A few more typos
I came across another typo, and fixed similar ones in the docs.
2016-02-05 18:38:56 +01:00
Dag Wieers
2f411557f5 Fix small typo
While reading one of the docs I found this small typo.
2016-02-05 13:54:58 +01:00
Brian Coca
597638c401 revamped become page
its not only for the 'upgrade from 1.8' anymore, become is the
official way to do things and now presents as such, no need to know
about previous options, but still keep info there for those that
were using them..
2016-02-04 20:36:20 -05:00
Brian Coca
3d894b0f13 corrected mizpellz 2016-02-04 20:10:37 -05:00
Brian Coca
d6283129e1 corrections and additions to porting guide
fixes in syntax to what is now allowable
added section from user feedback
2016-02-04 19:39:56 -05:00
Brian Coca
7037f793b9 Expain our commitment to API 2016-02-04 19:39:56 -05:00
Matt Martz
5cd4afaa1d Add documentation about the unsafe YAML tag 2016-02-04 11:54:23 -06:00
Brian Coca
c433289a8b clarified how block applies directives to tasks
previous text could be interpreted as the block itself doing the evaluation and skipping
2016-02-03 14:34:08 -05:00
Greg Taylor
96e22970ee Fix a note tag in the API docs. 2016-02-02 09:58:08 -08:00
Brian Coca
0e551e6d46 clarified ansible_shell_type description 2016-02-02 11:00:31 -05:00
Brian Coca
6105c8c77c corrected name of inventory_hostnames lookup plugin 2016-02-02 09:41:21 -05:00
Toshio Kuratomi
9e3932ffca Some attributes of callbacks aren't in v2. Port plugins to the v2 way to do that
Update porting guide with info on callback porting
2016-01-29 19:45:12 -08:00
Brian Coca
f26673904f updated intro adhoc to use become 2016-01-29 17:46:18 -05:00
Brian Coca
4b1d621442 Merge pull request #14173 from sradvan/doc-fix-bsd-intro
grammar fixes; capitalize where necessary; general clean-up
2016-01-28 15:53:00 -05:00
Scott Radvan
ba9e5fa6ba grammar fixes; capitalize where necessary; general clean-up 2016-01-28 21:58:49 +13:00
Darren Tong
90c14644b0 Fixing typo depricated for deprecated. 2016-01-27 23:22:27 -08:00
James Cammarata
39b4117816 Merge pull request #14153 from oneswig/doc-ipaddr-add-subnet-masks
Details on how to convert subnet masks into CIDR
2016-01-27 16:34:03 -05:00
Brian Coca
a928465c9e added note about 1.9 ppa 2016-01-27 16:26:44 -05:00
Stig Telfer
326ae21089 Details on how to convert subnet masks into CIDR
Use data reported by Ansible network facts as an example.
2016-01-27 12:14:50 +00:00
Brian Coca
4dc3441cdb Merge pull request #14102 from senk/fix_docu
Fixes documentation formatting
2016-01-25 14:33:23 -05:00
Matthew Seaman
043b2cbcb4 Change example to use pkg rather than the obsolete pkg_add
pkg_add has been obsoleted in all released versions of FreeBSD for
several years.  Change the example to use the appropriate pkg(8)
command line.
2016-01-25 16:20:17 +00:00
Robin Naundorf
6cc7f7890f Fixes documentation formatting
Fixes documentation formatting
2016-01-25 11:51:30 +01:00
James Cammarata
6b166a1048 Merge pull request #14071 from rozha/devel
Fix server numbers in first 10 next 10 example
2016-01-23 09:30:37 -05:00
Ilya Novickov
46bd5a0d9c Fix server numbers in first 10 next 10 example 2016-01-22 18:50:41 +08:00
Greg DeKoenigsberg
f3336fba44 Tweaking Python 2.4 requirement 2016-01-21 13:02:03 -05:00
Greg DeKoenigsberg
981e9c44ba Put Python 2.4 in checklist
It's in the travis check, but we don't spell it out explicitly in the guidelines.
2016-01-21 12:22:26 -05:00
Greg DeKoenigsberg
a10e15c765 Update developing_test_pr.rst 2016-01-20 10:29:25 -05:00
Greg DeKoenigsberg
a4f91c2c53 format fix for github markup 2016-01-20 10:27:37 -05:00
Greg DeKoenigsberg
b900c104b9 Adding submodule help 2016-01-20 10:25:49 -05:00
Brian Coca
3750af45d4 clarified with_file 2016-01-19 21:20:24 -05:00
Brian Coca
742bd2c554 clarify role include paths 2016-01-19 08:49:16 -05:00
Brian Coca
11ca4e6282 Merge pull request #13934 from dlangille/dlangille-patch-2
Specify the correct default options for sudo_flags
2016-01-18 17:42:39 -05:00
Brian Coca
1c9774785f Merge pull request #13923 from slimandslam/patch-1
Added example of running commands on a remote Windows Server
2016-01-18 17:26:50 -05:00
Dan Langille
2765708450 Specify the correct default values for sudo_flags
The correct default options for sudo_flags can be found at: https://github.com/ansible/ansible/blob/devel/lib/ansible/constants.py#L181

Slightly alter explanation of '-H' so as not to confuse it with -E, --preserve-env (which preserves existing environment variables).

When adding the two other options, include short explanations of those options.

Add note about '-n', which did not appear in 1.x I believe, and which bit me.
2016-01-16 15:28:41 -05:00
Dan Langille
2cde16a06c Add correct default options for sudo_flags
see https://github.com/ansible/ansible/blob/devel/lib/ansible/constants.py#L181
2016-01-16 14:37:04 -05:00
Ryan Groten
e6ab0daa4b minor wording fixes 2016-01-15 14:11:17 -07:00
J Levitt
8e059d058b Added example of running commands on a remote Windows Server
Added example of running commands on a remote Windows Server
2016-01-15 14:17:23 -06:00
Brian Coca
ec95f50cb6 updated docs with new test grammer examples 2016-01-14 12:29:02 -05:00
Brian Coca
4de4d59d7a changed examples to not use 'port' directive 2016-01-13 18:06:55 -05:00
Toshio Kuratomi
f72d380bcf Specify all variables in the description to make it more clear 2016-01-13 13:15:08 -08:00
Toshio Kuratomi
be9d817618 Make example of deprecated args clearer 2016-01-13 12:35:28 -08:00
Brian Coca
739e4c0386 corrected info about windows module naming and loc 2016-01-13 10:32:36 -05:00
jfrappier
21ac96fa35 Updated intro_getting_started.rst to reference --ask-become-pass 2016-01-12 21:51:47 -05:00
Toshio Kuratomi
a3dcd99d96 Documentation fixes 2016-01-12 12:00:00 -08:00
Brian Coca
d9d4ad828a zpell the corerstly 2016-01-12 14:07:39 -05:00
Brian Coca
2374abbeda api not thread safe
also removed runner ref in general description as it is now a 1.x only thing.
2016-01-12 14:05:33 -05:00
Brian Coca
06b0161e6d fixed extract version 2016-01-12 13:26:46 -05:00
Toshio Kuratomi
cacc22abbb Add the porting guide 2016-01-11 13:58:39 -08:00
Brian Coca
a12164497b Merge pull request #13726 from teolupus/devel
Added OpenStack dynamic inventory example
2016-01-11 16:07:27 -05:00
Brian Coca
f8b06e1613 Merge pull request #13785 from claremacrae/patch-1
Fixed typo: Integerations -> Integrations
2016-01-11 14:36:56 -05:00
James E. Blair
51255aed9b Fix typo in API docs
This typo caused a SyntaxError when attempting to run the example
in the API docs.
2016-01-11 09:48:25 -08:00
Clare Macrae
04ace28f6d Fixed typo: Integerations -> Integrations 2016-01-09 22:34:03 +00:00
Brian Coca
41a417be1f noted that regex_escape was added in 2.0
fixes #13759
2016-01-07 19:02:49 -05:00
Sebastian Thiel
28be222ff0 correct invocation of launchctl
When I executed `launchctl limit maxfiles 1024 2048` , my entire system would become unusable, as all of the sudden no process could use any file anymore, reporting that the max file limit was reached.
Only a hard reboot could fix the problem, which fortunately revealed that the configuration was not saved.

The change I made *should* remedy the issue, even though I didn't test it.
Therefore I hope you can revise the documentation to be sure nothing bad happens.

# Meta

Tested on OSX 10.11.2
2016-01-07 16:55:41 +01:00
Michael
519952d7d7 Fix module name 2016-01-07 00:08:49 -08:00
Bruno Almeida do Lago
9e32099b5e Added OpenStack dynamic inventory example
Added an example illustrating how to use the OpenStack dynamic inventory script
to the "Dynamic Inventory" section.
2016-01-05 16:48:49 +13:00
Fuentes, Christopher
de529c1734 minor grammar error was making me pull hair out 2016-01-04 13:52:06 -05:00
mgarstecki
5accc98587 Correction of a double negation
The sentence seemed to imply that return codes from modules are significant, while they are not. The second part of the sentence confirms this, as it advises to use standard return codes only for future proofing.
2015-12-30 11:57:12 +01:00
Brian Coca
2000566031 minor fix to become docs 2015-12-28 10:24:49 -05:00
Brian Coca
395bfec2f9 Merge pull request #13670 from stephen144/patch-1
intro_adhoc.rst: clarify idempotence explanation
2015-12-28 10:20:08 -05:00
Brian Coca
c489b271d1 updated release cycle to 4 months instead of 2 2015-12-27 14:18:07 -05:00
Stephen Medina
cd9e18d0e5 clarify idempotence explanation
Small typo; wasn't sure what to replace it with.
2015-12-25 08:56:08 -08:00
Matt Martz
630a35adb0 Add ProxyCommand support to the paramiko connection plugin 2015-12-23 15:15:07 -06:00
Brian Coca
b201cf2ee1 switched from pythonic None to generic null 2015-12-23 10:30:24 -05:00
Matt Roberts
809c9af68c Update playbooks_intro.rst
If you follow the documentation through in order you shouldn't have 
read about modules yet.
2015-12-23 08:18:46 +00:00
Toshio Kuratomi
b33f72636a Also remove the bool casting function info (transparent to module writer now) 2015-12-22 07:25:50 -08:00
Toshio Kuratomi
b310d0ce76 Update the developing doc to modern method of specifying bool argspec values 2015-12-22 07:23:51 -08:00
Brian Coca
eb16e11253 Merge pull request #13613 from azaghal/devel-13126-dig_lookup_documentation
Adding documentation for the 'dig' lookup (#13126).
2015-12-21 13:46:02 -05:00
Brian Coca
593d80c63d role search path clarified 2015-12-21 13:15:12 -05:00
Branko Majic
6ec58bbd5f
Adding documentation for the 'dig' lookup (#13126). 2015-12-20 14:19:20 +01:00
James Cammarata
491fd754f1 Updating the porting guide to note the complex args/bare vars change
Related to #13518
2015-12-16 16:36:16 -05:00
James Cammarata
76b4b9ed2c Merge pull request #13501 from chouseknecht/galaxy-2.0-update
Galaxy 2.0 update
2015-12-16 15:01:12 -05:00
Chrrrles Paul
851c0058b1 Removing yaml support for path: 2015-12-16 12:45:05 -06:00
David
63b624707d Fix typo 2015-12-16 23:46:06 +08:00
Brian Coca
5d1a2eac3e Merge pull request #13500 from mscherer/fix_markup_doc_modules
Fix the markdown used for the Windows module section
2015-12-14 18:43:18 -05:00
gp
e595c50197 Fix typo in galaxy.rst
Fix typo
2015-12-14 12:06:35 -05:00
chouseknecht
95785f149d Fix docs. The search command works with both galaxy.ansible.com and galaxy-qa.ansible.com. 2015-12-13 05:23:04 -05:00
chouseknecht
06dde0d332 Fixed documentation typos and bits that needed clarification. Fixed missing spaces in VALID_ACTIONS. 2015-12-13 05:23:04 -05:00
chouseknecht
847f454bcc Add a section to intro_configuration for Galaxy. 2015-12-13 05:23:04 -05:00
chouseknecht
342dee0023 Define and handle ignore_certs correctly. Preserve search term order. Tweak to Galaxy docsite. 2015-12-13 05:23:04 -05:00
chouseknecht
f1c72ff8f5 Make sure it is clear that new commands require using the Galaxy 2.0 Beta site. 2015-12-13 05:23:04 -05:00
chouseknecht
989604b1a3 Fix typo. 2015-12-13 05:23:04 -05:00
Usman Ehtesham Gul
4779f29777 Fix Doc mistake
Fix Doc mistake in ansible/docsite/rst/playbooks_variables.rst
2015-12-13 01:24:27 -05:00
Brian Coca
d7b516f75d added releases doc 2015-12-12 13:16:40 -05:00
Brian Coca
0a112a1b06 fixed formating issues with rst 2015-12-12 13:14:14 -05:00
Brian Coca
8db2912745 corrected section anchors 2015-12-12 12:59:00 -05:00
Brian Coca
14f3739260 Merge pull request #13505 from janek-warchol/patch-2
Explain how 'run_once' interacts with 'serial'
2015-12-12 00:29:37 -05:00
Brian Coca
58072c92fb removed 'bare' example in environment
now shows how to use explicit templating
2015-12-11 09:32:19 -05:00
Jan Warchoł
72f0679f68 Explain how 'run_once' interacts with 'serial' 2015-12-10 16:22:37 +01:00
Michael Scherer
fe72fff57d Fix the markdown used for the Windows module section 2015-12-10 02:00:31 +01:00
Toshio Kuratomi
30e729557f Add first draft of porting guide for 2.0 2015-12-09 16:43:41 -08:00
Brian Coca
a61387846d draft release documentation 2015-12-09 14:54:11 -08:00
Toshio Kuratomi
a19e083d33 Note that handlers inside of includes are not possible at the moment 2015-12-09 13:52:01 -08:00
nitzmahone
a7cd41b482 Windows doc updates 2015-12-09 16:30:32 -05:00
Toshio Kuratomi
0211da2fe9 Clarify language of delegate_facts documentation 2015-12-09 08:44:46 -08:00
chouseknecht
4f84769a17 Galaxy 2.0 2015-12-09 10:51:12 -05:00
Brian Coca
c1cec64aa8 added delegate_facts docs 2015-12-08 14:18:38 -08:00
Brian Coca
dcedfbe26c corrected usage of ec2.py's profile option
this was never introduced into ansible-playbook though the docs
stated otherwise. We still explain how to use the env var to get the
same result.
2015-12-07 09:54:55 -08:00
sam-at-github
a96a879fcf Add fullstop to make sentence make sense. Touch parargraph while at it. 2015-12-05 13:06:58 +11:00
Brian Coca
7d073bdd17 Merge pull request #13345 from amenonsen/extract
Add an 'extract' filter
2015-12-03 11:19:06 -08:00
Toshio Kuratomi
9caa2b0452 Revert "Update docs and example config for requiretty + pipelining change"
This reverts commit f873cc0fb5.

Reverting pipelining change for now due to hard to pin down bugs: #13410  #13411
2015-12-03 07:59:23 -08:00
Brian Coca
6559616a04 updated docs for 2.0 api 2015-12-02 12:03:07 -08:00
Brian Coca
abeec3c8b5 Merge pull request #13322 from muffl0n/docs_regex_replace_named_groups
Add example for regex_replace using named groups
2015-12-02 09:43:45 -08:00
Abhijit Menon-Sen
8cf1815867 Add an 'extract' filter
At its most basic, this is nothing more than an array or hash lookup,
but when used in conjunction with map, it is very useful. For example,
while constructing an "ssh-keyscan …" command to update known_hosts on
all hosts in a group, one can get a list of IP addresses with:

    groups['x']|map('extract', hostvars, 'ec2_ip_address')|list

This returns hostvars[a].ec2_ip_address, hostvars[b].ec2_ip_address, and
so on. You can even specify an array of keys for a recursive lookup, and
mix string and integer keys depending on what you're looking up:

    ['localhost']|map('extract', hostvars, ['vars','group_names',0])|first
        == hostvars['localhost']['vars']['group_names'][0]
            == 'ungrouped'

Includes documentation and tests.
2015-12-02 18:16:38 +05:30
Brian Coca
afefaff1a7 Merge pull request #13382 from mscherer/doc_with_inventory
Add a documentation on how to loop over all inventory host
2015-12-01 18:33:59 -08:00
Michael Scherer
c8bac7f54b Remove empty line breaking the formatting of the title 2015-12-02 00:24:14 +01:00
Michael Scherer
517b533d46 Add a documentation on how to loop over all inventory host
Related to #13343
2015-12-02 00:21:10 +01:00
Ming Qian
7724c958e1 Update intro_windows.rst
first pull. thanks.
2015-12-01 11:24:17 -08:00
Toshio Kuratomi
f873cc0fb5 Update docs and example config for requiretty + pipelining change 2015-12-01 10:24:15 -08:00
James Cammarata
d1b5653b53 Merge pull request #13367 from leedm777/patch-1
Corrected group separator
2015-12-01 10:48:08 -05:00
sreekanth
96bd2a4447 Added missing closing quote 2015-12-01 17:30:43 +05:30
David M. Lee
cfdb12c2ec Corrected group separator
The text said comma, but the examples were all colons.
2015-11-30 21:44:18 -06:00
Kerim Satirli
96c6b74754 removes editorial
I feel that Ansible is above the "my hosted Git community is better than yours" discussion and thus removed the editorial around Bitbucket
2015-11-27 10:09:55 +01:00
muffl0n
fa3848a1f2 Add example for regex_replace using named groups 2015-11-26 12:56:30 +01:00
Raphael Badin
20a45ab36d Fix missing word in developing_modules.rst 2015-11-25 18:29:17 +01:00
dizzler
b937018fcd Fix typo in modules_core.rst 2015-11-24 12:49:15 -07:00
René Moser
a9f5837157 docsite: cloudstack: fix missing quotes in example 2015-11-23 07:10:47 +01:00
Matt Davis
8f00d1c698 Merge pull request #13212 from cchurch/recommended_pywinrm_version
Recommend using pywinrm >= 0.1.1 from PyPI instead of GitHub version.
2015-11-20 15:22:04 -08:00
Gilles Cornu
dc60e08aa0 Documentation: Update the Vagrant Guide
This is an attempt to solve #7665.

Revert the change applied by f56a6e0951
(#12310), as the inventory generated by Vagrant still rely on the legacy
`_ssh` setting names for backwards compatibility reasons.
See also https://github.com/mitchellh/vagrant/issues/6570
2015-11-20 21:50:41 +01:00
Chris Church
dea07438b5 Recommend using pywinrm >= 0.1.1 from PyPI instead of GitHub version. 2015-11-18 17:49:21 -05:00
Brian Coca
f6fb47be8c Merge pull request #13172 from gebn/docs-grammar
Removed erroneous apostrophe in installation documentation
2015-11-16 14:52:50 -08:00
Brian Coca
1f34c6b214 updated yaml syntax and gotchas
specifically added example for getting strings that match boolean values
2015-11-17 12:05:57 -08:00
George Brighton
0dedf444a1 Removed erroneous apostrophe in installation documentation 2015-11-15 00:04:11 +00:00
Toshio Kuratomi
958fb29b78 Merge pull request #12881 from Scypho/devel
fix for issue #11885 - allowing json in lookup template calls
2015-11-12 15:39:35 -08:00
René Moser
1d7982c599 Update guide_cloudstack.rst 2015-11-10 09:11:57 +01:00
Toshio Kuratomi
317e908165 Merge pull request #13065 from tima/patch-2
Consistent inventory pattern delimiter in docs
2015-11-09 08:54:51 -08:00
Scott Radvan
19b95e9106 Update intro_bsd.rst
Minor fixes/wording/capitalization.
2015-11-09 12:34:28 +13:00
Timothy Appnel
a8e1ec585d Consistent inventory pattern delimiter in docs
The inventory pattern delimiter used in the examples switches between the comma and colon. While both are valid I've found this throws off new users so I've modified the examples to consistently use a colon, the more common of the two in my experience.
2015-11-06 13:54:39 -05:00
Timothy Appnel
fde7c14cd0 v1 variable precedence order was off.
Noticed that the v1 variable precedence docs list facts discovered as having a lower precedence than inventory variables. It is in reality the other way around. The v2 section gets this right.
2015-11-06 13:48:35 -05:00
cmluciano
6677c8b8f0 Provide git based example
I found it difficult to find documentation for how to pull from a git-based scm that wasn't github. The only way I could find this option was to dig through the google-group.
2015-11-04 15:43:24 -05:00
Toshio Kuratomi
4b75308439 Fix up rst formatting 2015-11-03 17:29:02 -08:00
Tim Gerla
9008b7b0e7 Clarify how tagged roles work
This is a confusing part of roles and tags. Most people assume that tagging a role means that the tagged tasks inside the role will run based on the tags specified. But in reality, it tags the whole role with those tags.
2015-11-02 11:47:18 -05:00
Toshio Kuratomi
5e0d55ae5b Change the dict attribute collision warning to recommend using bracket notation 2015-11-01 13:32:45 -08:00
Brian Coca
4ec0536168 made condition not simplifiable to 'in' 2015-11-01 16:31:23 -05:00
Brian Coca
21ffe8702d Merge pull request #12993 from ypid/avoid-python-object-name-in-complex-datatypes
Avoid key names which are valid attributes for data types in Python.
2015-11-01 16:08:09 -05:00
Brian Coca
1dbde84337 Merge pull request #12994 from resmo/for_ansible
doc: cloudstack guide fix up
2015-11-01 15:47:21 -05:00
Robin Schneider
ad0d299c56
Avoid key names which are valid attributes for data types in Python.
Closes #12990.

Alternative to #12992

This PR excludes all attributes of the following data types: lists,
tuples, dicts, sets, integers, floats, strings and Unicode objects.

It is expected that only the attributes of dicts and sets would cause an
problem like in #12990.
2015-10-31 23:58:16 +01:00
Rene Moser
1243997c00 doc: cloudstack guide fix up 2015-10-31 23:51:03 +01:00
Brian Coca
3c3aff09c9 fixed documentation for host patterns separators 2015-10-31 16:35:40 -04:00
Brian Coca
9c09dc3ef8 Revert "Document , instead of : in intro_patterns, update changelog"
due to , being broken in 1.9

This reverts commit b47bc343ea.
2015-10-31 16:35:40 -04:00
René Moser
090f450d18 doc: add cloudstack guide to the guides 2015-10-31 19:34:40 +01:00
René Moser
3f26b31e47 Create guide_cloudstack.rst 2015-10-31 17:40:00 +01:00
Lars Kellogg-Stedman
dc8290ab7a add missing configuration examples
adds configuration examples missing from intro_configuration.rst.

Closes #12963.
2015-10-30 09:58:26 -04:00
jaamiller
4359189884 Update playbooks_lookups.rst
I was caught out by the different behaviour of lookups & local tasks, and could not find the difference documented anywhere at all, so I took the liberty of proposing this change.

Lookups are always relative to the role or play.
Local tasks are relative to the cwd from which you execute.
2015-10-30 10:50:53 +00:00
Jens Peter Schroer
9f2baf3f84 adding documentation 2015-10-30 10:34:47 +01:00
James Cammarata
27dc7e11a4 Merge pull request #12953 from larsks/bug/7890
add documentation for with_file loops
2015-10-29 10:45:05 -04:00
Will Thames
ab55726fad Clarify module documentation
Make the position on _facts modules more emphatic
Add documentation for RETURN structure
2015-10-29 10:02:59 +10:00
Lars Kellogg-Stedman
097adec834 add documentation for with_file loops
This commit adds documentation for the `with_file` loop construct,
resolving #7890 and #9160.
2015-10-28 16:56:21 -04:00
Brian Coca
46acf892d5 clarified ignore_errors 2015-10-27 19:59:43 -04:00
Petrox
cad053af04 Typo fix: invenotry to inventory
Typo fix: invenotry to inventory :)
2015-10-27 22:54:14 +01:00
Brian Coca
6637982deb added docs for include with_items and usage of multiple lopo vars (item) 2015-10-23 10:32:31 -04:00
Sandra Wills
bc14ed380e variables precedence reordering and added para to help explain precedence rules 2015-10-22 09:12:43 -04:00
Aidan Hobson Sayers
9f8c4d716a Document setting environment variables in a playbook 2015-10-22 12:07:54 +01:00
Borys Borysenko
126276ce6c Fix order of handlers that were notified in different sections 2015-10-21 11:00:47 +03:00
José Moreira
25e4a3ad2a Fixed docs typo 2015-10-20 16:38:16 +01:00
Brano Zarnovican
84967e282a DOC: in yum examples, 'pkg' arg renamed to 'name'
* alternating both pkg/name in examples might be confusing
* even if pkg= is working, it is not documented in
  module's refrence guide
2015-10-20 13:49:04 +02:00
Nick Cartwright
17469d0781 Fix typo: comma not colon separates groups in patterns 2015-10-16 04:30:46 +01:00
Ryan S. Brown
48e1396496 Add -y to yum command, otherwise it would hang indefinitely 2015-10-15 13:55:53 -04:00
Ryan S. Brown
9dcde77e0e Document using the raw module to install a py2.X and simplejson
In the installation guide, the raw module is mentioned as an option for
installing Python or simplejson on managed nodes that don't have them.
This change adds an example for users that may already be familiar with
using ansible but are checking install docs because they don't know the
requirements for managed nodes, or are using a distribution that doesn't
include Python 2 by default.
2015-10-15 13:35:07 -04:00
Sandra Wills
ce0cedc4a7 Merge pull request #12764 from docschick/docschick-fixes
vault and variables best practices info added, edited, and referenced
2015-10-15 10:01:06 -04:00
Sandra Wills
8501a46baa vault and variables best practices info added, edited, and referenced
This work fulfills PR #11799. Moved the content out of the vault file,
into best practices, edited it, then referenced it from variables and
vaults content files.
2015-10-15 09:55:17 -04:00
jdelaporte
c2a5381438 Fix links to dynamic inventory script example.
:doc`aws_example` no longer existed.
2015-10-14 12:17:05 -05:00
Sandra Wills
1918604e72 reordering entries in glossary for alphabetical order 2015-10-14 11:37:27 -04:00
Toshio Kuratomi
3f2efddeb2 Merge pull request #12733 from docschick/ansible_ssh_docswork
added "include" for ansible_ssh_ change to another section
2015-10-13 11:22:31 -07:00
Sandra Wills
7dfce28e9a added "include" for ansible_ssh_ change note to another section of intro_inventory.rst for clarity 2015-10-13 13:59:44 -04:00
James Cammarata
76c8318351 Merge pull request #12688 from docschick/ansible_ssh_docswork
Ansible ssh changes docswork
2015-10-13 07:59:49 -04:00
Sandra Wills
32cb2fa215 removed repetition of note and replaced with an include directive
ansible_ssh_* changes from 1.9 to 2.0, original note made into a separate file
for easier editing, and an include for this new file added to each of the 6 file affected
by this change
2015-10-12 11:41:09 -04:00
Sandra Wills
748ff72b6b fixed typo, depricated --> deprecated, in all 6 notes 2015-10-12 08:01:24 -04:00
Toshio Kuratomi
6292520c45 Merge pull request #12444 from knakayama/bugfix/update-docs
Update docs (playbooks_loops.rst, playbooks_filters.rst)
2015-10-09 20:09:53 -07:00
Toshio Kuratomi
d660381f98 Merge pull request #12450 from glnds/devel
Installation update for people using Fishshell
2015-10-09 19:39:30 -07:00
Toshio Kuratomi
676e4232e3 Merge pull request #12438 from lekum/doc_shelvefile_lookup
Update lookups doc with shelvefile example
2015-10-09 14:34:51 -07:00
Sandra Wills
84240c9f28 fixed git conflict with double para 2015-10-08 21:44:50 -04:00
Sandra Wills
f24fbb04c9 note modified a bit, then reviewed/approved by jmartin
Ansible 2.0 has depricated the “ssh” from ansible_ssh_user,
ansible_ssh_host, and ansible_ssh_port to become ansible_user,
ansible_host, and ansible_port. If you are using a version of
Ansible prior to 2.0, you should continue using the older style
variables (ansible_ssh_*). These shorter variables are ignored,
without warning, in older versions of Ansible.
2015-10-08 21:41:27 -04:00
Sandra Wills
6af2b2a4cb added note about ansible_ssh_* change
added a note like the following to each file hit with unlabled 2.0 changes...
Ansible 2.0 moved away from using ansible_ssh_* variables to accepting
ansible_* variables. If you are using a version of Ansible prior to 2.0,
you should continue using the older style variables (ansible_ssh_*), such
as ansible_ssh_user instead of ansible_user and ansible_ssh_port instead of
ansible_port, which appear in the following content. These shorter variables
are ignored, without warning, in older versions of Ansible.
2015-10-08 21:39:26 -04:00
Bill Nottingham
aec58bfbb3 Update playbooks_blocks.rst
Remove heading that appears to be extraneous.
2015-10-07 14:26:23 -04:00
deyvsh
155282f94a Indicate that credstash plugin is new in v2
Also offer a poor-man's alternative.
2015-10-07 17:40:50 +01:00
James Cammarata
fb0294be03 Merge pull request #12657 from jhawkesworth/powershell_strict_mode_version_2
Explictly set the version of strict mode to use for powershell modules.
2015-10-07 10:30:36 -04:00
deyvsh
c4c8493f1b Add an example for map() to the filters page 2015-10-07 12:33:39 +01:00
=
345ce424c6 Explictly set the version of strict mode to use for powershell modules. 2015-10-07 06:24:37 +01:00
Brian Coca
130ba70598 added missing blank line for markup separation 2015-10-05 09:05:59 -04:00
Brian Coca
da458bbfd6 added way to display inventory vars for host to faq + some minor fixes/edits 2015-10-05 08:57:43 -04:00
Abhijit Menon-Sen
478e234bc3 Reword the jump host section in the FAQ
It's just s/extra_args/common_args/, but I reworded some parts to make
things a bit clearer too.

Closes #12335
2015-10-02 21:26:25 +05:30
Abhijit Menon-Sen
3ad9b4cba6 Rework additional ssh argument handling
Now we have the following ways to set additional arguments:

1. [ssh_connection]ssh_args in ansible.cfg: global setting, prepended to
   every command line for ssh/scp/sftp. Overrides default ControlPersist
   settings.
2. ansible_ssh_common_args inventory variable. Appended to every command
   line for ssh/scp/sftp. Used in addition to ssh_args, if set above, or
   the default settings.
3. ansible_{sftp,scp,ssh}_extra_args inventory variables. Appended to
   every command line for the relevant binary only. Used in addition to
   #1 and #2, if set above, or the default settings.
3. Using the --ssh-common-args or --{sftp,scp,ssh}-extra-args command
   line options (which are overriden by #2 and #3 above).

This preserves backwards compatibility (for ssh_args in ansible.cfg),
but also permits global settings (e.g. ProxyCommand via _common_args) or
ssh-specific options (e.g. -R via ssh_extra_args).

Fixes #12576
2015-10-02 21:26:25 +05:30
Brian Coca
00b8a24299 Merge pull request #12579 from acogdev/devel
Alphabitize retry_files_enabled and retry_files_save_path
2015-10-01 20:01:04 -04:00
Brian Coca
75f99f873b Merge pull request #12379 from bcoca/document_vars
Document vars

merging so we can push PRs against the common repo
2015-10-01 12:57:51 -04:00
Trond Hindenes
e9786db541 Windows: Updated docs to reflect the new name of get-attr, along with examples 2015-09-30 23:29:05 +02:00
acogdev
e6958df9a8 Put retry_files_enabled and retry_files_save_path into alphabetical order. Found when investigating #11491 2015-09-30 13:41:51 -06:00
Brian Coca
d380cc7e7d Merge pull request #12543 from DevOps4Networks/devel
Guidance for pycrypto install on Mac OSX
2015-09-30 11:10:53 -04:00
Nathan Sowatskey
e7029a90e6 #12454 changing to footnote. 2015-09-30 10:45:43 +02:00
Austin Ziegler
67a980c9ef Describe the units for fact_caching_timeout 2015-09-29 11:59:55 -04:00
Nathan Sowatskey
68a927466e Updating Mac OSX guidance comment to make it a note for issue #12454. 2015-09-29 11:14:28 +02:00
Nathan Sowatskey
420589c715 Adding Mac OSX guidance comment for issue #12454. 2015-09-29 11:10:26 +02:00
Toshio Kuratomi
4225c0677d Merge pull request #12548 from amenonsen/pr-9130-rebase
#9130 rebase: EC2 Inventory Boto Profile Support
2015-09-28 10:47:12 -07:00
Jameel Al-Aziz
c08137a3d2 Update ec2 inventory documentation to refer to AWS_PROFILE 2015-09-28 21:35:46 +05:30
willthames
9c967dd054 Allow ec2 inventory to use a boto profile
This allows the EC2 inventory plugin to be used with
the same configuration against different EC2 accounts

Profile can be passed using --profile variable or using
EC2_PROFILE environment variable e.g.

```
EC2_PROFILE=prod ansible-playbook -i ec2.py playbook.yml
```

Added documentation on profiles to EC2 dynamic inventory doc

Only tries to use profiles if --profile argument is given
or EC2_PROFILE is set to maintain compatibility will boto < 2.24.

Works around a minor bug in boto where if you try and use
a security token with a profile it fails (boto/boto#2100)
2015-09-28 21:35:46 +05:30
Abhijit Menon-Sen
d4af7d256b Mention ansible_ssh_pipelining in intro_inventory 2015-09-28 20:55:14 +05:30
Nathan Sowatskey
ee6317ca07 Adding Mac OSX guidance comment for issue #12454. 2015-09-28 15:46:37 +02:00
Nathan Sowatskey
c8835b873b Adding Mac OSX guidance comment for issue #12454. 2015-09-28 15:40:32 +02:00
Nathan Sowatskey
f5c453f2b2 Adding Mac OSX guidance comment for issue #12454. 2015-09-28 15:39:35 +02:00
Brian Coca
b757798f3e Merge pull request #12483 from jeffwidman/patch-2
Clarified that .yml, .yaml, and .json are allowable file extensions for inventory vars files
2015-09-25 20:45:53 -04:00
Marius Gedminas
b57d549e16 Typo in shell command in example 2015-09-25 10:27:35 +03:00
Jeff Widman
3f135e3fac Clarified that .yml, .yaml, and .json are allowable file extensions for inventory variables files. 2015-09-22 17:56:04 -07:00
Jeff Widman
983ee0898d Add mention of roles_path parameter to ansible-galaxy install command 2015-09-22 15:03:40 -07:00
Nathaniel Cohen
fc0801e69b describe command line options for ConfigureAnsibleForRemoting 2015-09-22 12:45:02 -07:00
Nathaniel Schaaf
356cae9e5d Fix typo 2015-09-21 09:59:28 -05:00
Gert Leenders
2dc61bc73f Installation update for people using Fishshell 2015-09-21 11:31:44 +02:00
knakayama
f717f14fe9 Update docs (playbooks_loops.rst, playbooks_filters.rst) 2015-09-20 22:48:07 +09:00
Toshio Kuratomi
b11a44e5b4 Merge pull request #12097 from mgedmin/patch-1
Fix typo, remove redundant paragraph
2015-09-20 05:45:06 -07:00
James Cammarata
37f2cbc429 Merge pull request #12436 from amenonsen/ranges
Support «hosts: foo[1:]» and add tests for split/apply_subscript
2015-09-18 15:32:15 -04:00
Brian Coca
5dd61ad3fe Merge pull request #12409 from mgedmin/patch-2
Fix example formatting in the documentation
2015-09-18 14:21:58 -04:00
Abhijit Menon-Sen
2fcdb37e7b Support «hosts: groupname[1:]» notation (~= 'the rest of the group') 2015-09-18 22:28:34 +05:30
Alejandro Guirao
8288e27051 Update lookups doc with shelvefile example 2015-09-18 14:51:03 +02:00
James Cammarata
951128d7a6 Merge branch 'hostpatterns' of https://github.com/amenonsen/ansible into amenonsen-hostpatterns 2015-09-17 13:31:51 -04:00
James Cammarata
ba82e57445 Merge branch 'sudo_on_if_needed' of https://github.com/apollo13/ansible into apollo13-sudo_on_if_needed 2015-09-17 11:03:27 -04:00
Abhijit Menon-Sen
b47bc343ea Document , instead of : in intro_patterns, update changelog 2015-09-17 19:34:19 +05:30
Florian Apolloner
d9f873495e Ported over #7158 to support SELinux context switches. 2015-09-17 15:03:46 +02:00
Paul Freeman
f14c617084 Documentation for retry_files_enabled and retry_files_save_path 2015-09-17 11:59:32 +01:00