Commit graph

1428 commits

Author SHA1 Message Date
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
Marius Gedminas
5d3d53e890 Fix example formatting 2015-09-17 11:05:37 +03:00
James Cammarata
0685262d06 Merge pull request #12397 from lambeau/devel
Fix spelling
2015-09-16 16:44:09 -04:00
Chris Church
c5409ab493 Remove ansible_winrm_ host/port/user/pass options, update exception handling around establishing a winrm connection. 2015-09-16 16:38:19 -04:00
Chris Church
056c6b77d0 Support additional options for WinRM connections via inventory variables. 2015-09-16 16:38:18 -04:00
Joshua Kugler
3004e9bec8 Fixing a small typo
Just adding a missing letter.
2015-09-16 11:00:19 -08:00
Nathaniel Schaaf
ffc67f0a37 Fix spelling 2015-09-16 10:48:23 -05:00
James Cammarata
719e4020e0 Merge pull request #12387 from jkugler/patch-1
Small change so the YAML renders as code.
2015-09-16 10:38:23 -04:00
Joshua Kugler
d31f61e35c Wrong column named
Correcting the docs to match the example, which I assume to be correct.
2015-09-15 15:49:38 -08:00
Joshua Kugler
1dc7cce910 Small change so the YAML renders as code.
The line above the last YAML code block in this document did not have the requisite :: characters, so the YAML did not render correctly in the docs.
2015-09-15 15:37:20 -08:00
Brian Coca
0aeaacb947 fixed zpellings 2015-09-15 12:06:40 -04:00
Brian Coca
b6d6c2e4db corrected all missing paths changes 2015-09-15 11:57:54 -04:00
Brian Coca
4241df41aa fixed typoe (thanks @resmo) 2015-09-15 11:45:55 -04:00
Brian Coca
7f52d909c4 rewrote 1.x section of precedence to prevent promissing specificity to those reading docs for earlier versions 2015-09-15 11:40:53 -04:00
Brian Coca
6e34e84417 documenting var precedence
made new sections for vars, started explaining scope, gave example on command line override of connection vars
added some formatting changes and clarifications
2015-09-15 11:40:53 -04:00
Brian Coca
7c669f5a33 Merge pull request #12375 from jhawkesworth/configuring_kerberos_doc
Documentation PR. Add kerberos configuration instructions to windows intro page
2015-09-15 10:23:53 -04:00
Tim Gerla
e5a981e713 typo fix 2015-09-15 10:00:01 -04:00
Brian Coca
5c7bca9e17 Merge pull request #12369 from bborysenko/docsite/playbooks_variables
docs - minor fixes to playbooks_variables
2015-09-15 09:53:23 -04:00
Brian Coca
43ea5f0853 added note about registered variables 2015-09-15 09:49:22 -04:00
=
e5cad0fd9a Add kerberos configuration instructions to windows intro 2015-09-15 08:57:08 +01:00
Borys Borysenko
6b396cdab7 fix code block quoting and boldface for modules name 2015-09-15 10:56:41 +03:00
yannig.perre@gmail.com
54eb08eb0d Fix ansible v2 documentation for ini lookup plugin (property => properties). 2015-09-14 20:50:09 +02:00
Brian Coca
d8b671ca76 Merge pull request #12348 from bborysenko/docsite/playbooks_intro
docsite - playbooks_intro - minor tweaks
2015-09-14 09:25:13 -04:00
Borys Borysenko
4064063794 use boldface for modules name 2015-09-14 10:01:07 +03:00
Borys Borysenko
f5cfb5577e fix code block quoting 2015-09-14 09:55:39 +03:00
Gerard Lynch
e5211a9b18 playbooks_filters - minor fixes 2015-09-13 12:29:53 +01:00
Abhijit Menon-Sen
f56a6e0951 Rename ansible_ssh_{host,port,user} in docs to ansible_*
The _ssh variants will continue to work, but the shorter, more generic
names are preferred now.
2015-09-10 19:41:47 +05:30
Brian Coca
6dac8512a1 Merge pull request #12307 from jtyr/doc_fixes
Doc fixes
2015-09-10 09:17:22 -04:00
Jiri tyr
14dc16ca54 Adding missing colon to fix the block formating 2015-09-10 15:14:23 +02:00
Jiri tyr
174f805fb3 Resurrection of the comment filter 2015-09-10 14:37:42 +02:00
Kenny Gillen
00d2a80542 s/rpmbuild/rpm-build
When I followed these instructions, the generated path was 'rpm-build', not 'rpmbuild'. My rpm-build version is rpm-build-4.11.1-25.el7.x86_64 if that's relevant. Maybe this is 'just me', but wanted to feed back in case it's the same for everyone.
2015-09-08 17:59:53 +01:00
Bill Nottingham
e2e15992b7 Update intro_windows.rst
Fix typo that broke RST -> html parsing.
2015-09-08 11:06:54 -04:00
Brian Coca
246e602fce added note on ssh and sftp to managed node intro 2015-09-08 09:39:28 -04:00
Brian Coca
91a5d06c21 added note on os x file limits 2015-09-08 09:18:14 -04:00
Brian Coca
a424f3f7a5 Merge pull request #12278 from praveenkumar/doc_fix
Update doc to use 'become' instead of 'sudo'
2015-09-08 08:17:10 -04:00
Praveen Kumar
2fb98152ad Update doc to use 'become' instead of 'sudo' 2015-09-08 15:42:56 +05:30
James Cammarata
2a32384a2c Merge pull request #12227 from arbabnazar/patch-1
Update developing_modules.rst
2015-09-03 11:42:14 -04:00
James Cammarata
6650ba7654 Squashed commit of the following:
commit 9921bb9d20
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 20:19:44 2015 +0530

    Document --ssh-extra-args command-line option

commit 8b25595e7b
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Thu Aug 13 13:24:57 2015 +0530

    Don't disable GSSAPI/Pubkey authentication when using --ask-pass

    This commit is based on a bug report and PR by kolbyjack (#6846) which
    was subsequently closed and rebased as #11690. The original problem was:

        «The password on the delegated host is different from the one I
        provided on the command line, so it had to use the pubkey, and the
        main host doesn't have a pubkey on it yet, so it had to use the
        password.»

    (This commit is revised and included here because #11690 would conflict
    with the changes in #11908 otherwise.)

    Closes #11690

commit 119d032389
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Thu Aug 13 11:16:42 2015 +0530

    Be more explicit about why SSH arguments are added

    This adds vvvvv log messages that spell out in detail where each SSH
    command-line argument is obtained from.

    Unfortunately, we can't be sure if, say, self._play_context.remote_user
    is obtained from ANSIBLE_REMOTE_USER in the environment, remote_user in
    ansible.cfg, -u on the command line, or an ansible_ssh_user setting in
    the inventory or on a task or play. In some cases, e.g. timeout, we
    can't even be sure if it was set by the user or just a default.

    Nevertheless, on the theory that at five v's you can use all the hints
    available, I've mentioned the possible sources in the log messages.

    Note that this caveat applies only to the arguments that ssh.py adds by
    itself. In the case of ssh_args and ssh_extra_args, we know where they
    are from, and say so, though we can't say WHERE in the inventory they
    may be set (e.g. in host_vars or group_vars etc.).

commit b605c285ba
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Tue Aug 11 15:19:43 2015 +0530

    Add a FAQ entry about ansible_ssh_extra_args

commit 49f8edd035
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 20:48:50 2015 +0530

    Allow ansible_ssh_args to be set as an inventory variable

    Before this change, ssh_args could be set only in the [ssh_connection]
    section of ansible.cfg, and was applied to all hosts. Now it's possible
    to set ansible_ssh_args as an inventory variable (directly, or through
    group_vars or host_vars) to selectively override the global setting.

    Note that the default ControlPath settings are applied only if ssh_args
    is not set, and this is true of ansible_ssh_args as well. So if you want
    to override ssh_args but continue to set ControlPath, you'll need to
    repeat the appropriate options when setting ansible_ssh_args.

    (If you only need to add options to the default ssh_args, you may be
    able to use the ansible_ssh_extra_args inventory variable instead.)

commit 37c1a5b679
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 19:42:30 2015 +0530

    Allow overriding ansible_ssh_extra_args on the command-line

    This patch makes it possible to do:

        ansible somehost -m setup \
            --ssh-extra-args '-o ProxyCommand="ssh -W %h:%p -q user@bouncer.example.com"'

    This overrides the inventory setting, if any, of ansible_ssh_extra_args.

    Based on a patch originally by @Richard2ndQuadrant.

commit b023ace8a8
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 19:06:19 2015 +0530

    Add an ansible_ssh_extra_args inventory variable

    This can be used to configure a per-host or per-group ProxyCommand to
    connect to hosts through a jumphost, e.g.:

        inventory:
            [gatewayed]
            foo ansible_ssh_host=192.0.2.1

        group_vars/gatewayed.yml:
            ansible_ssh_extra_args: '-o ProxyCommand="ssh -W %h:%p -q bounceuser@gateway.example.com"'

    Note that this variable is used in addition to any ssh_args configured
    in the [ssh_connection] section of ansible.cfg (so you don't need to
    repeat the ControlPath settings in ansible_ssh_extra_args).
2015-09-03 11:26:56 -04:00
Praveen Kumar
6e1f7cd503 Fix typo to avoid traceback during testing 2015-09-03 16:35:17 +05:30
Arbab Nazar
d2e547c31f Update developing_modules.rst 2015-09-03 11:27:56 +05:00
Toshio Kuratomi
8cac397841 Note that backslash escaping has changed in some places 2015-09-01 08:04:23 -07:00
Greg DeKoenigsberg
ee7f7a82a8 Update developing_modules.rst
More specific about urllib2 restrictions
2015-08-28 15:19:54 -04:00
Greg DeKoenigsberg
ec95ad1062 Update developing_modules.rst 2015-08-28 14:30:16 -04:00
Greg DeKoenigsberg
9c150e5753 Update developing_modules.rst 2015-08-28 14:25:06 -04:00
James Cammarata
4c65306e73 Merge branch 'hostrange' of https://github.com/amenonsen/ansible into amenonsen-hostrange 2015-08-28 13:48:25 -04:00
Homme Zwaagstra
776eb3e8cd Link to constants.py in the source tree.
`constants.py` is referenced in the *Environmental configuration* section of the documentation.  This change provides a link from the documentation to the source code.
2015-08-28 13:19:13 +01:00
Steve McKuhr
f4fbfa6450 - Fixed line break causing part of the text to display as "Definition List"
which Sphinx renders in bold.
2015-08-27 21:41:36 -06:00
Abhijit Menon-Sen
b328bc023d Add a combine filter with documentation
This is based on some code from (closed) PR #7872, but reworked based on
suggestions by @abadger and the other core team members.

Closes #7872 by @darkk (hash_merge/hash_replace filters)
Closes #11153 by @telbizov (merged_dicts lookup plugin)
2015-08-27 23:29:12 +05:30
Sandra Wills
c752149fe7 ansible-lockdown added, minor editing
added info/link for ansible-lockdown to mailing list section, minor editing
(can't help myself it seems) to the paragraph about subscribing from a non-google account
2015-08-26 11:51:17 -04:00
Marius Gedminas
6dca640cb2 Fix typo, remove redundant paragraph
The bit about git rebase vs git merge is repeated in the paragraph below.  The bit about test/integration is repeated in the paragraph above. 

(And the bit about aliasing git pull to git pull --rebase is unclear, since git's aliases cannot override builtin operations.)
2015-08-26 08:13:20 +03:00
Abhijit Menon-Sen
d9086ab46b Describe the groupname[x]/[x:y] syntax in more detail 2015-08-25 21:17:24 +05:30
Brian Coca
12703c79b6 Merge pull request #11949 from bcoca/bsd_intro
draft bsd intro and bootstrapping
2015-08-23 13:35:35 -04:00
Brian Coca
144da7e7d1 Merge pull request #11765 from ldx/vault_pbkdf2hmac
Use PBKDF2HMAC() from cryptography for vault keys.
2015-08-21 11:06:00 -04:00
Brian Coca
d0350b1905 Merge pull request #12024 from jhawkesworth/win_splitdrive_filter
Add win_splitdrive filter for windows users
2015-08-20 10:49:42 -04:00
Bill Nottingham
3fd3f685ad Update faq
Guru is not a thing any more.
2015-08-20 10:00:24 -04:00
Jon Hawkesworth
a46b500851 Add win_splitdrive filter for windows users 2015-08-20 13:54:54 +01:00
Brian Coca
0eba819113 Merge pull request #11792 from deliciousfudge/devel
Update dependencies for pywinrm
2015-08-19 22:01:49 -04:00
Brian Coca
2f7164e3de corrected typo 2015-08-19 19:28:50 -04:00
Brian Coca
ee21ebaffc Merge pull request #11975 from mutemule/become_doas
Add become support for OpenBSD doas
2015-08-17 21:36:03 -04:00
Damian Gerow
1c5611100e Add become support for OpenBSD doas 2015-08-17 21:31:18 -04:00
Tim Bielawa
5a84e61778 Fix variable name mis-match in website docs for ANSIBLE_LIBRARY. Clean up some dangling whitespace 2015-08-17 11:38:00 -04:00
Charles Chan
980f44ccba Update intro_inventory.rst
Change 'SSH' to upper case.
2015-08-15 20:16:05 -07:00
Charles Chan
ec60db3907 Update intro_installation.rst
Improve documentation.
2015-08-15 19:28:23 -07:00
Patrick Easters
6ed66caaed Fix typo on AWS guide page
I assume this should read “Ansible modules” rather than “Ansible
ensiles”
2015-08-13 12:00:55 -04:00
Brian Coca
5027f66562 Merge pull request #11864 from jhawkesworth/win_path_filters
add win_basename and win_dirname filters
2015-08-12 23:46:15 -04:00
Brian Coca
f1b30fd4f6 draft bsd intro and bootstrapping 2015-08-12 22:18:29 -04:00
Brian Coca
8e30e3791e Merge pull request #11811 from amenonsen/fixme-range
FIXME in host range parsing
2015-08-12 09:06:39 -04:00
Craig Ringer
68c71ecba8 Document any_errors_fatal and max_fail_percentage 2015-08-12 17:48:42 +08:00
Tom Paine
19373e262c Update playbooks_tags.rst
This important point gets lost in the fixed width word wrap of the docs site. Separating it out to it's own line stops it being lost in the noise of the previous sentence.
2015-08-11 13:20:48 +01:00
Carlos A. Carnero Delgado
7bdaac7f63 Adding documentation for ask_vault_pass usage in ansible.cfg 2015-08-10 13:25:00 -04:00
Christian Jensen
b5f5404e63 Tiny typo fix 2015-08-07 14:46:21 -07:00
Brian Coca
8f106c9a58 Merge pull request #11078 from Yannig/devel
New lookup plugin : ini
2015-08-07 09:46:54 -04:00
Brian Coca
3c57018a10 Merge pull request #11778 from Ensighten/add_credstash_plugin
add credstash lookup plugin
2015-08-06 23:27:18 -04:00
Brian Coca
7062cb3bb7 removed soon to be deprecated role like include syntax 2015-08-06 16:54:13 -04:00
Brian Coca
d1a6cfe6f0 Merge pull request #11798 from daburmistrov/daburmistrov-docsite-any_errors_fatal
add documentation about any_errors_fatal
2015-08-06 09:54:24 -04:00
daburmistrov
7d5026a330 removing confusing parts 2015-08-06 16:51:04 +03:00
Jon Hawkesworth
f69da544f7 add win_basename and win_dirname filters 2015-08-05 18:38:15 +01:00
Yannig Perré
47db352725 Merge remote-tracking branch 'ansible/devel' into devel 2015-08-05 11:20:41 +02:00
Yannig Perré
c0bd140959 Add documentation for the ini lookup plugin. 2015-08-05 11:09:40 +02:00
Brian Coca
479c4a4be9 enabled yaml highlighting globally, made specific emphasis for blocks in playbooks_blocks docs 2015-08-04 19:13:09 -04:00
Toshio Kuratomi
6faaf41069 Update conditional docs since @jimi-c got playbook includes working in 2.0 2015-08-04 13:14:05 -07:00
daburmistrov
0b277b43a4 add documentation about any_errors_fatal 2015-08-04 22:09:33 +03:00
Abhijit Menon-Sen
5f13d40a2b Mention x:y ranges in pattern documentation 2015-08-02 23:47:18 +05:30
Roger Smith
8629ac539e Extend python-kerberos dependency section
Add (untested) dependencies for Portage, pkg, OpenCSW, and Pacman
2015-07-31 18:22:52 +12:00
Scott Cunningham
92327ba11f add credstash lookup plugin docs 2015-07-30 21:24:11 +01:00
Brian Coca
2ed5d29951 Merge pull request #11040 from resmo/patch-1
doc: we need GPLv3 license headers
2015-07-30 14:40:35 -04:00
Roger Smith
bbee2a9c65 Add pywinrm dependencies for RPM 2015-07-30 18:21:26 +12:00
Roger Smith
74e351a8ea Update dependencies for pywinrm
Adding the python-dev and libkrb5-dev libraries avoids the error message "error: command 'x86_64-linux-gnu-gcc' failed with exit status 1" when running "pip install kerberos"
2015-07-30 13:45:59 +12:00
Brian Coca
827f2ff0ac corrected var name 2015-07-29 15:46:13 -04:00
Vilmos Nebehaj
956fa80115 Add note about installing cryptography. 2015-07-29 11:43:10 +02:00
Toshio Kuratomi
0d7d22d530 Add json and fetch_url notes to checklist 2015-07-28 11:15:44 -07:00
Abhijit Menon-Sen
bb12121225 Fix incorrect example of vars_prompt 2015-07-27 11:08:39 +05:30
Sébastien Gross
c0b7fcd304 Add documentation for regex_escape filter 2015-07-26 19:08:34 +02:00
Brian Coca
6c1f4ddf7e Merge pull request #11736 from mscherer/fix_9971
Add more explicit documentation on ansible_nodename and ansible_hostname
2015-07-25 11:43:25 -04:00
Brian Coca
c7c5b40aa8 Merge pull request #11735 from mscherer/fix_10273
Document and test 'is undefined' rather than 'is not defined'
2015-07-25 09:56:15 -04:00
Michael Scherer
c2c20baf01 Add more explicit documentation on ansible_nodename and ansible_hostname
Fix #9971, based on text from Paul Czarkowski
2015-07-25 14:27:59 +02:00
Brian Coca
0dc1cbd6b9 Merge pull request #9524 from ktosiek/patch-1
guide_rax.rst: fix add_host invocations
2015-07-25 08:27:29 -04:00
Michael Scherer
106e942faa Document and test 'is undefined' rather than 'is not defined'
According to https://github.com/ansible/ansible/issues/10273,
this syntax should work better for nested dicts.
2015-07-25 14:05:27 +02:00
Brian Coca
8ace659d4c Merge pull request #10524 from TwoD/arch
Added installation instructions for Arch Linux.
2015-07-24 18:33:21 -04:00
Henrik Danielsson
c5d2db9c88 Added note about Python 2 for Arch Linux and a link to the ArchWiki page. 2015-07-25 00:08:26 +02:00
James Cammarata
014f3e8f7a Merge pull request #11722 from amenonsen/tagdocs
Clarify that tagging an include/role tags every task within
2015-07-24 15:29:09 -04:00
Brian Coca
587a327647 Merge pull request #11495 from xmj/devel
docsite/rst/intro_configuration.rst: reword Title.
2015-07-24 15:15:00 -04:00
Brian Coca
92516f9d11 extend conditions for async error
fixes #11207
2015-07-24 15:11:35 -04:00
Abhijit Menon-Sen
50d0d99ba6 Clarify that tagging an include/role tags every task within
Closes #11361
2015-07-25 00:21:06 +05:30
Brian Coca
6e2aca2261 Merge pull request #11670 from jody-frankowski/update-intro-inventory-params
Fix intro_inventory documented params. Update for the new 'become' system
2015-07-24 14:40:43 -04:00
James Cammarata
f6a08ce1ba Adding a note about chaining filters after default(omit)
Fixes #10164
2015-07-23 16:58:12 -04:00
Andy Dirnberger
02589ffbba Fix formatting of Groups of Groups
The example in the Groups of Groups section was being rendered as a quote.
Switching to the `::` notation causes it to render as preformatted text instead.
This could have also been done with a `.. code:` block, but I chose to be
consistent with other sections in the document.
2015-07-21 14:44:49 -04:00
Quentin Stafford-Fraser
dfd19d6bd8 Fix typo in docs 2015-07-21 19:38:49 +01:00
Quentin Stafford-Fraser
7a3519bbaa Documentation for inventory ignored extensions 2015-07-21 19:25:00 +01:00
Jody Frankowski
4713e58b57 modify intro inventory params docs to be shorter, ansible_su/do is moved out 2015-07-21 20:02:05 +02:00
Jody Frankowski
f7c9b5382d Fix intro_inventory documented params. Update for the new 'become' system 2015-07-21 13:47:03 +02:00
Brian Coca
84cc5f9afb Merge pull request #9961 from volanja/replace_running_to_started
to replace `running` with `started`
2015-07-20 23:13:29 -04:00
Brian Coca
c40541964b Merge pull request #11637 from bcoca/moar_docs
Moar docs
2015-07-20 22:31:34 -04:00
Brian Coca
9b1babdaec fixed typo 2015-07-20 12:31:35 -04:00
Brian Coca
cc6ba4b459 fixed spelling 2015-07-20 12:30:15 -04:00
Brian Coca
f8ca978020 fixed extra hashmark 2015-07-20 12:29:18 -04:00
Brian Coca
6bff315ed8 Merge pull request #11656 from MiguelMoll/small-grammar-fix
Update intro_configuration.rst
2015-07-20 10:39:41 -04:00
Miguel Moll
076ea66815 Update intro_configuration.rst
Removed a small grammar redundancy.
2015-07-20 10:22:45 -04:00
Brian Coca
bb1a907823 added version added for regex_replace
fixes #8994
2015-07-20 08:59:09 -04:00
Brian Coca
cddd2b2392 fixed typo 2015-07-19 22:35:49 -04:00
Brian Coca
c0bcbf3b88 more changes from feedback 2015-07-19 17:33:26 -04:00
Brian Coca
0208a2cb30 updated as per feedback 2015-07-19 17:27:13 -04:00
Marc Tamsky
2724adf18e Explain uniqueness requrement for handler task names. 2015-07-18 23:36:01 -07:00
Brian Coca
493c2e48ac Merge pull request #11072 from bcoca/winmod_checklist
added windows module checklist
2015-07-18 23:09:03 -04:00
Brian Coca
173f27531c moar docs
added docs for new v2 features
restructures modules bar and core/extras info into their own pages
changed templates to refer to the new pages
added some missing ansible.cfg options
more info on gathering setting
2015-07-17 22:53:11 -04:00
Brian Coca
a91eee358c fixed title underline length 2015-07-17 10:07:22 -04:00
objectified
b6b74746d9 fixed Github links to plugin sources 2015-07-13 17:17:05 +02:00
Brian Coca
698b277601 changed github and galaxy to always be https
fixes #9925
2015-07-11 11:33:28 -04:00
Brian Coca
493d91cb55 Merge pull request #11531 from tamsky/tamsky-document-jsonfile
document `jsonfile` fact cache
2015-07-10 18:14:59 -04:00
Brian Coca
9c5a6d7b5a fixed all references to old plugins/inventory to point at contrib/inventory 2015-07-10 13:00:12 -04:00
Carlos E. Garcia
657495d13f minor spelling changes 2015-07-10 12:42:59 -04:00
Marc Tamsky
aaf59319e4 document jsonfile and provide example config 2015-07-09 23:33:31 -10:00
Brian Coca
38904ead49 Merge pull request #11510 from jaceklaskowski/patch-1
Update index.rst
2015-07-07 09:20:08 -04:00
Jacek Laskowski
796c7accd1 Update intro_inventory.rst
Minor fix for consistency (and more engaging language :))
2015-07-07 14:03:46 +02:00
Jacek Laskowski
2a328ab61d Update index.rst 2015-07-07 11:28:20 +02:00
Brian Coca
8224627036 Merge pull request #11487 from mikeputnam/ansible-ansible-issue-11397
Be more specific describing groups of groups,
2015-07-07 00:04:38 -04:00
Hugo van Kemenade
60ec726b37 Typos 2015-07-06 10:21:40 +03:00
Johannes Meixner
90a810e2a8 docsite/rst/intro_configuration.rst: reword Title.
Make Configuration the first word, so that it is in line with other documents
and that system administrators/devops people don't lose the tab when having
many browser tabs open.
2015-07-05 19:57:41 +03:00
Mike Putnam
02aa76d518 Remove docs remnant re: var use. 2015-07-04 13:48:34 -05:00
Mike Putnam
515de1e6eb Be more specific describing groups of groups,
Fixes #11397
2015-07-04 12:30:04 -05:00
Jens Carl
3831f59094 Update developing_modules.rst
Fix typo.
2015-07-03 17:10:00 -07:00
Brian Coca
139138c604 Merge pull request #11370 from halberom/doc_magic_var
added role_path to magic var section
2015-07-02 18:17:07 -04:00
Toshio Kuratomi
f52c498aa1 Merge pull request #11410 from bhanuvrat/patch-1
grammar update to vault docs
2015-07-02 04:55:23 -07:00
Toshio Kuratomi
71f72b655e Merge pull request #11432 from sivel/splitext-filter
Add splitext filter
2015-07-01 13:17:56 -07:00
Anuvrat Parashar
f9bf6ce4d0 makes it more concise.
@msabramos's suggestions[1] incorporated.

[1] https://github.com/ansible/ansible/pull/11410#issuecomment-116319780
2015-07-01 09:54:02 +05:30
Anuvrat Parashar
0070e17750 full rewrite of the paragraph.
following @abadger's suggestion[1] in the comments

[1] https://github.com/ansible/ansible/pull/11410#issuecomment-116049590
2015-07-01 09:29:44 +05:30
Toshio Kuratomi
4b1a14eb16 Fix title length (for docs formatting) 2015-06-30 12:51:20 -07:00
Brian Coca
dc83c0e3f3 Merge pull request #11360 from mrwacky42/patch-1
Clarify that setting ssh_args trumps control_path
2015-06-30 00:37:10 -04:00
Matt Martz
4059904a18 Add splitext filter 2015-06-29 15:39:57 -05:00
Toshio Kuratomi
6daae92e73 Merge pull request #11409 from erikdw/staging-instead-of-stage
change 'stage' to 'staging', as it a much more common term for a pre-…
2015-06-27 06:31:57 -07:00
Anuvrat Parashar
c17d8b9439 [grammar nazi] rearrangment. 2015-06-27 12:34:12 +05:30
Anuvrat Parashar
de4d4bcc80 grammatical rearrangements. 2015-06-27 12:30:45 +05:30
Erik Weathers
fde99d8095 change 'stage' to 'staging', as it a much more common term for a pre-production environment, and there are already many references to 'staging' appearing in the ansible code and docs, so let's be consistent 2015-06-26 23:38:06 -07:00
Sharif Nassar
cbae925307 Clarify that setting ssh_args trumps control_path 2015-06-26 23:32:30 -07:00
Erik Weathers
94011160b3 fix typo in module-development comment: by -> but 2015-06-26 23:30:13 -07:00
Brian Coca
6d2e1a3b24 Merge pull request #11363 from danasmera/devel
Add quote to a variable following a colon
2015-06-27 00:54:37 -04:00
Brian Coca
bdceb154e5 Merge pull request #11365 from halberom/undocumented_filters
docs - added missing filters
2015-06-26 18:57:36 -04:00
Gerard Lynch
a6a86a5bdb added missing filters, changed since to new in version 2015-06-26 21:49:04 +01:00
Toshio Kuratomi
6b1ec141cb Merge pull request #11389 from silviot/patch-1
Update link to github in developing plugins docs
2015-06-26 12:35:17 -07:00
Silvio Tomatis
784b18cb24 Update link to github 2015-06-25 19:50:17 +02:00
nitzmahone
ed07a90289 added six to install-from-source docs 2015-06-24 11:40:59 -07:00
Gerard Lynch
4942f18100 added role_path to magic var section 2015-06-24 16:54:53 +01:00
danasmera
b8434db3cc fix: Add double-quote to a variable precedening color 2015-06-23 20:48:13 -04:00
danasmera
874df00f74 Add double-quote to a variable precedening color 2015-06-23 20:44:17 -04:00
Toshio Kuratomi
7b4ff28b87 Creating modules: use if __name__ 2015-06-23 14:45:44 -07:00
Toshio Kuratomi
d19700944d URL has changed 2015-06-23 08:52:57 -07:00
Peter Parente
2aba3b4172 Fix typo: "name" to "role" 2015-06-21 15:39:22 -04:00
Benno Joy
6e61881e80 Merge pull request #11329 from joshainglis/doc-fix
Fixed shebang in module example
2015-06-20 15:02:47 +05:30
Rodolfo Carvalho
fdc06c134a Fix docs typo 2015-06-18 09:03:42 +02:00
Scot Marvin
0132c51346 Update index.rst
Adding some copy edits. Feel free to disregard.
2015-06-12 17:38:37 -07:00
Felix Gläske
48c1064d0b Update guide_gce.rst
Make the docs more specific.
2015-06-12 17:21:23 +03:00
Philip Stephens
deb741240e Update playbooks_vault.rst
As of 1.9 at least, you may specify a password file in your ansible.cfg and not have to extend your playbook calls with vault flags.
2015-06-10 16:36:26 -07:00
Dave James Miller
652daf3db4 Remove duplicated "By default" in docs 2015-06-09 19:48:38 +01:00
joshainglis
64ffa160dc Fixed shebang in module example 2015-06-09 11:05:20 +10:00
Tim Gerla
597d3a5eaa add an example of multiple plays in a single playbook 2015-06-08 19:32:44 -04:00
E. Dunham
20df50e11c Fix confusing wording about aliases
Point out that nicknames for hosts can go in the hosts file, by fixing wording that seemed contradictory.
2015-06-06 21:35:51 -07:00
vroetman
e3d40e541c Update current released Ansible to 1.9.1
Update current released Ansible to 1.9.1 and development version to 2.0
2015-06-05 09:55:24 -04:00
Javier Martínez
23cbfc17e5 Fixed Github examples directory URL 2015-06-04 17:52:37 +02:00
Brian Coca
337b1dc45c minor doc fixes 2015-06-03 20:56:33 -04:00
Brian Coca
2e39661a26 made with_ examples have explicit templating 2015-06-03 11:15:42 -04:00
James Cammarata
e547e1f9ba Merge branch 'devel' into devel_switch_v2 2015-06-01 16:53:15 -05:00
Rob Szarka
d8bfb4c629 Update guide_aws.rst
Fixed typos.
2015-05-29 21:49:52 -04:00
James Cammarata
2bad888f28 Merge branch 'v2_final' into devel_switch_v2
Conflicts:
	lib/ansible/inventory/__init__.py
	lib/ansible/modules/core
	lib/ansible/utils/__init__.py
	lib/ansible/utils/module_docs.py
2015-05-28 15:26:03 -05:00
René Moser
83074f4d93 doc: we need GPLv3 license headers
GPLv2 only headers are incompatible with GPLv3
2015-05-27 15:10:10 +02:00
Brian Coca
7508709045 updated as per feedback 2015-05-27 07:30:10 -04:00
Brian Coca
c87586e9e5 updated formatting 2015-05-26 15:11:30 -04:00
Erik Weathers
5c455ad729 fix typo in --ask-sudo-pass reference within playbook_intro doc 2015-05-24 17:02:02 -07:00
Jeremy Olexa
2180981a6e Minor Fix for broken link 2015-05-19 22:18:24 -05:00
Toshio Kuratomi
0bb4101842 Fix doc formatting 2015-05-19 15:13:09 -07:00
Brian Coca
6c1e806a2f added return docs management 2015-05-18 09:57:44 -04:00
Brian Coca
d42cfb3386 added module checklist docs 2015-05-18 08:57:22 -04:00
Toshio Kuratomi
8a26b17f16 Merge pull request #11009 from kustodian/fix-pattern-documentation
Fixed documentation for host pattern portions
2015-05-15 09:20:51 -07:00
Strahinja Kustudić
fa1549fec1 Fixed documentation for host pattern portions 2015-05-14 12:24:36 +02:00
Serge van Ginderachter
9b646dea41 Add optional 'skip_missing' flag to subelements 2015-05-12 12:52:16 -05:00
Brian Coca
537baf6512 Merge pull request #10903 from gtback/include-variable-structure-docs
Make "include" variable documentation consistent
2015-05-11 22:56:56 -04:00
Alex Muller
1caee5cb79 Remove unnecessary 'from' in playbook intro docs
To make this sentence make sense.

Fixes #10970.
2015-05-11 20:12:21 +01:00
Tom Paine
0c21f05bcd Update become.rst
Visually separate commands and values from description text for clarity. Add value detail for become_user and become_method to match become.
2015-05-11 18:33:24 +01:00
Brian Coca
419ef0d19c Merge pull request #10959 from bcoca/sudo_docfix
fixed docs on the meaning of -H sudo arg
2015-05-08 14:53:42 -04:00
Brian Coca
2e8758d8c4 fixed docs on the meaning of -H sudo arg
fixes #7418
2015-05-08 11:08:10 -04:00
Tom Paine
1108fd3dd2 Update playbooks_tags.rst
highlight the command part of the sentence to clarify use of 'all' tag.
2015-05-07 12:22:08 +01:00
Jon Hawkesworth
9d572afb61 Add advice about using unpatched Windows Management Framework 3.0.
Hopefully this should reduce bug reports like #10878 and #10825
2015-05-06 06:33:34 +01:00
Toshio Kuratomi
4839243366 Documentation fixes 2015-05-05 13:51:22 -07:00
Brian Coca
91caadab86 Merge pull request #10884 from nickhammond/privilege_escalation
Add become docs to the intro configuration for #10881
2015-05-05 10:47:03 -04:00
Brian Coca
e971b60f26 updated docs about ansible_hosts/inventory env vars 2015-05-05 09:48:57 -04:00
Brian Coca
5959f83248 Merge pull request #10860 from bcoca/role_doc_clarify
clarify role spec, dependencies and galaxy involvment.
2015-05-04 12:17:17 -04:00
Greg Back
8a7496af42 Make "include" variable documentation consistent
There is already a good example of a list variable ("ssh_keys")
contained above this snippet, so reuse the content here.
2015-05-01 16:45:56 -05:00
Bill Nottingham
4d4e2bb5a0 Tweak vault description.
Vault isn't specifically for source control. Make description a little more generic and descriptive.
2015-05-01 13:53:29 -04:00
Charles Lanahan
c9815ef286 Update intro_dynamic_inventory.rst
Examples of special characters being converted to underscores for clarity.
2015-05-01 10:23:56 -07:00
Brian Coca
4e85419257 Merge pull request #10853 from cgar/spelling
just a few spelling error changes

I swear only 95% of those are mine!
2015-04-30 09:02:09 -04:00
Nick Hammond
be15d74935 Add become docs to the intro configuration for #10881 2015-04-29 21:22:24 -05:00
Brian Coca
3846528366 clarify role spec, dependencies and galaxy involvment.
fixes #10832
2015-04-28 16:38:53 -04:00
Toshio Kuratomi
39650efc38 Fix title underline for rst 2015-04-28 11:11:49 -07:00
Carlos E. Garcia
cfbfd38723 just a few spelling error changes 2015-04-28 09:36:42 -04:00
Tyler Harper
ee32403467 change --ansible-private-keyfile to --private-key
An old command line option was left in the documentation.
2015-04-27 11:16:56 -04:00
Brian Coca
8161dab60a added notes about privilege escalation limitations 2015-04-21 15:32:35 -04:00
Greg Taylor
c5e9a87e74 Correct emphasis markup nit in playbooks_vault.rst
It looks like the original intention was to italicize, but someone was used to another markup language. I have switched the wrapped tags so we're showing italics and not a broken link.
2015-04-21 11:11:57 -07:00
Hiroaki Nakamura
f0158d4eed Add Python 2.7 to Conrol Machine Requirements in docsite 2015-04-22 02:57:26 +09:00
Hennadiy (Gena) Verkh
da3780908a Fixed links 2015-04-21 11:32:10 +02:00
Mikko Ekström
1d966ac5bb Correct minor spelling typos. 2015-04-21 00:13:52 +02:00
Brian Coca
56deb35e67 updated intro to new become syntax, also added link to full become docs 2015-04-20 13:31:36 -04:00
Brian Coca
5d446bbd5b Merge pull request #10767 from sivel/issue/10763
Correct the ternary example. Fixes #10763
2015-04-18 22:48:44 -04:00
Matt Martz
d34e7d7bca Correct the ternary example. Fixes #10763 2015-04-18 16:05:35 -05:00
Kevin Ndung'u
5913227d9f Make shell quoting rules explanation a bit clearer
I personally got confused by the use of 'vs' in the explanation.
Maybe this explains it better?
2015-04-18 12:47:02 +03:00
Mark Phillips
77afdd16b0 Fixed a few typos in the become documentation 2015-04-16 17:30:54 +01:00
eroldan
87dde862bd Fixed wrong example of 'environment' for setting PATH 2015-04-13 16:21:08 -03:00
Toshio Kuratomi
bad554d517 Merge pull request #9268 from kustodian/docs_advance_conditions
Added an example for paretheses
2015-04-13 10:13:41 -07:00
Toshio Kuratomi
1121928f50 Merge pull request #10318 from dmahler/devel
Some grammatical updates
2015-04-13 08:43:31 -07:00
Jesse Rusak
652cd6cd5e Fix --force-handlers, and allow it in plays and ansible.cfg
The --force-handlers command line argument was not correctly running
handlers on hosts which had tasks that later failed. This corrects that,
and also allows you to specify force_handlers in ansible.cfg or in a
play.
2015-04-10 19:38:59 -04:00
Chris Church
944690118f Update windows documentation to indicate how to specify kerberos vs. basic auth. 2015-04-09 15:51:43 -04:00
Brian Coca
1e7f7bfc12 Merge pull request #10642 from gaomd/patch-1
Remove redundant whitespace.
2015-04-08 11:21:22 -04:00
Niall Donegan
3ae4ee9c52 Updated outdated link to module directory.
Core modules link updated and Extras link added.
2015-04-08 14:24:21 +01:00
Mengdi Gao
665babdaab Remove redundant whitespace. 2015-04-08 14:19:45 +08:00
Mohamed Hazem
bb3f50361e Replaced --start-at with --start-at-task 2015-04-05 20:47:22 +03:00
Bill Nottingham
7e3b3b6ebe Update intro_windows.rst
Add a bit about what Windows versions PS3 is actually available for.
2015-04-03 14:26:45 -04:00
Bill Nottingham
22608939eb Update intro_windows.rst
Refer to PowerShell consistently.
2015-04-03 14:23:04 -04:00
Matt Martz
fa076591c9 Don't recommend installing ansible via homebrew 2015-04-02 15:30:37 -05:00
Luke
132c0e794d note added to source section
Added reminder to not use source install method if you're going to be installing ansible for a Tower system
2015-04-01 08:29:56 -04:00
Brian Coca
c90e3f0d16 small updates to community and contribution page 2015-03-29 15:58:56 -04:00
Henrik Danielsson
c6942578bf Added installation instructions for Arch Linux. 2015-03-24 12:00:58 +01:00
Cristian Ciupitu
577cdcadb3 Doc: use literal code blocks for YAML examples
Without this, the straight double quotes (") are displayed as curved
quotes (“ and ”).
2015-03-23 22:52:42 +02:00
Tim Rupp
9a680472f8 Fixes a brief spelling error
Fixes a simple spelling mistake that was bugging me when I read the online
docs. Trying to make the docs as great as possible.
2015-03-21 19:22:12 -07:00
Henry Todd
10e14d0e0a Update add_host example in AWS Guide
The add_host module now uses "groups" instead of "groupname" to allow for specifying more than one group.
2015-03-21 13:21:55 +08:00
Brian Coca
64b447f01b grammer correction 2015-03-20 16:55:03 -04:00
Brian Coca
690d227034 extended return value explanation 2015-03-20 16:55:03 -04:00
Brian Coca
94909bd4a2 Added return values documentation to modules 2015-03-20 16:55:03 -04:00
Toshio Kuratomi
d1641f2925 Remove the multiline string for arguments not. 2015-03-19 16:10:01 -07:00
Toshio Kuratomi
86dc83b76d Merge pull request #10163 from maxamillion/docs_yaml_dict_playbook
Add intro to playbook docs using YAML dictionaries
2015-03-19 16:08:36 -07:00
Michael Crilly
8e346186b2 Correct version number.
1.8.4 is the latest stable now, I believe.
2015-03-13 18:07:18 +00:00
Jeff Widman
f6d8e457ab Typo: lead --> led 2015-03-11 01:20:17 -07:00
Brian Coca
5f6db0e164 preliminary privlege escalation unification + pbrun
- become constants inherit existing sudo/su ones
- become command line options, marked sudo/su as deprecated and moved sudo/su passwords to runas group
- changed method signatures as privlege escalation is collapsed to become
- added tests for su and become, diabled su for lack of support in local.py
- updated playbook,play and task objects to become
- added become to runner
- added whoami test for become/sudo/su
- added home override dir for plugins
- removed useless method from ask pass
- forced become pass to always be string also uses to_bytes
- fixed fakerunner for tests
- corrected reference in synchronize action plugin
- added pfexec (needs testing)
- removed unused sudo/su in runner init
- removed deprecated info
- updated pe tests to allow to run under sudo and not need root
- normalized become options into a funciton to avoid duplication and inconsistencies
- pushed suppored list to connection classs property
- updated all connection plugins to latest 'become' pe

- includes fixes from feedback (including typos)
- added draft docs
- stub of become_exe, leaving for future v2 fixes
2015-03-10 18:42:36 -04:00
Brian Coca
39a3d6f5ed added version to ternary example 2015-03-10 12:42:55 -04:00
Brian Coca
0ff77b3650 Merge pull request #10404 from maxalbert/doc_enhancement
Add note to section 'Loops' that the 'when:' statement is processed per-item
2015-03-10 10:51:47 -04:00
Brian Coca
a4c7aca419 Merge pull request #10395 from AndrewLorente/patch-2
Mention `view` in the ansible vault docs
2015-03-10 10:43:05 -04:00
Dag Wieers
2e67372919 Make the example somewhat more feature complete
New users might think that "state=started" implies that the service is also started at boot-time, which isn't.
By adding it, this change makes a clear distinction between the service state, and whether it is enabled (at boot).
And makes the example more feature-complete as this is what most people would be doing anyway.
2015-03-09 16:16:58 +01:00
Brian Coca
08617c087b Merge pull request #8866 from Fresheyeball/patch-1
Document Environment in tasks as well
2015-03-09 02:05:27 -04:00
Toshio Kuratomi
cc7385d8f7 Add the playbook filters to a toctree 2015-03-06 21:02:40 -08:00
Maximilian Albert
af593c2f51 Add note to section 'Loops' that the 'when:' statement is processed per-item. 2015-03-06 21:35:49 +00:00
Andrew Lorente
822c401a71 Mention view in the ansible vault docs 2015-03-05 14:01:09 -08:00
Vincent van Scherpenseel
01886ede28 Update playbooks_vault.rst
Typo fix (passwords -> files).
2015-03-05 14:05:38 +01:00
Brian Coca
6223094c54 Merge pull request #10351 from lekum/doc-update-mock
Update doc for testing PR with mock dependency
2015-02-27 08:54:51 -05:00
Alejandro Guirao
0e493dbd69 Update doc for testing PR with mock dependency 2015-02-27 09:34:20 +01:00
Brian Coca
d0f8df4bdb Merge pull request #10079 from lorin/csv-lookup-doc
Add docs for csvfile lookup
2015-02-26 23:54:57 -05:00
Brian Coca
5a64b2e269 Merge pull request #10305 from bcoca/cartesian
Cartesian
2015-02-26 23:25:33 -05:00
Brian Coca
c9cbe9d528 Merge pull request #9906 from NateEag/patch-1
"its" => "it's" in docsite/rst/intro_adhoc.rst
2015-02-26 22:57:17 -05:00
Toshio Kuratomi
82685799cb filter name is realpath, not readlink
Fixes #10062
2015-02-26 14:17:39 -08:00
Brian Coca
c81d981164 Merge pull request #10183 from bcoca/tag_control
adds complex tag management
2015-02-25 10:36:11 -05:00
David Mahler
c4144b1391 Some grammatical updates 2015-02-22 19:28:16 +00:00
Maciej Delmanowski
c10f4c23dd Specify that 'ipaddr' is available in 1.9 2015-02-21 14:11:04 +01:00
Maciej Delmanowski
25ef581a90 Add basic examples of ipaddr filter use 2015-02-21 13:34:22 +01:00
Maciej Delmanowski
71dae62b2a Add IP address filter documentation 2015-02-21 13:21:07 +01:00
Maciej Delmanowski
c866a26d81 Move Jinja2 filters documentation to separate file 2015-02-21 13:01:22 +01:00
Brian Coca
965680a18e documented cartesian lookup in 1.9 2015-02-20 09:06:17 -05:00
Brian Coca
a66c559818 documented new wantlist feature 2015-02-19 18:29:29 -05:00
Brian Coca
54cf8f1138 Merge pull request #10256 from kstrauser/kerberos-docs
Added winrm/kerberos configuration information
2015-02-16 12:48:21 -05:00
Kirk Strauser
1b67aa94e8 Added winrm/kerberos configuration information 2015-02-16 09:36:39 -08:00
Lorin Hochstein
639f06e0e8 Document redis_kv Python package dependency
Mention in docs that the redis_kv lookup requires that the redis Python package
is installed.
2015-02-15 22:37:58 -05:00
Brian Coca
af573db47a documented new tag behaviour 2015-02-13 08:27:07 -05:00
Toshio Kuratomi
53e5c5e33f Merge pull request #10205 from alefteris/patch-1
Typo in galaxy.rst
2015-02-12 12:00:25 -08:00
Brian Coca
62a6378c4a Merge pull request #8792 from bcoca/ternary_filter
ternary filter
2015-02-12 11:29:49 -05:00
Brian Coca
ec8483eb69 Merge pull request #10227 from fullergalway/patch-1
Small change to guid_gce.rst,  'project-name', should be 'project_id'
2015-02-12 10:00:13 -05:00
fullergalway
a8c02ea807 Small update to guid_gce.rst, says 'project-name', should be 'project_id'. 2015-02-12 09:15:43 +00:00
Tongliang Liu
1fc2095157 Added "--recursive" to git clone command in installation via yum section. Changed rpm build parent directory to current dir. 2015-02-11 20:00:38 -08:00
Brian Coca
f05a1085e9 Merge pull request #9249 from tjanez/doc-add_note_about_escaping_with_regex_replace
Added a note about escaping backreferences when using 'regex_replace' filter
2015-02-11 17:47:19 -05:00
Thanos Lefteris
ef11c8ce55 Typo in galaxy.rst 2015-02-11 23:03:45 +02:00
Brian Coca
13d788021f Merge pull request #4820 from mscherer/add_local_config
Add path for user defined plugin
2015-02-11 14:44:07 -05:00
Brian Coca
9820165265 Merge pull request #10188 from simontite-capita-ti/patch-1
Update playbooks_delegation.rst
2015-02-09 10:14:34 -05:00
simontite-capita-ti
21094614c0 Update playbooks_delegation.rst
There's a space missing "hosts:127.0.0.1" should be "hosts: 127.0.0.1"
2015-02-09 11:05:21 +00:00
Brian Peiris
ae5f64c232 Update YAMLSyntax.rst 2015-02-05 11:16:39 -05:00
Brian Peiris
32a5dc22c6 Reformat description of a dictionary entry. 2015-02-05 11:13:33 -05:00
Adam Miller
1e787bd91e Add intro to playbook docs using YAML dictionaries 2015-02-04 09:56:44 -06:00
Erika Heidi
c20c6d4eb4 [Vagrant guide] Updating private key location
Since Vagrant 1.7.0, released in December 2014, the private key file is autogenerated and has a new location - check the changelog for more info: [version 1.7.0 changelog](https://github.com/mitchellh/vagrant/blob/master/CHANGELOG.md#170-december-9-2014)
2015-02-02 13:30:17 +01:00
Michael Scherer
d6edbeb4d0 Fix documentation on hostfile vs inventory , follow up of #10130 2015-02-01 12:12:40 +01:00
Brian Coca
daa2c3a956 Merge pull request #9584 from Sgoettschkes/issue_docs_missing_ansible_sudo
Adding inventory parameter to documentation
2015-01-28 13:42:59 -05:00
Brian Coca
990d08b63f Merge pull request #10113 from bcoca/url_lookup
Url lookup
2015-01-28 09:54:40 -05:00
Dagobert Michelsen
7a90139e3c Add OpenCSW for Solaris 2015-01-28 10:23:03 +01:00
Brian Coca
6118bf4b64 corrected missing quote 2015-01-27 17:48:39 -05:00
Brian Coca
424065229c added example of url lookup 2015-01-27 17:25:55 -05:00
William Jimenez
36e0e1ef26 explain -q flag for env-setup
See https://github.com/ansible/ansible/issues/10109
2015-01-27 12:56:21 -08:00
Lorin Hochstein
0474b5ce5d Document that dnstxt lookup requires dnspython
Add a line in the docs to specify that dnstxt requires that you have the
dnspython package installed.
2015-01-25 15:20:49 -05:00
Lorin Hochstein
6a7012474b Add docs for csvfile lookup 2015-01-23 21:06:12 -05:00
Björn Andersson
65e4f2b2bc Add filter to turn a string into a UUID
This filter was made because I needed to create idempotent UUIDs when
installing the agent for Go (http://go.cd), which uses UUIds to
distinguish the agents from each other.

It uses a newly created Ansible namespace to distinguish UUIDs created
by Ansible from any other source. The new namespace is a random one
created by uuidgen on OSX.
2015-01-21 08:07:17 +08:00
Brian Coca
cf6f05e71d Merge pull request #10039 from tima/doc-version-fix
Modified the version numbers in one section on index of docs to reflect their current state.
2015-01-19 15:30:41 -05:00
Brian Coca
1a1b66702f Merge pull request #10037 from lekum/aws-doc-bug
Add missing register
2015-01-19 15:29:59 -05:00
Brian Coca
2a9d5054bf Merge pull request #9995 from bcoca/hash_filters
Hash filters
2015-01-19 15:17:39 -05:00
Jeremy Voorhis
f6e309bebb Fix copy/paste in plugins docs. 2015-01-18 15:55:24 -08:00
Timothy Appnel
802f0048e5 Modified the version numbers in one section on index of docs to reflect their current state. 2015-01-18 14:34:02 -05:00
Alejandro Guirao
63808ee3f1 Add missing register 2015-01-18 14:27:26 +01:00
Brian Coca
b28ef1701f Merge pull request #9896 from resmo/fix/doc
doc: mention smart gathering for facts caching
2015-01-16 10:17:51 -05:00
Brian Coca
ffe1dcde28 Merge pull request #9713 from bcoca/fact_cache_n_gathering
mentioned gathering settings in fact caching.
2015-01-16 10:17:17 -05:00