Commit graph

1160 commits

Author SHA1 Message Date
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
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