Commit graph

61 commits

Author SHA1 Message Date
Brian Coca
57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
2017-01-06 09:16:59 -05:00
Brian Coca
0f4ca877ac many doc fixes
removed a bunch of warnings
made nicer formatting of new module info
2016-12-22 12:27:18 -05:00
Luc Russell
8ba5a41a33 Update intro_inventory.rst (#18696)
Proposing some small grammatical changes for readability.
2016-12-01 00:32:51 -08:00
Silvio Tomatis
2cfd6c6920 Change old recommendation about insecure variables (#18493)
* Change old recommendation about insecure variables

These warnings were relevant before ansible had the secure vault feature:
any secret put into a variable used to be a bad idea.

With the vault feature (available since ansible 1.5) it's no longer a bad
idea to use these variables, as long as they aren't stored in plain text.

* Update intro_inventory.rst

Minor edit
2016-11-19 01:13:07 -08:00
Andrea Tartaglia
60d0e681dd ssh_executable docs (#17868)
* ssh_executable docs

Added docs about ssh_executable in intro_configuration and
intro_inventory under behavioral inventory params

* Added full stops + \n in intro_configuration
2016-10-05 18:18:39 -04:00
Robin Schneider
d76dd56ca3
Use addresses and names reserved for documentation
Trying to preserve the meaning of the examples. Not all occurrences in
`docsite/rst/playbooks_lookups.rst` have been changed for instance to
allow the unchanged examples to be used for testing.

Related to: #17479
2016-09-11 17:31:41 +02:00
Marcus Bointon
d99c58ee55 Mention how to load a specific inventory file (#17348)
I had to do a silly amount of searching and reading man pages before I found this vital info - it really should be on this page!
2016-09-01 10:01:15 -07:00
Adriano C
dbb0ef40c0 Minor text formatting (#15991)
* Minor formatting

* Update intro_getting_started.rst

* Minor formatting

* Reserved words formatting.

* Reserved words formatting.
2016-09-01 01:26:54 +02:00
jjshoe
02dfed92a4 Use same warning for become-pass as for ask-pass (#16702)
* Use same warning for become-pass as for ask-pass

* Whoops, right arg

* no really, I know what I'm doing
2016-07-14 10:13:51 -07:00
Toshio Kuratomi
d45a394f63 Mocate ansible_ssh_changes into a common directory 2016-05-24 11:37:04 -07:00
Peter Schaadt
08f71c400f Fixing typo in Inventory documentation. (#15858) 2016-05-13 17:47:08 -04:00
Victor Bocharsky
395f85e1bf Highlight SSH protocol types 2016-05-10 10:48:59 +03:00
ThomasSteinbach
c600ab81ee Document connection types (#15155)
* first description of non ssh based connection types

* fixed formatting
2016-04-19 18:39:48 -04:00
Toshio Kuratomi
60c943997b More doc updates regarding ansible_shell_executable 2016-03-18 09:16:21 -07:00
Toshio Kuratomi
287fd29db9 Use better rst markup (main change definition lists instead of code-blocks for config file options 2016-03-18 08:52:21 -07:00
Toshio Kuratomi
e25caebe7a Cleanups to docs and rename of inv var 2016-03-18 06:42:37 -07:00
Brian Coca
db61e9be0c add ansible_executable inventory var
also handle the overrides appropriately
also new executable to set shell type
2016-03-17 18:54:37 -07:00
Evgeni Golov
b00a620fa5 don't escape asterisks in parameter lists 2016-03-03 23:57:30 +01:00
Michael Scherer
4102812a69 Remove spurious 'either', fix #14520 2016-02-17 11:13:59 +00:00
Brian Coca
0e551e6d46 clarified ansible_shell_type description 2016-02-02 11:00:31 -05: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
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
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
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
Abhijit Menon-Sen
d4af7d256b Mention ansible_ssh_pipelining in intro_inventory 2015-09-28 20:55:14 +05:30
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
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
James Cammarata
6650ba7654 Squashed commit of the following:
commit 9921bb9d2002e136c030ff337c14f8b7eab0fc72
Author: Abhijit Menon-Sen <ams@2ndQuadrant.com>
Date:   Mon Aug 10 20:19:44 2015 +0530

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

commit 8b25595e7b1cc3658803d0821fbf498c18ee608a
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 119d0323892c65e8169ae57e42bbe8e3517551a3
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 b605c285baf505f75f0b7d73cb76b00d4723d02e
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 49f8edd035cd28dd1cf8945f44ec3d55212910bd
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 37c1a5b6794cee29a7809ad056a86365a2c0f886
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 b023ace8a8a7ce6800e29129a27ebe8bf6bd38e0
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
Charles Chan
980f44ccba Update intro_inventory.rst
Change 'SSH' to upper case.
2015-08-15 20:16:05 -07:00
Christian Jensen
b5f5404e63 Tiny typo fix 2015-08-07 14:46:21 -07:00
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
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
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
Jacek Laskowski
796c7accd1 Update intro_inventory.rst
Minor fix for consistency (and more engaging language :))
2015-07-07 14:03:46 +02: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
Dave James Miller
652daf3db4 Remove duplicated "By default" in docs 2015-06-09 19:48:38 +01: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
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
Toshio Kuratomi
fe53d86a83 inventory is ini-like but not quite like other implementations 2015-01-05 09:18:52 -08:00
Toshio Kuratomi
fb5b682989 Use "override" instead of "loaded second" to be clear about what happens
Need for clarification brought up here:
https://github.com/ansible/ansible/issues/9877
2014-12-23 12:37:42 -08:00
Sebastian Göttschkes
9660afd3e0 Adding inventory parameter to documentation
Adding the inventory parameter `ansible_sudo` to the list of behavioural
inventory parameters in the intro_inventory documentation.
2014-11-20 20:18:04 +01:00
Bruno BAILLUET
4e5dc754fa Added a comment to mention that ansible_sudo_exe is available from version 1.8 and beyond 2014-09-29 19:46:41 +02:00
Bruno BAILLUET
a25da4af05 Add a new inventory parameter (ansible_sudo_exe) to specify sudo command path. 2014-09-27 17:39:49 +02:00
Hagai
a552c07230 Added note on which version did dirs in group_vars start working 2014-05-22 17:54:21 +03:00
Hagai
e2cc510e37 Update docs to include directories inside group_vars 2014-05-22 15:31:20 +03:00