1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

43 commits

Author SHA1 Message Date
Adrian Likins
6fdd8c4a98 Fix the doctype attribute in man page asciidocs ()
The asciidoc.in sources had an attribute like:

:doctype:manpage

That attribute was not being correctly rendered in a2x
resulting in the 'doctype:manpage' showing up in a spurious
additional AUTHOR section at the end of the generated man pages like:

AUTHOR
       :doctype:manpage

Fix with correct formatting of 'doctype' attribute.
2016-07-29 15:59:35 -04:00
Shota
47f715fb37 Fix some typos () 2016-06-29 14:31:25 -04:00
Scott Radvan
72ca3b2b5b add very minor punctuation fixes () 2016-05-09 10:12:24 -04:00
Brian Coca
0cabef19ad updated man pages with imssing become option
also moved -K to become password to align with current code
fixes 
2016-03-23 09:30:48 -07:00
Abhijit Menon-Sen
f82639e4a2 Fix the other typo from 2016-03-18 21:08:41 +05:30
Brian Coca
95495a6b38 fixed typo
fixes 
2016-03-18 08:35:00 -07:00
yyoshiki41
64f445f3a1 Fixed docs typo 2016-03-03 03:19:46 +09:00
Aleksi Aalto
aea8900abe document exit status for ansible-playbook 2016-02-15 01:54:52 +02:00
Denis
4e95c9f1eb Fix typos. 2016-01-15 21:01:05 +01:00
Brian Coca
2e05304f66 typo fix 2015-10-27 20:02:40 -04:00
Brian Coca
8eda94c591 normalized descriptions for most man pages
also removed the intermediate man page
added intermidieate manpages to gitignore
2015-10-26 11:03:50 -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
    and , 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  and  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 
2015-10-02 21:26:25 +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 () which
    was subsequently closed and rebased as . 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  would conflict
    with the changes in  otherwise.)

    Closes 

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
Damian Gerow
1c5611100e Add become support for OpenBSD doas 2015-08-17 21:31:18 -04:00
snetting
4693531851 update ansible man1 2015-07-22 09:56:50 +01:00
Till Maas
8ad2eac7e1 Mention ANSIBLE_INVENTORY
Support for ANSIBLE_HOSTS is faded out, see commit
c73254543a, therefore do not mention it in
the man pages.
2015-05-05 16:54:32 +02:00
Chris AtLee
1bf8f78b18 Add --list-hosts to man pages.
Fixes 
2015-02-27 08:38:45 -05:00
Giovanni Tirloni
bcbf819a8b Add how to load extra variables directly from a file (using @). 2015-02-12 21:31:56 -05:00
Cristian Ciupitu
7cb4b7ab89 Fix typos in ansible-playbook man page source
Note: the man page needs to be rebuilt.
2014-04-14 01:22:18 +03:00
Maykel Moya
0b1320e48c Update doc, irc and mailing list information in manpages input 2014-02-12 16:02:33 +01:00
Maykel Moya
0b44a3e54f Minor grammar fix in manpages 2014-02-11 16:50:10 +01:00
Matthew Phipps
d78951e767 Add skip_tags to ansible-playbook man page 2014-01-27 18:03:10 -05:00
Ray
b5266a562d minor correction
Same doc-typo (confirmed) as https://github.com/ansible/ansible/pull/4759

--remote-user  *should be*  --user
2013-10-31 19:29:46 -05:00
Michael DeHaan
b19609b98b Slight docs tweak 2013-05-31 16:05:07 -04:00
Michael DeHaan
0837c9785f Merge pull request from bfabio/devel
Support JSON in --extra-vars.
2013-05-31 13:06:05 -07:00
Fabio Bonelli
6bef150695 Support JSON in --extra-vars.
If --extra-vars starts with either a '{' or a '[', it will be assumed
we are dealing with JSON and parse the data as such.
2013-05-28 09:46:50 +02:00
Michael Vogt
d7b5b47efe improve wording, thanks to Michael DeHaan 2013-05-25 08:53:20 +02:00
Michael Vogt
8338e75463 document in the man-page that {ansible,ansible-playbook} -M can also be overriden with the ANSIBLE_LIBRARY environment 2013-05-23 21:22:58 +02:00
Yves Dorfsman
8b10cc5946 Mention of ansible-doc and man pages for modules. 2013-03-18 20:31:42 -06:00
r-p-e
1f1eb4125f align manpages with actual code for --syntax-check 2013-03-06 00:42:53 +01:00
Michael DeHaan
2a66185920 update manpage for new options. 2013-02-16 15:38:59 -05:00
Fabian Arrotin
96770a3057 - Fixed some typos for the ansible config file
- added the ANSIBLE_CONFIG environment variable
2012-10-30 17:08:12 +01:00
Michael DeHaan
70ed560fb3 Add FILES to manpage 2012-10-12 17:37:30 -04:00
Michael DeHaan
4920533c05 Add --limit to manpage 2012-09-06 18:42:18 -04:00
Tim Bielawa
698bcaa581 Fully document the -v option. 2012-08-15 10:13:38 -04:00
Tim Bielawa
6d9e873724 Add some docs/examples
Add a basic ansible-pull man page.

Add the example playbooks/scripts to the RPM package.

Closes 
2012-08-14 13:05:44 -04:00
Tim Bielawa
bf7e83bea6 Update man pages and the message for an exception. 2012-08-09 10:22:43 -04:00
Michael DeHaan
efac68b636 Remove the -D module debug flag, which no longer is functional due to sudo pty requirements, and replace with -v/--verbose.
This flag will show playbook output from non-failing commands.  -v is also added to /usr/bin/ansible, but not  yet used.

I also gutted some internals code dealing with 'invocations' which allowed the callback to know what module invoked
it.  This is not something 0.5 does or needed, so callbacks have been simplified.
2012-06-19 21:57:43 -04:00
Michael DeHaan
8e8cde3a2c override hosts gone 2012-05-07 23:18:06 -04:00
Michael DeHaan
36e454c52f Because paramiko using a pty can't distinguish stderr and stdout, remove handling that
treated -D as a way to show stderr, and make sure modules don't include things on stderr.
Update docs and test module script to come into line.
2012-04-27 01:25:38 -04:00
Michael DeHaan
b9982fc17b Reinstate --extra-vars, which can do things in playbooks like:
ansible-playbook release-my-app.yml --extra-vars="version=123"

And make $version available in the playbook without re-editing the file
2012-04-26 19:57:07 -04:00
Tim Bielawa
621dc83ac2 Fix man page option description indentation. 2012-04-17 11:39:51 -04:00
Tim Bielawa
d43cf592eb Renaming asciidoc sources to .in.
Change manpages to build from *.in and add comments about how the make
targets work.
2012-04-17 10:31:40 -04:00
Renamed from docs/man/man1/ansible-playbook.1.asciidoc (Browse further)