Commit graph

297 commits

Author SHA1 Message Date
Scott Butler
1c8b85a6f1 Added support statement for older releases. 2017-01-13 11:59:16 -08:00
Adrian Likins
a560a2d512 Use portable CPUS detect for docsite make default.
Some folks run 'make webdocs' from docs/docsite, so
use the portable CPUS detections as the default here as
well.
2017-01-13 14:41:14 -05:00
Adrian Likins
b3e7794c08 Fix docs/api paths so api docs build (#20240)
Add a 'webdocs' target to docs/api to be consistent
with docsite/
2017-01-13 14:35:37 -05:00
Adrian Likins
0381bc170c Docsite sphinx rm buildsite (and speed up docs build) (#20237)
Replace docs build-site.py with default-ish sphinx build

This seems to speed up docsite build _alot_. 

The Makefile.sphinx is the sphinx-quickstart generated makefile with a few changes.

The CPUS env var or 'nproc' output is used for the number of cpus passed to 'sphinx-build -j'
2017-01-13 14:32:27 -05:00
Bernie Schelberg
2b4afd23eb Update docker example on Inventory page (#20209)
The docker module has been deprecated, so the example should be
updated to use the newer docker_container module.
2017-01-12 18:57:27 -08:00
Brian Coca
4b3977d5af added note about custom modules/plugins in roles 2017-01-12 20:15:09 -05:00
Brian Coca
2538383cf4 updated docs to make clear new option scope
this does not affect user tasks with `setup`
2017-01-12 10:53:24 -05:00
Alvaro Aleman
1b2ad94496 Configurable fact path (#18147)
* Make fact_path configurable

* Add docs for fact_path

* Add tests for localfacts

* Default fact gathering settings in PlayContext
2017-01-12 10:49:04 -05:00
Toshio Kuratomi
eeebd51f21 Rename the type filter to type_debug
Because we add the names of all filters to the callable whitelist used
by safe_eval, adding a filter named type makes it so code calling "type()"
gets eval'd.  We can't think of a way to exploit this but it's
sufficiently sketchy that we're renaming it in case someone smarter than
us can think of a problem.
2017-01-11 14:48:21 -08:00
Dag Wieers
de21038feb Enable -Verbose and log to EventLog (#19909)
Instead of asking the user to type something prior to running the script, why not allow -Verbose on the command line directly.
Also log important events to EventLog, so that it can be traced e.g. when running via RunOnce mechanism.

The documentation is updated as well.
2017-01-10 23:52:41 -08:00
scottb
745219d200 Update playbooks_lookups.rst
Edited.
2017-01-10 16:19:22 -05:00
Brian Coca
f9f99ddfbc updated docs to suggest quote filter for shells
Also changed comments into -name in examples where appropriate.
2017-01-10 16:19:22 -05:00
Brian Coca
3c4afd0470 Doc module meta (#20093)
* updated module docs to reflect unification/meta

* new doc page

* also remove module refs to old core/extra

* Update modules_support.rst

Light edit.
2017-01-10 12:58:22 -08:00
Jasper Lievisse Adriaanse
073c4df790 Update references to Passlib as homepage/docsite moved (#20082) 2017-01-10 13:17:32 +00:00
Brian Coca
54800ea47c better sections for module return docs 2017-01-09 20:18:30 -05:00
Brian Coca
0aad46c85b corrected common headers 2017-01-09 15:54:45 -05:00
Ryan Brown
a2b4ad9da0 (docs) Remove/update mentions of git submodule in docs and error me… (#19941)
* (docs) Remove/update mentions of `git submodule` in docs and error messages.

* Remove parenthetical per @dharmabumstead
2017-01-09 12:11:39 -05:00
Toshio Kuratomi
08d6990e67 Fix code-blocks to use correct syntax highlighting 2017-01-08 09:18:45 -08:00
Toshio Kuratomi
adb7426c0c Some more code-block fixes 2017-01-07 11:47:35 -08:00
John R Barker
7df31aaca1 Fix all RST errors for docs/docsite/rst (#20005)
* developing_modules.rst is now in dev_guide, sync changes and delete the old version
* Cleaner RST & formatted code
* Tidyup roadmaps
* Link to repomerge
* Pull in abadger's fixes From https://github.com/ansible/ansible/compare/docs-code-block-fixes?expand=1
* Clean docsite/rst (apart from ROADMAP
2017-01-07 11:38:52 -08:00
Brian Coca
3b2a4c1955 fixed porting guide headers 2017-01-06 15:50:32 -05:00
Toshio Kuratomi
1be3ac36df Fix block highlighting
Found out that we change the default highlighting to yaml.
So explicitly mark python code blocks as such.
2017-01-06 12:37:51 -08:00
John R Barker
ebc8b927ce Fix RST Errors 2017-01-06 19:45:47 +00:00
Rodolfo Carvalho
8f3c435b27 Fix path to test plugin examples 2017-01-06 11:41:15 -05:00
Brian Coca
d108a6f0fc fixed webdoc generation 2017-01-06 11:23:29 -05:00
Brian Coca
57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
2017-01-06 09:16:59 -05:00
Carlos E. Garcia
0b8011436d minor spelling changes 2016-12-13 13:51:13 -05:00
Samuel Boucher
b17149f3bf Update ansible.1.asciidoc.in (#18464)
* Update ansible.1.asciidoc.in

fix typo to match ansible --help
--su-user and not --se-user

* Update ansible.1.asciidoc.in
2016-11-11 08:58:19 -05:00
Chris Houseknecht
dceb2a0393 Remove extra display statements and add docs (#18229)
* Add docs for ansible-galaxy import --role-name option.

* Add docs for ansible-galaxy init --container-enabled option.
2016-10-28 00:38:39 -04:00
Brian Coca
db8c952ee3 added new ksu method to man page
removed runas refrences, because it was never implemented
2016-09-13 14:40:41 -04:00
Adrian Likins
6fdd8c4a98 Fix the doctype attribute in man page asciidocs (#16696)
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
Andrew Gaffney
4fd87f2dc6 Fix typo on -K/--ask-become-pass option in 'ansible' man page (#16667) 2016-07-11 00:15:05 +02:00
Shota
47f715fb37 Fix some typos (#16498) 2016-06-29 14:31:25 -04:00
Brian Coca
dae0b833f5 updated man page with new pull options 2016-06-23 09:14:55 -04:00
Scott Radvan
72ca3b2b5b add very minor punctuation fixes (#15763) 2016-05-09 10:12:24 -04:00
Brian Coca
e0573d3099 make vi the default editor if no EDITOR
fixes #15577
2016-05-03 09:39:19 -04:00
Tegan Snyder
bf0da4aa3c add centrify dzdo escalation (#15219)
add dzdo context, and test
2016-04-25 11:24:26 -04:00
Brian Coca
0c92ec5e8f proposals were moved to ansible/proposals 2016-03-28 15:25:06 -04:00
Brian Coca
0cabef19ad updated man pages with imssing become option
also moved -K to become password to align with current code
fixes #15123
2016-03-23 09:30:48 -07:00
Brian Coca
92c887d1ed Merge pull request #14730 from chouseknecht/docker_image_proposal
Upated docker_image_module proposal
2016-03-21 07:21:26 -07:00
Brian Coca
4a01a5fbce Merge pull request #14733 from chouseknecht/docker_files_proposal
Adding docker_files module proposal.
2016-03-21 07:21:15 -07:00
Abhijit Menon-Sen
f82639e4a2 Fix the other typo from #15036 2016-03-18 21:08:41 +05:30
Brian Coca
95495a6b38 fixed typo
fixes #15036
2016-03-18 08:35:00 -07:00
Greg DeKoenigsberg
03300e99ac Merge pull request #14929 from robynbergeron/devel
update proposals proposal
2016-03-16 15:07:49 -04:00
Robyn Bergeron
250b6c0f35 update proposals proposal
update proposals proposal with updates discussed in last week's meeting. will move this and other related materials to the new repo after this merges.
2016-03-11 11:41:53 -07:00
Brian Coca
a302ba0ab4 Merge pull request #14810 from chouseknecht/docker_network_proposal
Updating docker_network module proposal
2016-03-07 15:34:12 -05:00
Brian Coca
7c18dfbd5a Merge pull request #14799 from chouseknecht/auto_role_install_prop
14604 - Adding suggested comments related to securing Galaxy role ver…
2016-03-07 15:31:59 -05:00
Brian Coca
d23c7949eb Merge pull request #14842 from resmo/patch-4
proposal: publish/subscribe for handlers
2016-03-07 15:20:31 -05:00
René Moser
66cb77107b proposal: publish/subscribe for handlers 2016-03-07 13:00:05 +01:00
René Moser
d361f3b44e proposal: re-run handlers 2016-03-07 07:58:34 +01:00
chouseknecht
efd02020a2 Updating docker_container module proposal 2016-03-06 11:32:22 -05:00
Brian Coca
1b96454d8e Merge pull request #14796 from resmo/patch-3
prop: ignore_checkmode is a better name
2016-03-06 09:58:52 -05:00
René Moser
130c995208 proposal: ignore_checkmode is a better name
as suggested by @bcoca
2016-03-05 09:23:54 +01:00
chouseknecht
f389709558 Updating docker_network module proposal 2016-03-04 13:55:23 -05:00
chouseknecht
3d0637292c Update to docker_container module proposal 2016-03-04 13:33:45 -05:00
Robyn Bergeron
69a144bfbe Update proposals proposal with PR link 2016-03-04 07:27:28 -07:00
Robyn Bergeron
08777fdecd Create proposals_process_proposal.MD
Created proposals process proposal. Inception!
2016-03-04 07:12:13 -07:00
chouseknecht
11c1814146 14604 - Adding suggested comments related to securing Galaxy role versions 2016-03-04 08:08:04 -05:00
Brian Coca
171c925966 Merge pull request #14756 from chouseknecht/docker_network_proposal
Updating docker_network module proposal.
2016-03-02 17:53:52 -05:00
Brian Coca
e438a26ada Merge pull request #14760 from yyoshiki41/docs-tag
Fixed docs typo
2016-03-02 13:50:34 -05:00
chouseknecht
6edf1443db Adding docker_files module proposal 2016-03-02 13:31:15 -05:00
yyoshiki41
64f445f3a1 Fixed docs typo 2016-03-03 03:19:46 +09:00
chouseknecht
485bd4acc3 Fix docker_volume module proposal file name. 2016-03-02 13:00:04 -05:00
chouseknecht
d85589121e Updating docker_network module proposal. 2016-03-02 11:40:59 -05:00
Brian Coca
ab182b2bdb Merge pull request #14726 from chouseknecht/docker_one
Updating docker_container_module proposal
2016-03-02 10:29:06 -05:00
Brian Coca
ea71352bea Merge pull request #14731 from chouseknecht/docker_image_facts_proposal
Updated docker_image_facts module proposal.
2016-03-02 10:27:52 -05:00
Brian Coca
15c938f2a2 Merge pull request #14740 from chouseknecht/docker_volume_facts_proposal
Adding docker_volume_facts module proposal
2016-03-02 10:21:46 -05:00
Brian Coca
4b5bb5dd89 Merge pull request #14739 from chouseknecht/docker_network_facts_proposal
Adding docker_network_facts module proposal.
2016-03-02 10:20:40 -05:00
Brian Coca
2a1f955ea5 Merge pull request #14737 from chouseknecht/docker_network_proposal
Adding docker_network module proposal.
2016-03-02 10:08:52 -05:00
Brian Coca
cc6adf44b6 Merge pull request #14738 from chouseknecht/docker_volume_proposal
Adding docker_volume module proposal
2016-03-02 10:06:49 -05:00
René Moser
26005dfa5b proposal: deprecate always_run in favor of checkmode_run 2016-03-02 13:35:29 +01:00
chouseknecht
e0f41c7726 Updated docker_image_facts module proposal. 2016-03-02 02:49:19 -05:00
chouseknecht
f10807eb42 Adding docker_network_facts module proposal. 2016-03-02 02:32:20 -05:00
chouseknecht
d0137abf98 Adding docker_volume_facts module proposal 2016-03-02 02:26:45 -05:00
chouseknecht
3e1332495b Upated docker_image_module proposal 2016-03-02 00:21:22 -05:00
chouseknecht
76766aac8b Adding docker_network module proposal. 2016-03-02 00:10:36 -05:00
chouseknecht
804c6f9c09 Adding docker_volume module proposal 2016-03-02 00:00:31 -05:00
chouseknecht
b2dd22e9f2 Updating docker_container_module proposal 2016-03-01 23:14:30 -05:00
chouseknecht
78f4d33c94 Add docker_container module proposal. 2016-02-29 00:28:54 -05:00
chouseknecht
66756078f3 Updated auto-install-roles proposal. 2016-02-24 11:05:17 -05:00
Will Thames
80ec66f64a Proposal for auto updating roles
Reflects discussion on ansible-devel.
2016-02-19 10:49:23 +00:00
Maxim Burgerhout
275bd1b121 Fix a typo in man1/ansible 2016-02-18 08:29:58 +01: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
James Cammarata
76b4b9ed2c Merge pull request #13501 from chouseknecht/galaxy-2.0-update
Galaxy 2.0 update
2015-12-16 15:01:12 -05:00
Robin Roth
0c954bd142 add --full flag to ansible-pull man page
add --full flag that was added in #13502
2015-12-13 18:00:54 +01:00
chouseknecht
06dde0d332 Fixed documentation typos and bits that needed clarification. Fixed missing spaces in VALID_ACTIONS. 2015-12-13 05:23:04 -05:00
chouseknecht
bc73920090 Updated ansible-galaxy man page. Removed -b option for import. 2015-12-13 05:23:04 -05:00
Brian Coca
9f148fc046 removed requirement of destination and set documented default 2015-10-29 16:28:46 -04: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
   #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
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
Abhijit Menon-Sen
4afe1cf422 Update ansible-vault manpage to describe new encrypt/decrypt behaviour 2015-08-27 22:04:18 +05:30
Richard Poole
3090a45891 add option to ansible-vault to read new password from file for rekey
The --new-vault-password-file option works the same as
--vault-password-file but applies only to rekeying (when
--vault-password-file sets the old password). Also update the manpage
to document these options more fully.
2015-08-25 21:14:49 +05:30
Damian Gerow
1c5611100e Add become support for OpenBSD doas 2015-08-17 21:31:18 -04:00
snetting
15669d98ca correct ansible-playbook man1 2015-07-23 08:39:01 +01:00
snetting
4693531851 update ansible man1 2015-07-22 09:56:50 +01:00
Till Maas
f36a92f729 Re-Generate man pages 2015-05-05 16:55:09 +02: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