Commit graph

2428 commits

Author SHA1 Message Date
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
Chris AtLee
1bf8f78b18 Add --list-hosts to man pages.
Fixes #9574
2015-02-27 08:38:45 -05:00
Brian Coca
f734306c13 Merge pull request #9859 from autotune/devel
Added description for -S flag and --ask-su-pass #9846
2015-02-26 22:51:35 -05:00
Giovanni Tirloni
bcbf819a8b Add how to load extra variables directly from a file (using @). 2015-02-12 21:31:56 -05:00
mixpix3ls
8866378e89 Fixing ticket 9845: man pages contain duplicate AUTHOR section 2015-02-08 22:04:18 -06:00
autotune
d052bf8276 Added description for -S flag and --ask-su-pass 2014-12-18 16:42:57 -06:00
Toshio Kuratomi
fa51e8f36d Document the --offline parameter to galaxy init
Fixes #9758
2014-12-09 10:50:10 -08:00
Michael Scherer
9c10a11aea Fix the synopsis in ansible-pull man page. 2014-10-22 15:40:41 -04:00
Michael DeHaan
e43ae3c0f7 Update test strategies guide. 2014-05-26 08:12:39 -04: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
James Tanner
33eec0dc55 Fixes #6398 Add missing parameters to ansible-playbook manpage 2014-03-31 16:49:09 -04:00
James Cammarata
12c812f030 Adding a man page for ansible-vault
Fixes #6471
2014-03-17 10:02:54 -05:00
James Cammarata
ba4fbd2b66 Adding man page for ansible-galaxy
Partially resolves #6471
2014-03-16 14:00:50 -05:00
James Cammarata
6f405c8970 Updated footer date and adding in misc. file generated by earlier doc update 2014-02-12 16:14:41 -06:00
Maykel Moya
0b1320e48c Update doc, irc and mailing list information in manpages input 2014-02-12 16:02:33 +01:00
Maykel Moya
06beddfe68 Fix documentation url 2014-02-11 16:55:10 +01:00
Maykel Moya
0b44a3e54f Minor grammar fix in manpages 2014-02-11 16:50:10 +01:00
Michael DeHaan
388365b90a Add reference to Guru to sidebar. 2014-01-30 12:32:45 -05:00
Matthew Phipps
d78951e767 Add skip_tags to ansible-playbook man page 2014-01-27 18:03:10 -05:00
Michael DeHaan
0882eefdff Merge conflict 2014-01-03 11:06:32 -05:00
Michael DeHaan
2f811c40d7 Basic docsite formatting fixups 2014-01-02 17:36:52 -05:00
Michael DeHaan
fdb8505a5e Add ansible-pull's -o to the manpage. 2013-12-27 15:33:33 -05:00
Michael DeHaan
52b2cfedfc Add release history for 1.4.1 into 1.5 branch. 2013-11-27 18:41:07 -05:00
Michael DeHaan
f7c3975f21 Add version_added to all modules missing version_added information, the docs formatter will now
raise errors when omitted, updated changelog with new modules.
2013-11-18 18:55:49 -05:00
jctanner
2d9087b806 Merge pull request #4484 from mscherer/add_short_hostname
ansible-pull by default will look for local.yml and $fqdn.yml.
2013-11-14 05:32:47 -08:00
jctanner
127efdf3ef Merge pull request #4576 from mscherer/pull_temporary_dir_2
add a default value for the -d option of ansible-pull
2013-11-05 14:47:09 -08: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
Ray
a66f0462cd minor correction
--remote-user= does not work:
 ansible: error: no such option: --remote-user

--user= does. Updating docs
2013-10-31 17:56:52 -05:00
Michael DeHaan
ad5731b4a8 Add module utils path to setup.py 2013-10-26 15:00:59 -04:00
Michael Scherer
f8b23e5721 add a default value for the -d option of ansible-pull
Thi permit to simplify the command line to use by using
a sensible default, and so reduce the number of incorrect
possible choices and setup needed. Among potential
incorrect choices is using a fixed directory in /tmp, which
could be problematic with a setup whose access is not
properly restricted.
2013-10-18 02:05:41 +02:00
Michael Scherer
92147aff0f also fix the doc, forgot in last commit 2013-10-13 15:34:56 +02:00
James Cammarata
97e3e967a7 Merge branch 'devel' of https://github.com/jflorian/ansible into jflorian-devel 2013-09-20 22:01:50 -05:00
James Cammarata
8283183023 Adding sshpass as packaging requirement and fixing VERSION 2013-09-13 17:39:14 -05:00
John Florian
c8a5aabf39 Added -f/--force option to ansible-pull 2013-09-03 16:39:19 -04:00
Stephen Fromm
77b8ee1f84 Update ansible-pull man page doc (issue #3372) 2013-08-20 13:43:26 -05:00
Michael DeHaan
f0d7324e25 Merge pull request #3094 from sfromm/issue2464-redux
Updates to ansible-pull and ansible-pull docs
2013-06-03 09:01:39 -07:00
Michael DeHaan
4ae3ef8af9 Disable inventory test 2013-06-03 11:52:42 -04:00
Stephen Fromm
a611027329 Update ansible-pull documentation 2013-06-01 21:44:52 -07:00
Michael DeHaan
b19609b98b Slight docs tweak 2013-05-31 16:05:07 -04:00
Michael DeHaan
0837c9785f Merge pull request #3040 from bfabio/devel
Support JSON in --extra-vars.
2013-05-31 13:06:05 -07:00
Michael DeHaan
267b29cec7 Manpage tweaks, docs rebuild 2013-05-29 10:30:04 -04: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
22b0cf9275 use the same text for -M in ansible.1 and ansible-playbook.1 2013-05-23 21:34:33 +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
Michael DeHaan
aa4ad80bda Update release version. 2013-04-02 20:48:30 -04: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
Oscar Korz
ba807ed5a8 Correct -u description in ansible man page 2013-02-09 19:24:53 -08:00
Michael DeHaan
318e3302fb Fix up some version related things on the devel branch. 2013-02-01 21:38:21 -05:00
Michael DeHaan
70bb7d1e54 Merge pull request #1696 from gregorg/enhance_limit
Allow regex to be used to select hosts in addition to fnmatch pattern
2012-12-12 14:51:44 -08:00
Gregory Duchatelet
ba4f71db27 Moved docs about "--limit=~REGEX" from man page to asciidoc. 2012-12-04 21:08:29 +01:00
Gregory Duchatelet
8bc1b69c58 Add a unit test to subset limiting via a regex, and some doc in man
page.
2012-12-02 10:18:58 +01:00
Jan-Piet Mens
17f31a2a79 CLI: ansible-doc shows lists of modules & module docs on command-line
check path is directory
added manpage & setup
small cleanup
shut up module_formatter in utils to avoid trace print on crud files in library
2012-11-30 21:57:25 -05:00
Michael DeHaan
6a5df97393 Manpage documentation ALSO should be sorted 2012-11-03 18:54:38 -04: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
5bdc16338e Release version bump for 0.9 (development branch) 2012-10-19 21:01:57 -04:00
Michael DeHaan
aa98c84a62 HP and vsphere modules are crazy awesome but I am thinking these belong in contrib not core. 2012-10-12 17:49:48 -04:00
Michael DeHaan
70ed560fb3 Add FILES to manpage 2012-10-12 17:37:30 -04:00
Michael DeHaan
6d2f003ceb Update formatter to not include orange blocks all over docsite page 2012-10-10 21:25:19 -04:00
Michael DeHaan
dbeb26ad6d Don't check in modules.js either 2012-10-10 18:41:50 -04:00
Michael DeHaan
fc9a6bb07c Docs/json should not be checked in 2012-10-10 18:41:50 -04:00
Marco Vito Moscaritolo
ee679c0190 Unified document generator and make to generate JSON and JS files 2012-10-10 18:41:50 -04:00
Tim Bielawa
9541b47b52 Keep the man3 directory. 'make docs' breaks without it. 2012-10-08 12:28:20 -04:00
Michael DeHaan
343e07a31a chapter 3 manpage source does not belong in git because it includes datestamps that constantly change. Willing to re-add if datestamps
are removable.
2012-10-08 08:10:37 -04:00
Michael DeHaan
4a95194424 Docs rebuild in new project structure. 2012-10-08 08:09:27 -04:00
Jan-Piet Mens
a9dad7f3bd remove duplicate private-key option from manpage 2012-10-05 09:18:19 +02:00
Michael DeHaan
761330b125 Fix module formatter indexing 2012-10-03 23:31:50 -04:00
Tim Bielawa
85fb7c6d4b Library functions and modules should be in the 3 man page section. Also the files should end in '.3' 2012-10-03 10:18:55 -04:00
Michael DeHaan
53d24ef002 Check in generated manpage documentation from modules 2012-10-02 22:46:49 -04:00
Michael DeHaan
31a4fe412f Complain when modules do not have documentation. 2012-09-30 21:10:07 -04:00
Jan-Piet Mens
d47e15a1f2 module_formatter in hacking/ 2012-09-26 20:41:44 +02:00
Michael DeHaan
975c323e39 Release version bump 2012-09-06 18:56:38 -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 #841
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
6ea022de01 docs build 2012-08-06 19:57:23 -04:00
Michael DeHaan
8fa4dc3920 Small change to previous patch, make ranges of hosts inclusive. 2012-07-24 20:10:05 -04:00
Chin Fang
e3b2521f01 Added a host expansion feature to ansible's inventory parsing 2012-07-24 12:38:52 -07:00
Michael DeHaan
a490213d45 Release bump to start development on 0.6 2012-07-04 18:07:19 -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
da3816d370 Move version files to 0.5 for devel branch 2012-05-25 16:43:16 -04:00
Michael DeHaan
8e8cde3a2c override hosts gone 2012-05-07 23:18:06 -04:00
Michael DeHaan
eda2333b24 Update manpage to mention -U (--sudo-user). 2012-05-06 18:32:43 -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
Tim Bielawa
2d26d1fd71 Update %description and auto-add version to manpages
Conflicts:

	docs/man/man1/ansible-playbook.1
	docs/man/man1/ansible.1

Update %description
2012-04-17 10:31:34 -04:00
Michael DeHaan
9ce27be878 Remove extra_vars tests 2012-04-16 23:03:04 -04:00
Michael DeHaan
b24ec71ca3 Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook 2012-04-16 22:22:37 -04:00
Michael DeHaan
579bd1d417 manpage updates 2012-04-13 19:40:40 -04:00
Michael DeHaan
c3cad50075 Update manpages, fix missing variable assignment 2012-04-13 19:33:19 -04:00
Stephen Fromm
b506567c37 Update ansible.1 manpage for option -c, --connection 2012-04-11 09:32:29 -07:00
John Eckersberg
5aad4bacc7 Bump release to 0.0.2 2012-04-03 09:51:05 -04:00
Tim Bielawa
446ba1795a Show when options require arguments in the man pages. 2012-03-23 22:29:51 -04:00
Michael DeHaan
f1c8fc63cb host file must be marked config(noreplace), update rpm build to use checked in manpage src 2012-03-31 11:08:42 -04:00
Michael DeHaan
9049b0e7ca Because folks on RHEL 6 (not CentOS 6) have some issues with asciidoc, do not build the asciidoc from
the rpm or make install targets.  Also modify the make install (only) to copy over files into the library
directory since the setup.py does not do this (due to a distutils bug, more or less).
2012-03-15 20:21:10 -04:00
Michael DeHaan
ee69bd18cc Add -T to playbook manpage 2012-03-13 21:54:42 -04:00
Michael DeHaan
6660a5efbd add polling info to manpage 2012-03-11 21:09:44 -04:00
Tim Bielawa
3f245498c4 Fixup RPM building: Makefile, Spec File, .gitignore
Fixup distutils: setup.py

Clean old cruft: section 5 man pages
2012-03-10 14:22:11 -05:00
Michael DeHaan
209760f8f6 Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 2012-03-09 22:06:44 -05:00
Michael DeHaan
742258a078 Drop other man(5) pages so we can have only one source of docs -- ansible.github.com for those operations.
Easier to maintain and much more verbose.
2012-03-08 13:56:27 -05:00
Michael DeHaan
fb3bfa1c51 Tweak the matrix 2012-03-05 21:38:12 -05:00
Michael DeHaan
9c5341116b Update to comparison matrix 2012-03-05 21:35:00 -05:00
Michael DeHaan
ee6db0531b Attempt at adding more comparison info 2012-03-05 21:16:55 -05:00
Michael DeHaan
937de08794 HTML test 2012-03-05 21:09:13 -05:00
Michael DeHaan
06d3cc930d This was supposed to be markdown with embedded HTML 2012-03-05 21:08:25 -05:00
Michael DeHaan
077e4f2381 Added start of comparison table so it's easy to explain at a glance what this project is. 2012-03-05 21:07:36 -05:00
Tim Bielawa
f2c2786a14 Update constants.py to pull module path and the hosts file from the
environment (ANSIBLE_{LIBRARY,HOSTS}) if defined.

Update manpages to represent this.

Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}.
2012-03-05 16:08:36 -05:00
Tim Bielawa
6343aa6214 Add environment updating script 'env-setup' to facilitate running ansible from a git checkout. 2012-03-05 13:47:01 -05:00
Tim Bielawa
e9ae5eb9d5 Correct see-also in playbook manpage 2012-03-04 23:08:29 -05:00
Michael DeHaan
269a6d46d6 attempt to explain import syntax in ansible-playbook manpage. Can't include
examples inline because github won't display them well, want to move this
file to markdown soon.
2012-03-03 14:13:31 -05:00
Michael DeHaan
847846af0e -p has been replaced by a required option. Various docs changes. 2012-03-01 22:10:47 -05:00
Michael DeHaan
4ce1f1dd5e README/doc/example updates to go with group support and CLI option changes.
Minimizing manpage until CLI options stabilize.
2012-03-01 21:18:32 -05:00
Michael DeHaan
55d256d82a Added solution to avoid checking in manpages. Just run "make" and we'll build
docs before python setup.py.   Seems reasonable to let Makefile drive
2012-02-28 04:15:52 -05:00
Michael DeHaan
d8b5e667d8 Doc rebuild 2012-02-28 03:05:29 -05:00
Michael DeHaan
442c2488ba Minor playbook doc updates 2012-02-28 22:10:58 -05:00
Michael DeHaan
d0906e187f Correct file location error in example 2012-02-28 02:52:14 -05:00
Michael DeHaan
058fa5bd15 Manpage and doc updates 2012-02-28 02:51:19 -05:00
Michael DeHaan
6fcce9a97e rebuild manpage due to license change 2012-02-28 01:25:00 -05:00
Michael DeHaan
be4cb64c92 Relicensing to GPLv3, all previous committers ok'd on mailing list. 2012-02-28 19:08:09 -05:00
Michael DeHaan
c0b4c80ba1 Docs rebuild 2012-02-27 23:54:32 -05:00
Michael DeHaan
783d3642a8 ok, giving up, github does not render asciidoc well at all.
Is there something we can use to generate manpages from markdown?
2012-02-27 23:48:40 -05:00
Michael DeHaan
28afd7208e Try once more. 2012-02-27 23:47:10 -05:00
Michael DeHaan
03bf465c3a attempt to fix asciidoc so it shows up on github 2012-02-27 23:42:15 -05:00
Michael DeHaan
f3246fb72e Remove 'pending' comment. 2012-02-27 23:39:47 -05:00
Michael DeHaan
4201865bba Add note about facter/ohai integration into module docs. 2012-02-27 23:18:53 -05:00
Michael DeHaan
e766bb6a6c update manpage output 2012-02-27 22:49:14 -05:00
Michael DeHaan
155c3ca89e update playbook docs with updated syntax / minor edits 2012-02-27 22:48:45 -05:00
Michael DeHaan
2860c14bc2 module doc updates 2012-02-27 22:43:08 -05:00
Michael DeHaan
ba4e36a9a9 Rename 'ensure' to 'state' because I think it's a bit cleaner and doesn't imply
all modules take a common parameter name.  But more or less we still work idempotently
in modules.
2012-02-26 22:31:42 -05:00
Tim Bielawa
6612772711 Update man pages. Fix formatting in playbook example. Also, YAML documents by definition start with '---', so I have added this to the example and the manpage 2012-02-26 21:09:56 -05:00
Tim Bielawa
afc7f4d246 This is configuration, not command. Rename to section 5 2012-02-26 21:03:55 -05:00
Tim Bielawa
9680de37c9 Manpages formatting 2012-02-26 21:03:18 -05:00
Tim Bielawa
b4fd0042f6 Fix up some wording/formatting in ansible-modyles.5. Also: Section 5 is for configuration, update the see-also to reflect this with respect to ansible-playbook. 2012-02-26 21:01:04 -05:00
Tim Bielawa
86bf871e07 Fixup the naming of the docs. 2012-02-26 21:01:04 -05:00
Michael DeHaan
136d8fa33a add manpage crossreferences 2012-02-26 20:48:10 -05:00
Michael DeHaan
2262705ea3 Added stub for ansible-playbook (format) docs. Docs on ansible-playbook script TBD once
written.
2012-02-26 20:47:22 -05:00
Michael DeHaan
17a6ddb7ee Lining up with the reversion of 70ec508ee0, also
check the ansible-module file back in.  This is basically to make things easier
to build from setup.py.
2012-02-26 20:01:31 -05:00
Michael DeHaan
4e5da11217 Revert "don't check in manpage output file"
This reverts commit 70ec508ee0.
2012-02-26 20:00:46 -05:00
Michael DeHaan
226da501d3 Take notes about other modules that are in plan. 2012-02-26 19:29:56 -05:00
Michael DeHaan
e5f62f20b1 make copy & template module take key/value parameters so we're consistent. Only the command
module works differently now

starter manpage for modules

allow template file location to be passed into template & setup modules
2012-02-26 19:21:44 -05:00
Michael DeHaan
77a7ddeebc Add start of documentation for modules 2012-02-26 18:52:42 -05:00
Michael DeHaan
70ec508ee0 don't check in manpage output file 2012-02-25 17:19:12 -05:00
Tim Bielawa
f0b0211772 Because everything should have a man page 2012-02-24 20:07:49 -05:00