Commit graph

47 commits

Author SHA1 Message Date
Toshio Kuratomi
4f7a0925fd Corrections to documentation formatting 2016-05-04 12:18:02 -07:00
Alexandr Elhovenko
3014f78bb9 Fix typo in FAQ (#15472) 2016-04-19 11:24:51 -04:00
Kevin London
d6f3a1423a Update faq.rst
Minor changes to spacing and names of variables
2016-03-23 13:31:16 -07:00
Michael Scherer
b3d600f1ec Fix the lexer used, jinja2 is not valid, jinja is 2016-03-13 10:03:57 +01:00
Brian Coca
70e7be0346 added clarification on moustaches 2016-03-01 12:43:52 -05:00
Brian Coca
d6716a2f90 noted issues with setup now inheriting environment 2016-03-01 09:17:16 -05:00
Brian Coca
b0bed27211 minor doc fixes 2016-02-26 16:46:26 -05:00
Toshio Kuratomi
86b8dc0e79 Add a configuration setting that allows the user to specify printing of task arguments in the header.
Fixes #14554
2016-02-18 04:20:35 -08:00
Fuentes, Christopher
de529c1734 minor grammar error was making me pull hair out 2016-01-04 13:52:06 -05: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
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
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
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 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
Bill Nottingham
3fd3f685ad Update faq
Guru is not a thing any more.
2015-08-20 10:00:24 -04:00
Brian Coca
2f7164e3de corrected typo 2015-08-19 19:28:50 -04: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
eroldan
87dde862bd Fixed wrong example of 'environment' for setting PATH 2015-04-13 16:21:08 -03: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
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
Isaac Shapira
26a1e20bb2 enviroment -> environment 2014-09-05 08:21:45 -06:00
Richard Barrell
bed2eb36d3 Issue 8872: use getpass.getpass() to read password.
This avoids passing the plaintext raw password into the script as a
command-line argument, which shells such as bash and zsh will
typically log into a file like ~/bash_history.

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

getpass.getpass() is part of Python's standard library in all versions
between 2.4 and 3.3 at least.
2014-09-03 12:41:11 +01:00
Isaac Shapira
7dd95e43a4 Document Environment in tasks as well
Googling around for environment variables in Ansible yields this page. It would be useful to have the task version documented here as well.
2014-09-02 19:48:01 -06:00
Michael DeHaan
99c39b1ff3 By popular request, make the no_log attribute also censor tasks from callbacks. 2014-08-12 13:36:05 -04:00
Darren
54d1a80187 Update faq.rst
Change user mailing list link to ansible-project from ansible-devel
2014-05-06 12:07:12 +01:00
Christian Berendt
58ff9cd7c8 fixed typos found by RETF rules in RST files
rules are avaialble at https://en.wikipedia.org/wiki/Wikipedia:AutoWikiBrowser/Typos
2014-05-03 17:59:50 +02:00
Eric Dahl
9309b6b0e4 Documentation: fix various small typos 2014-03-30 18:45:55 -05:00
Michael DeHaan
ba79cf34df Update the FAQ advice on recursive copy now that there are two good ways to do this. 2014-03-19 18:05:33 -04:00
George Yoshida
5ef3cb26d4 Fix docs for faq
- correct spelling
2014-03-15 23:36:42 +09:00
Nathan W
601c4f17ec Fixed Links
Link to guru page was not rendering correctly on http://docs.ansible.com/faq.html.
Link to readme returned 404.
2014-03-04 12:18:34 -06:00
George Angelopoulos
b8d7154c30 typo fix 2014-03-02 13:21:33 +02:00
Michael DeHaan
1a6db5449a Document vault and make some cross-references in places where people should read about vault. 2014-02-27 17:44:21 -05:00
Stefhen Hovland
d88fea9a96 Fix broken Tower links 2014-01-28 23:41:39 -05:00
Michael DeHaan
81e9a60589 Much rejoicing, ansibleworks.com is now ansible.com
Also note AWX is named "Tower" now, as we found that simpler.
2014-01-28 20:29:41 -05:00
Joshua Lund
3b4f3f8ca3 Improved the documentation for password generation 2014-01-07 18:20:39 -07:00
Michael DeHaan
1251538e96 Fix syntax of docsite anchors. 2014-01-02 17:37:48 -05:00
Michael DeHaan
12ecff71ba Add a few notes about variables to the FAQ. 2013-12-27 15:52:53 -05:00
Mikhail Sobolev
64652fa6ab fix various documentation xrefs 2013-12-27 18:21:08 +02:00
Mikhail Sobolev
d1d20b7065 add a link to the resources section 2013-12-25 01:20:00 +02:00
Mikhail Sobolev
34f65f8e84 fix the link formatting 2013-12-25 01:19:41 +02:00
Michael DeHaan
041cea134f New Sphinx theme has sidebar navigation so don't need TOC on each page. 2013-12-24 17:29:28 -05:00
Michael DeHaan
0cd09dd54f Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
Renamed from docsite/latest/rst/faq.rst (Browse further)