Commit Graph

1524 Commits (4096d74245bae5f0828b4129c8a44154235195bf)

Author SHA1 Message Date
Victor Martinez 4faf4ff215 Fixed typo (#32450) 7 years ago
Brian Coca 41685fb516 fix precedence issue with facts and vars (#32302)
avoid making gathered facts high precedence, only set_fact is supposed to be.
vars set via set_fact with cacheable are higher precedence than plain facts.

Previously (after 6fbd0a8bb5) regular facts would end up with a
higher precedence than host or play vars, but they should not be. Facts were getting added to 'non_persistent_facts' (equivalent to 'register' vars) which is higher precedence than facts should be.

added 'cacheable set_facts' to precedence docs

'ansible_facts_cacheable' ->  '_ansible_facts_cacheable' (made 'private')
7 years ago
Toshio Kuratomi 42655f737a
Clarify the release and maintenance cycle (#32402)
* Clarify the release and maintenance cycle
* Namespace refs a little
* Fix an unrelated problem with plugin return docs to fix docs build
7 years ago
irsl b456e637e0 become-user example was incorrect
Example was incorrect:
--become-user doesn't imply --become (http://docs.ansible.com/ansible/latest/become.html)
7 years ago
Ed Santiago 47fb002c88 (minor) fix broken link, awkward phrasing (#32085)
* (minor) fix broken link, awkward phrasing

Simple transposition error was resulting in a link not
being properly htmlified.

Also clean up redundant 'this' and trailing whitespace.

Signed-off-by: Ed Santiago <santiago@redhat.com>

* Edits
7 years ago
Greg DeKoenigsberg 80031720d1 Deprecate old community guide (#32266)
For anywhere we still have links, we want to deprecate this page and point them to the right new page.
7 years ago
Greg DeKoenigsberg c5b4d53c09 Update index.rst to point to new community guide (#32263)
We made this change a couple of months ago, deprecating community.html in favor of community/index.html and its full guide, but the change was never made here in the index.
7 years ago
Aaron Huslage 01af68911f Change 'connection' to 'inventory' in description
Fixing a copy/paste typo.
7 years ago
Toshio Kuratomi cf2c22770a Update release and maint for new release 7 years ago
John R Barker 1d86205933 Correct formatting --arguments (#31808)
* Correct formatting

* Use RST :option:

* ansible-pull --vault-password-file

* Streamlined the language a bit in the intro.

* Exclamation point removal!
7 years ago
Matt Clay 36b13e3e3d Fix ansible-test default image. (#31966)
* Add openssh-client to default docker container.
* Include Azure requirements in default container.

To do so, handling of pip requirements was updated to install each
set of requirements separately and then run a verification pass to
make sure there are no conflicts between requirements.

* Add missing --docker-no-pull option.
* Add documentation for the azure-requirements test.
7 years ago
mikedlr fbbffbabde Mdd module unit test docs (#31373)
* new documentation for unit testing - especially module unit testing

* unit test documentation reformatting and further fixes

* unit test documentation - point to online coverage reports & fix bad spaces

* Small copy edits.

* First pass copy edit / rewrite. More info needed.

* testing documentation - clean up structure, especially code coverage - reduce repetition

* module unit test documentation - improved introduction

* testing documentation - more fixes from and inspired by review from dharmabumstead

* testing documentation - fixes from mattclay + some other minor tweaks

* More copy edits.

* testing documentation - further fixes from review

* Copy edits

* Copy edits

* More copy edits.
7 years ago
Dan Bohea be3f911ce3 Typo on "Prompts" page (#31882) 7 years ago
Dag Wieers 3182a878b5 Fix small typo 7 years ago
Jordan Borean 836677522d fixed up code-block for powershell block 7 years ago
Abhijit Menon-Sen a84545dc33 Fix typo 7 years ago
Gregory M. Dulin 29a5938fb1 Update --extra-vars documentation. Fixes #11647 (#31433)
* Update --extra-vars documentation to address #11647

* Fix some grammar

* Fix indentation

* Reshuffle and add versionadded tags

* Remove code-block tags

* Add lf after versionadded lines
7 years ago
wxdao 8a86746223 Fix typo in playbooks_error_handling (#31636) 7 years ago
Jordan Borean f2fed10ad8 update Windows docs (#30783)
* first round of splitting and expanding Windows docs

* Added info about WinRM and started the usage page

* more details onf usage around command/shell

* added more info

* missed a page

* added info about hotfix and ps upgrade script

* Added DSC information

* filled in FAQ and fixed up links

* changes per PR review and typo fixes found by myself

* fixed sanity check

* updated external script URLS

* Edits

* Edits

* Edits

* Copy edits.

* More copy edits.

* Added info about becoming a local service account

* some formatting changes on become and DSC indent fix

* Copy edits/rewrites

* Copy edits/rewrites

* minor updates to UAC text, typos

* minor wording updates

* minor wording tweaks/typos

* minor wording tweaks/typos

* minor tweaks/typos

* fix indent issue

* fix title underline length

* fix quote issue
7 years ago
Peter Weldon 94a558887a Fix typo in command output of encrypt_string example. (#31601) 7 years ago
Tim Rupp 20e546258d Adds new committer to Ansible core (#31544)
This is me (Tim) signing and agreeing to the committer guidelines.
7 years ago
Brian Candler 6f9e2b9a63 Add ellipsis to indicate YAML example is excerpt, not standalone 7 years ago
Brian Coca 2ed46e04f4 more updates to plugin/config generation (#30787)
* fixed module generation

added missing lookup page
point to plugins when plugins
made modules singular
add display for verbose an debug messages
nicer templating, changed generation order for ref
corrected links
moved most of lookup docs to plugin section

* Copy edits
* Fixed typos
* Clarified wording
7 years ago
Brian Coca d84df2405d move from with_<lookup>: to loop:
- old functionality is still available direct lookup use, the following are equivalent

  with_nested: [[1,2,3], ['a','b','c']]

  loop: "{{lookup('nested', [1,2,3], ['a','b','c'])}}"

- avoid squashing with 'loop:'
- fixed test to use new intenal attributes
- removed most of 'lookup docs' as these now reside in the plugins
7 years ago
Toshio Kuratomi c81314dcb9 Add a hack to test whether type=path should be used in a module 7 years ago
Brian Coca dc69af50dc clarified inventory_dir changes for 2.4 (#31484)
* clarified inventory_dir changes for 2.4

added example on how to restore (mostly) old behaviour for add_hosts

fixes #30901
7 years ago
Brian Coca 7d49b27218 added toggle to control vars plugin behviour
this should allow user to control how they want the playbook dirs inspected
for additional vars, default now reverts to 2.3 behaviour (top).
corrected paths order
minor doc reword
7 years ago
Richlv 1037c211d9 Update playbooks_lookups.rst
fix doublequote being used in place of the colon
7 years ago
Lindsay Hill 146f90e16b Fixed RST hyperlink issues (#31394) 7 years ago
sduthil 15dffe04dd fix misformatted docsite link (#31384)
reason: The link is showing verbatim in the docs, where it should only
show "knowledge base article".

Also, generating the docs shows a lot of:

docs/docsite/rst/win_acl_module.rst:424: WARNING: Unknown target name: "know ledge base article<https://access.redhat.com/articles/rhel-top-support-policies>".
7 years ago
John R Barker b79d15e67f Improve and link Network Proxy docs (#31316)
* Improve and link Network Proxy docs

It is possible for proxy issues to cause "unable to open shell", so
detail there.

Having the "how-to" in the debug page makes more sense than on the
porting page, so move it.

Fixed a few formatting issues at the same time.

* Edits

* typo
7 years ago
Brian Coca 5085c3b859 made note about cwd not working for hostlist anymore (#31258)
* made note about cwd not working for hostlist anymore

fixes #31041

* Edits
7 years ago
Jorgen c41f781e1d Make YUM repo URL clickable again (#31264)
Make YUM repo URL clickable again
7 years ago
Andreas Olsson ba0b91b51b Remove git:// urls from docsite and from packaging (#30459)
It's almost always preferable to clone by way of https:// rather than
using the bare git:// protocol. Not only does https:// provide
stronger guarantees it also plays nicer with corporate proxies, etc.
7 years ago
Michihito Shigemura a71ca66e6e Fix typo in dev_guide/testing 7 years ago
Michihito Shigemura 78fd326908 Fix typo in dev_guide/developing_program_flow_modules 7 years ago
Dylan Silva 614a2b403e fixed url issue for rpm location (#31164)
Thanks @thaumos!
7 years ago
Michihito Shigemura d0d1c7d249 Fix typo in dev_guide/developing_plugins (#31142) 7 years ago
Michihito Shigemura 221c01ff49 Fix typo in dev_guide/developing_modules_general (#31122) 7 years ago
Michihito Shigemura b7b8c669a3 Fix typo in dev_guide/developing_modules_documenting (#31120) 7 years ago
Daniel Linder 90dd698b86 Example of idempotent (pseudo-)random() usage. (#31048)
Add note to use idempotent random() seed based on inventory_hostname.
7 years ago
Luke Short c6a676c025 correct the Python 3 Pip environment setup instructions (#30988) 7 years ago
tom-clx 04bfbb14d6 Update playbooks_blocks.rst (#24069)
* Update playbooks_blocks.rst

The rescue section documentation should be clear that successful completion of a rescue section will override other error handling behavior.

* more precise rescue docs

explains in detail the consequences of successful rescue
7 years ago
Dag Wieers e63d949951 Add a blank line, and use the Copyright format as used during rewrite
So there is a discrepancy between the dev guide and what has been changed on disk by toshio.
Not a big deal, but needlessly confusing.
7 years ago
Brian Coca cd5cadfe69 added note about inventory_dir new behaviour (#30865)
* added note about inventory_dir new behaviour
7 years ago
Michihito Shigemura b3cee37dc1 Update links in style_guide/trademarks (#30809) 7 years ago
Brian Coca 17f094bb6a corrected import_play into to import_playbook (#30853)
* corrected import_play into to import_playbook

fixes #30744
7 years ago
Matt Martz d40eff720c Update API example for 2.4 7 years ago
scottb 6c732bb670 Plugin doc update edits for #30490 (#30889)
* Edit pass 1 for #30490 - command line tools and developing plugins.

* Continuing edit pass for #30490. WIP

* Last round of copy edits for #30490.
7 years ago
cclauss 25e17b4035 Clearify that Python 3 support is still a tech preview (#30789)
setup.py does not contain any Python 3 trove classifiers.
7 years ago
Michihito Shigemura b3177383da Fix typo in docs spelling_word_choice (#30785)
shocked that someone else spells the correst way, like me
7 years ago
Brian Coca 8d56064ce4 fixed typo in if, restore module docs 7 years ago
Michihito Shigemura 303d622dcb Refactor doc resources in style_guide (#30794)
- Change links from http to https
- Correct or remove dead links
7 years ago
Brian Coca b233f3f296 updated plugin docs (#30490)
* updated  docs

- for devs:
  - added inventory/vars section
  - made some updates to general section and other plugin types
- for users:
 - added 'user' plugin section to start describing the plugins
 - docs on types, what they are and how to use

- removed ref to deleted AUTHORS file
- corrected several typos/headers
- added descriptions to config.rst template
- ignore generated files for cli/plugins and config
- remove new generated files on `make clean`
- moved details from devguid and intro doc to plugin specific pages
- pretied up lookup notes
- changed precedence ref to not conflict config
- removed duplicate config data, as config is autogenerated and up to date
- put new plugins under playbooks
- added `pass` cause rst/python dislikes fractions
- removed dupe in .gitignore, alpha sorted to avoid moar dupes
- added try cause rst/python freaks out

* generate plugins into their own dir

only do plugins that support docs
use toctree from main plugins page
7 years ago
Matt Bruzek aaaf88908d Adding a section to the FAQ about array notation. (#30782)
* Adding a section to the FAQ about array notation.

* Fixing spelling of jinja and Celsius.

* Adding an example that uses dots.
7 years ago
Michihito Shigemura b5546328dc Fix typo in docs grammar_punctuation (#30718) 7 years ago
David Moreau Simard f8230d961d Link to all the porting guides instead of just the 2.0 one (#30671) 7 years ago
jborean93 0e22afef52 fix for make webdocs 7 years ago
Dag Wieers 31e7d735a3 win_environment: Make this the Windows reference module
As discussed before we selected win_environment to the documentation,
and point to win_uri for a more advanced module.

If we want to make this the reference module, we have to get this one
absolutely right in every possible way.

This PR cleans up both win_environment and win_uri, and makes the
required changes to the windows module development section.
7 years ago
Brian Coca 5220f30244 decelerate docs! 7 years ago
Dylan Silva 2f67dd1e0f Updated release table for docs (#30649)
- Updated table to reflect release of 2.4
- Added in 2.5 as current devel
7 years ago
Brian Coca a030472092 More porting updates (#30635)
* Update porting_guide_2.4.rst with more docs and some rst fixes
7 years ago
Monty Taylor 700a032bf1 Add an example of complex return argument (#28610) 7 years ago
Brian Coca 22c8522cbf added missing feature info (#30560)
* added missing feature info

mostly config related

* Copy edit

* Copy edit

* Copy edit. Clarified warning.
7 years ago
Austin S. Hemmelgarn d5ae9d1018 Fix build on Python 3.x by using sys.maxsize. (#30424)
As outlined in https://docs.python.org/3.1/whatsnew/3.0.html#integers,
sys.maxint doesn't exist anymore in Python 3.x because there is no maximum
value for integers in Python 3.x.  sys.maxsize is present in all
versions of Python that are currently supported by Ansible, so use that
instead as an arbitrarily large index value.

Fixes the following build error when building with Python 3.x:
make -j1 docs
mkdir -p ./docs/man/man1/ ; \
PYTHONPATH=./lib docs/bin/generate_man.py --template-file=docs/templates/man.j2 --output-dir=docs/man/man1/ --output-format man lib/ansible/cli/*.py
Traceback (most recent call last):
  File "docs/bin/generate_man.py", line 253, in <module>
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "docs/bin/generate_man.py", line 119, in opts_docs
    'long_desc': trim_docstring(cli.__doc__),
  File "docs/bin/generate_man.py", line 34, in trim_docstring
    indent = sys.maxint
AttributeError: module 'sys' has no attribute 'maxint'
make: *** [Makefile:347: generate_asciidoc] Error 1
7 years ago
Adrian Likins da15cf1f54 Generate plugin rst (#28901)
Generate rst docs for plugins 

Based on rst generated for modules. But generated plugin
docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst
( docs/docsite/rst/plugins/connection/ssh.py for ex)

* move plugins docs to rst/*_plugins/ subdirs for namespace
* Only gen support pages for modules for now.
* Add generated plugin docs to gitignore* add list_*_plugins templates
* support MODULES/PLUGINS filters for make htmldocs

   Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for.

* fixup 'historical' version_added, skip plugins/loader.py
* Fix plugins_by_support ref link to new plugins/*/ location
* use :ref: for common_return_values, allow empty version_added
* warnings on missing doc info
* add a prefix to _random_choice
  It was colliding with the target for random_choice plugin
7 years ago
Toshio Kuratomi c82cf791dd Add a code-smell test for smart quotes and remove smart quotes from all files 7 years ago
Brian Coca 1062f52f4c cleanup generated CLI rst 7 years ago
John R Barker 5a256dd1c0 porting_guide_2.4 stub entries (#30456)
Addtions to porting_guide_2.4

* deprecated notice for win_package return values
* Added vars plugins, config api, inventory plugins.  These were mostly backwards compatible.
  Added notes for users and devs to check out new features once i write the 'feature docs' I'll
  come back and link to them from here
7 years ago
Adrian Sadłocha 22f3898412 Fix a typo in docs 7 years ago
James Cammarata 366a9d861f Cleaning up use of include: in docs (#30466)
* Cleaning up use of include: in docs

Switching to import_*/include_* instead.

* Update playbooks_best_practices.rst

* Fix rst syntax
7 years ago
John R Barker 785e604c57 Porting Guides 2.4 (#24539)
* Porting Guides for Ansible Versions

Improve the user facing documentation.
Tell people what changes they need to make

* More porting guides

* Link porting guides from TOC

* Link porting guides from CHANGELOG.md

* typo in link

* Review feedback

* Better CHANGELOG links

* Better links

* code blocks

* Minor changes

* Correct links, comment out network section in 2.4

* Typos

* Revert non 2.4 changes

* Add placeholders for other items

* multiple inventory

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* add win_command/win_shell escaping notes

* Added some windows porting info

* Edit for grammar

* Correct links, delete Net Platform Agnostic

* 2.5 link

* Network changes in 2.4

* facts_namespacing was pushed back to 2.5

Due to lack of time we pushed this back to 2.5 so that the facts in the namespace could be shortened.

* Python version

* Remove FIXMEs - move to seperate PR
7 years ago
Ganesh Nalawade 11310b8c4a Update removed_in_version to 2.9 for network module top level cred args (#30416)
* Update removed_in_version to 2.9 for network module top level credential args

* Add documentation
7 years ago
Toshio Kuratomi 8a2f069468 Document boolean default value treatment (#30062)
* Consistency and document treatment of default bool values

* Document that default bool values can be any Ansible recognized bool.
  choose the one that reads better in context
* For fragments used by the copy module, make bool types use type=bool and not choices

* Edit for clarity
7 years ago
Adrian Likins dfc0084f01 rename dev..general_OLD.rst to ._rst (#30291)
So we don't try to build the rst, since it causes
lots of warnings to be shown and doesn't render correctly.
7 years ago
Adrian Likins 9cc63326b1 Misc docsite fixes (#30290)
* Fix refs for local_facts and various cli :option:
* Fix dev_guide/testing_pep8 refs
* remove ref to non-existing 'developing_test_pr'
* Fix ref to ansible-vault encrypt_string
* Removed hard-to-localize colloquialism.
* Rename '_ansible-pull' in playbooks_intro.

It was conflicting with rst/ansible-pull.rst. Nothing
seems to reference it.

* Add explicit targets for and update refs

Replace some ':doc:' use with ':ref:'.

Replace some :ref: to section names with explicit targets
(:doc:`Dynamic vs. Static` -> :ref:`dynamic_vs_static` etc)

* The 'YAML+Jinja' syntax lex fails here, so just use yaml

Since the yaml+jinja highlight fails, code wasnt highlighted
at all, but 'yaml' works more or less.

* just use no lexer for the < python2.6 examples

py3 will fail highlighting them, and 'python2' throws
a lexer warning, and nothing actually highlights it, so
just disable.
7 years ago
Aren 60d9a12efd swapped out key-value pairs for multi-line YML (#30277) 7 years ago
John Patrick fc5b74fad2 fix broken rpm link (#29667) 7 years ago
John R Barker ac6205b9e8 porting_guide_2.5.rst stub (#30311) 7 years ago
Adrian Likins 633263d535 add htmlsingle target (#30287)
For whatever reason, building the 'singlehtml' version of
the docs is much much faster than building the normal html
version.
7 years ago
Matt Clay df941df01d Remove references to obsolete PR Mover. (#30298) 7 years ago
Ganesh Nalawade 530988666a Allow delegate_to if transport is not cli (#29945)
Fixes #29060

Allow delegate_to if transport is either nxapi or eapi.

Persistent connection uses `cli` transport and create
a local socket on control node. Hence delegate_to is not allowed
for `cli` transport.

However as `nxapi` and `eapi` transport does not use persistent connection
it is possible to use delegate_to in this case.
7 years ago
Dylan Silva 88aa0b7645 Fix bugs with modules_support.rst 7 years ago
Toshio Kuratomi ff13d58c14 Remove use of unicode_literals as it is an anti-pattern
from __future__ unicode_literals leads to developer confusion as
developers no longer can tell whether a bare literal string is a byte
string or a unicode string.  Explicit marking as u"" or b"" is the way
to solve the same problem in the Ansbile codebase.
7 years ago
Abhijeet Kasurde 8f6626bd8f Misc typo corrections
Fix adds correction for typos

* Anisble to Ansible
* Fasle to False

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Cheng Lian 4c229e566e Fix minor formatting issue in python_3_support.rst (#29161)
Thanks @liancheng!
7 years ago
Luke Short 897f86561f document the required variables for using Windows certificates (#29112)
* document the required variables for using certificates when authenticating to Windows

* clarify that certificates are for local (non-domain) users
7 years ago
Will Thames c749ecbd94 Add ansible-inventory-grapher to the list of tools (#29068)
* Add ansible-inventory-grapher to the list of tools

* Fixed minor typo.
7 years ago
jhawkesworth 3d5320adad fix typo in new jsonquery filter example that uses backticks (#29082) 7 years ago
Adrian Likins 52f2edf19d change generated playbooks_keywords.rst to use an rst 'glossary' (#28843)
* Use a rst glossary for playbooks_keywords docs
* Add a 'Task' and 'Tasks' to glossary.
* Update keywords desciptions,
* use :term: rst ref, some quoting
* Make it more obvious that 'retries' and 'until' need to be used in combination.
7 years ago
Adrian Likins 89c973445c generate rst doc pages for command line tools (#27530)
* let generate_man also gen rst pages for cli tools
* make template-file, output-dir, output format cli options for generate_man
* update main Makefile to use generate_man.py for docs (man pages and rst)
* update vault docs that use :option:
* Edits based on
6e34ea6242 and
a3afc78535

* add a optparse 'desc' to lib/ansible/cli/config.py 

  The man page needs a short desc for the 'NAME' field
  which it gets from the option parse 'desc' value.

  Fixes building ansible-config man page.

* add trim_docstring from pep257 to generate_man

  use pep258 docstring trim function to fix up any indention
  weirdness inherit to doc strings (ie, lines other than
  first line being indented.

* Add refs to cli command actions

To reference ansible-vaults --vault-id option, use:

:option:`The link text here <ansible-vault --vault-id>`

or:

:option:`--vault-id <ansible-vault --vault-id>`

To reference ansible-vault's 'encrypt' action, use:

:ref:`The link text here <ansible_vault_encrypt>`

or most of the time:

:ref:`ansible-vault encrypt <ansible_vault_encrypt>`
7 years ago
Brian Coca f4fff54f68 clarify import_ docs (#28395)
* clarify import_ docs

* fixed izpellz

* Copy edits.
7 years ago
Will Thames 0d69b63c01 Additional simpler json_query documentation (#24041)
Since json_query treats backticks as delimiters for literals,
some of the examples in the json_query docs can be made a little
simpler. Rather than replacing such examples, demonstrate the
alternative
7 years ago
Brian Coca c3550b58ed introducing ALSO YAML inventory (#28596)
* introducing ALSO YAML inventory

* Copy edits
7 years ago
Brian Coca 48da0597c0 document ansible_group_priority (#28777)
* document ansible_group_priority

* Copy edit pass
7 years ago
Matt Clay fe90866819 Fix rst syntax issue in docs. 7 years ago
Dylan Silva ecc1fbcc1d updated modules support page with new information (#29071)
* updated modules support page with new information

* Minor wording tweaks.
7 years ago
Sam Doran 02a362e7de Replace rst extension with html in message (#29022) 7 years ago
Eddie Peters ea74176a28 Fix small typos and extra whitespace in the docs (#24559) 7 years ago
Sam Doran f0a0b630f6 Properly format inline code. 7 years ago
Ian Wienand 35d02b28c9 Minor syntax error in block versionadded
The syntax for versionadded is to have the string as a second
argument.
7 years ago
Nicklas Laine Overgaard 859b5df1d4 Fix exported SSL_CERT_FILE variable (#28968)
The variable was pointing to a file with a `.cer` extension but the curl command downloads a `.pem` file which makes executions of the bash script fail
7 years ago
Pilou d67d202227 Fix typo: s/certfied/certified/ (#28951) 7 years ago
Toshio Kuratomi 13b2bedae6 Make python3 testing doc clearer for distro packaging users (#28948)
https://bugzilla.redhat.com/show_bug.cgi?id=1486612
7 years ago
Fran Fitzpatrick c51f2f835e Adds documentation for all the regex filters (#28944) 7 years ago
Matt Davis 59787a3dbc minor fixes to docsite root URLs (#28945)
* fix hardcoded http schemes to use relative URLs
* add doc fragment to version selector link to scroll target directly to the selector
7 years ago
Scott Butler a9f82f8a8a Fixed incorrect version numbers. 7 years ago
Scott Butler c479d37777 Changed header to say 'devel' instead of 2.4 7 years ago
Lars Kellogg-Stedman 7093622571 docs: add fact caching directives to intro_configuration (#27040)
the fact_caching* configuration directives were not listed in
intro_configuration.rst.
7 years ago
Ron V 8999b98a09 Update playbooks_best_practices.rst (#26714)
fix point of confusion for newer users
7 years ago
Sam Doran cc7e38890c Clarify how tag inheritance works (#28942)
Fixes #20119

Another crack at PR #27147
7 years ago
Adrian Likins 596dc8c442 Add ANSIBLE_CONFIG envvar to config/envvars tmpl (#28886) 7 years ago
Adrian Likins 933298505a Update places we mention env vars to use :envvar: (#28887) 7 years ago
Peter Sprygada ae2e84146e update network section for completed items (#28927) 7 years ago
Adrian Likins 28b9dc4bed Vault docs (#26979)
* start rst docs for ansible-vault encrypt_string

* wip, vault format docs

(sorta markdown ish atm)

* wip - formatting

* wip, vault docs

* Fix refs to other docs for now

fixing default_role in conf.py will remove need
for this

* add 'ref' to cli names

* more vault docs

* wip, misc fixes

* add some encrypt_string examples

* Fix up rstcheck warnings

The code blocks in question included the output that would
be echo'ed from running the command, which isnt valid bash.

* fix formatting and rstcheck warnings about code-block

* Add envvar ref for ANSIBLE_VAULT_PASSWORD_FILE

* fix doc title

* Fixed title underline
7 years ago
scottb b146e17733 Edit pass for relocated community documentation. (#28368)
* Edit pass for relocated community documentation.

* Updated info on Ansibullbot

Fixed improper link syntax
Change links to point to new documents
Changed Ansibot to Ansibullbot
Clarified workflow
Change formatting on commans and tags

* Update communication.rst

Add Contents
Use correct headings

* Update communication.rst

* Topics, remove whitespace, codeofconduct

* Formatting

* Correct heading

* Update maintainers.rst

* Minor edits and a request for more info

* Removed some hard-to-localize wording.

* Removed incomplete sentence

* Minor edits per review
7 years ago
Scott Butler c7c30c6760 Fixed wording. 7 years ago
Giovanni Sciortino d733f5af06 Add note in documentation and add warning related to retries parameter used without until (#28078) 7 years ago
Adrian Likins 8035e68d44 Generate a rst for config and env options from base.yml (#28739)
* wip, gen docs from config/base.yml

* wip

* dont change conf.py here

* cleanup, add dump_config --template-file cli opt

* some desc are string, some are lists...

TODO: fix base.yml so it is consistent

* Filter out TODO and empty descriptions
7 years ago
Sam Doran 80c00d3238 Create urlsplit filter (#28537)
* Improve tests for uri filter

* Create URL Split docs

* Add urlsplit filter

* Py3 compatibility

* Use helper method and eliminate query options

* Add options, cleanup output, fix tests

* Update docs

* Add parenthesis to boilerplate import

* Add debug task to tests

* Use exclude option to filter returned values

* Filter out additional option for Python 3
7 years ago
Matt Davis b3f2d1befe expose cloud_environment override in azure_rm modules (#28743)
* Can be set via env, credential profile, or module arg
* Valid values defined by Azure Python SDK, currently `AzureCloud`,`AzureChinaCloud`,`AzureUSGovernment`,`AzureGermanCloud` or any Azure Stack metadata discovery URL.
7 years ago
Chris Houseknecht d513c430de Updates community code of conduct email 7 years ago
Jason McKerr 9a2065fcf3 Update ROADMAP_2_4.rst 7 years ago
René Moser c97f4653be fix typos in various modules and docsite (#28747) 7 years ago
Jordan Borean 9b48c377b4 updated windows roadmap (#28740) 7 years ago
Reid Wahl ca91b361ce Fixes #28290: Added missing colon for paramiko host_key_auto_add line in network_debug_troubleshooting.rst (#28695) 7 years ago
Reid Wahl 3ca415f58c Fixes #21041: Add note to intro_inventory.rst that the Docker example is a playbook and not an inventory file (#28697) 7 years ago
Dag Wieers ccb6b39f45 Corrected RETURNS -> RETURN 7 years ago
Brian Coca 203d8d2e6e added diff keyword to changelog/docs 7 years ago
René Moser 6397e68bfd doc: replace play_hosts with ansible_play_batch (#28526) 7 years ago
Matt Clay 871bd24358 Fix documentation references. 7 years ago
Shane McDonald f108057f61 Bump version in docs layout (#28523) 7 years ago
Toshio Kuratomi 40ea448c7b Misc docs fixes
* Revise and link inline to the lists of modules

* Fix jinja2 objects.inv fallback path

* Fix bolding of deprecation marker

* Change module_support to link to lists via :doc:
  That links to the top of the page instead of a section.

* Add a short text for each list of maintained modules
* Change maintenance info to only display on core and network modules
7 years ago
Toshio Kuratomi 84ea2af4b6 Remove nonexistent special_interest-groups doc 7 years ago
Toshio Kuratomi 212499a489 On clean, remove the *_maintained.rst generated files 7 years ago
Jiri Tyr 5660b18b6a Adding missing period into the module doc template 7 years ago
David Kretch beed59f303 Fix trailing space in ec2_vol example, fix 'the the' typos (#28440)
* Fix 'the the' typos, fix 'pahting' filename typo

* Change 'the the' typos to a single 'the'.
* Change `playbook_pahting.rst` to `playbook_pathing.rst`.

* Delete trailing space in ec2_vol example

Delete the trailing space in `instance: "{{ item.id }} "`, which makes the
example fail when run because it looks for instance "i-xxxx ".
7 years ago
David Moreau Simard 022ce7efee Docs for multiple asynchronous tasks (#24457)
* Add docs on the behavior of with_items flattening and nested lists

* Add docs on limiting the amount of concurrent async tasks
7 years ago
Andreas Maier b900f4a3be Fixed return table in module docs generated by plugin_formatter.py (#25329) (#25330)
This change fixes two issues with the generated return table:

1. When specifying a list of strings in the 'description' field of a
   return value, it shows them in Python list syntax on the resulting
   web page, e.g. `['a', 'b', 'c']`.
2. When specifying more than one line for the 'sample' field, the
   result table gets damaged in the HTML output.

In addition, this change re-arranges the HTML tags produced in the
generated RST file such that they line up nicely and can better be
checked by humans for completeness.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
7 years ago
Adrian Likins 2941e86671 Fix plugin_formatter.py -l / MODULES=none make webdocs
Fix the get_module_info check against the limit_to_modules
list so building a subset/none of the module docs works again.
7 years ago
David Moreau-Simard e9d6d37589 Update release status for 2.3 to 2.3.2 7 years ago
Peter Sprygada 2e44d8913b update parse_cli documentation with more examples (#28258)
* update parse_cli documentation with more examples
7 years ago
Tom Paine 50d744c217 Update playbooks_filters.rst (#28271)
See #17266, password_hash has been updated to support passlib. The available hashes are listed on http://docs.ansible.com/ansible/latest/playbooks_prompts.html, but not here.
7 years ago
Sam Doran b7aa38c0d8 Minor fixes to Developer Docs (#28302)
* Grammar and formatting corrections

Indent JSON code example.
Double backticks for inline code examples.

* Remove trailing spaces

* CI fixes
7 years ago
Matt Clay b52aeeabfa Roadmap updates and docs fix. (#28287)
* Update on 2.4 roadmap progress.
* Fix docs syntax for Python 2.
7 years ago
Toshio Kuratomi 546187a8af Revamp the plugin_formatter doc generator
* Use a template to generate the category lists
* Refactor so that we first extract all of the data that we need to
  build the docs and then give that data to the templates to build with
* Add docs page listing modules ordered by support level
7 years ago
Toshio Kuratomi af2073d057 metadata 1.1
* Add network value to support_by field.
* New support_by value, certified
* Deprecate curated in favor of certified
* Add conversion from 1.0 to 1.1 to metadata-tool
* Add supported by Red Hat field to ansible-doc output
7 years ago
CyberArk BizDev d50d65d448 Added cyberarkpassword lookup plugin (#21857)
* Added cyberarkpassword lookup plugin

Added cyberarkpassword lookup plugin: It allows to retrieve credentials
(password, sshkey) from CyberArk Digital Vault
7 years ago
Jason McKerr cc36153928 Update ROADMAP_2_4.rst 7 years ago
hsmtkk 3f9d6aa0f1 doc: fix a typo (#28215) 7 years ago
Aleks Daranutsa f668f41822 Spelling and Grammar for playbooks_reuse.rst (#28174)
* Spelling and Grammar for playbooks_reuse.rst

* Minor edits.
7 years ago
scottb b5179f9d46 CSS and HTML updates to enable versioned core documentation (#28097)
* Updated header for versioned docs.

* A tree in a golden forest.

* Fixed spacing.

* Fixed CSS and text for previous version header.
7 years ago
Toshio Kuratomi fe2e17f7cd Update the intersphinx cached indexes
In case we build docs offline, we want to have a cached copy of the
documentation refs that are in the intersphinx docs we reference.
Update those to the lattest versions from their respective upstreams
7 years ago
René Moser eec4434b9b doc: cloudstack: fix formating issue in guide (#28162) 7 years ago
Greg DeKoenigsberg d78c199972 Update triage_process.rst to link to ansibullbot (#28137)
* Update triage_process.rst to link to ansibullbot

* fix typo
7 years ago
Greg DeKoenigsberg 75c0c545fd Create other_tools_and_programs (#28138)
* Create other_tools_and_programs

From https://github.com/ansible/community/issues/5.

* Fix typo
7 years ago
Greg DeKoenigsberg b3ed699132 Copying code of conduct from community.rst (#28136) 7 years ago
Greg DeKoenigsberg 608c69279c Moving "communication" info from main community page (#28135) 7 years ago
Duncan Lock 9a2ae022f5 Format the versionadded block correctly (#28085)
Currently broken on the live docs site: http://docs.ansible.com/ansible/latest/playbooks_blocks.html
7 years ago
Prasad Katti 2c85ca3729 Formatting changes (#28133) 7 years ago
Greg DeKoenigsberg 5f6bfd81f8 Copying content from MODULE_GUIDELINES.md (#28131) 7 years ago
Adrian Likins a2c8b03b46 fix rst format errors making rstcheck fail (#28129) 7 years ago
Greg DeKoenigsberg 3ec7e030bf Completed draft of How Can I Help 7 years ago
Greg DeKoenigsberg f8f17c0c27 Add basic info on pull requests 7 years ago
Greg DeKoenigsberg 418dd0cd4a Iterating on How Can I Help
A little more content
7 years ago
Greg DeKoenigsberg ba065637ff Add roadmap to development process doc 7 years ago
Greg DeKoenigsberg 792bfa657c formatting tweak 7 years ago
Greg DeKoenigsberg e43d1da938 formatting tweak 7 years ago
Greg DeKoenigsberg d6028c5de4 Slight changes to reporting bugs and features
as recommended by @gundalow in review for #27911
7 years ago
Greg DeKoenigsberg ebfdbfb819 New content for bugs and features (#27911)
1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.)

2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
7 years ago
Stefan Midjich 6e4c0143b4 Typo in module example code (#28064)
In the DOCUMENTATION constant there is a typo on line 85 of this rst file.
7 years ago
Thomas Stringer e4cd899363 Add support for Azure 2.0.0 (#27920)
* Adapt azure_rm_resource_group to azure 2.0.0 + azure Cli support

* Fix exceptions in Azure ARM plugins

* update azure_rm_networkinterface documention to reflect required params

* change state param to not required for docs in azure_rm_subnet

* fix import to reflect azure==2.0.0 changes

* add aliases and fix docs for azure_rm_storageblob

* add resource_group_name alias to azure_rm_storageaccount_facts

* fix import bug due to change in azure==2.0.0

* fix args bug and enum modules issue

* update docs to reflect azure==2.0.0

* pin management clients to a specific api_version

* update docs to reflect the new azure-ansible-base python package

* add fallback for older api resource group listing

* rework azure dependencies installation

* refactor path joining to a cross-plat solution
7 years ago
Jordan Borean 7c59b66802 updated changelog for windows (#28040) 7 years ago
Brian Coca 914ae2fb26 added docs for undocumented play object entries 7 years ago
David Newswanger ebb1d75ee0 fixed a syntax problem that was preventing a warning box from being displayed 7 years ago
Prasad Katti 2a63693580 Minor fix in docs 7 years ago
Brian Coca 940a74a93a fixed include_role doc example (#27986)
fixes #27985
7 years ago
Dag Wieers 49aa64a5b8 Various small changes and adding myself
Unfortunately, the Github interface does no longer allow me to edit a file in the GUI and then branch it in my personal clone for making a PR. It now only offers to make a PR using a branch on the ansible repository :-(

So committing this directly instead against my will, but per the guidelines this appears to be safe. Fingers crossed...
7 years ago
Jordan Borean 362f032449 Changed docs requires to new format (#27918) 7 years ago
Joseph Miguel f88f4394c8 Update developing_api.rst (#25922)
* Update developing_api.rst

* Update developing_api.rst

Edited.
7 years ago
Arthur Kepler d828449611 Corrects default arg format used by datetime filter (#27612)
This ensures the default datetime format matches that of
datetime.datetime. Docs updated to match as well.
7 years ago
Toshio Kuratomi 44935a5db6 Add a (disabled) code-smell test for detecting _ variables
We are reserving the _ identifier for i18n work.  Code should use the
identifier dummy for dummy variables instead.

This test is currently skipped as someone needs to generate the list of
files which are currently out of compliance before this can be turned
on.
7 years ago
Peter Sprygada 2d5908255a add parse_cli and parse_cli_textfsm to documentation (#27755)
* add parse_cli and parse_cli_textfsm to documentation

* Minor edits.
7 years ago
Scott Butler c43a10bd69 Another clarifying note on Python supported versions. 7 years ago
Scott Butler 7d553aad29 Added note clarifying which version of Python 3 we support. 7 years ago
Scott Butler 699e0ccc32 Added note clarifying Python 3 supported versions. 7 years ago
Branko Majic f78baa1300 Implement ability to limit module documentation building (#24576)
* Implement ability to limit module documentation building:

- Added new option to plugin_formatter.py to support passing-in a list of
  modules for which the documentation should be built.
- Updated docuemtnation Makefile to allow specifying list of modules via
  environment variables (defaulting to all modules).
- Update instructions for building documentation and module development to
  include commands and description of limiting module documentation builds.

* Updated implementation for limiting module documentation building:

- Pass list of modules (or None) to list_modules function instead of string.
- Move conversion of module list to argument parsing code.
- No special keywords. Default ("") means build all modules. For no modules just
  specify non-existing module name.
- Updated documentation to reflect the changes.

* Updated implementation for limiting module documentation building:

- Use better default value, and don't treat "" as special case.
- Conditionally invoke different variants of command in Makefile instead of
  using special value "".

* Minor edits

Wording tweak
7 years ago
Scott Butler bfe470d391 Minor edit 7 years ago
Scott Butler 6d59ac1bb4 Updated per tech review feedback. 7 years ago
Scott Butler b2ec984130 Updating packaging locations - incorporating review feedback. 7 years ago
Toshio Kuratomi f4d7b9a596 code-smell test changes
* Create get_exception and wildcard import code-smell tests
* Add more detail to boilerplate and no-basestring descriptions
* Remove the no-list-cmp test as the pylint undefined-variable test covers it
7 years ago
Yaacov Zamir 48922660fe New model manageiq manageiq user (#26641)
* ManageIQ: manageiq_user module, module utils and doc_fragment

ManageIQ is an open source management platform for Hybrid IT.

This change is adding:
- manageiq_user module, responsible for user management in ManageIQ
- manageiq utils
- manageiq doc_fragment

* Handle import error

* Use formatting options

* group parameter is required

* changed doesn't need to be an attribute

* resource dictionary should contain values which isn't None

* move from monitoring to remote-management

* Use ManageIQ nameing convention

* Do not set defauts in arguments

* Use idempotent state parameter instead of action

* Check import error in the manageiq util class

* Update the miq documentation

* rename the connection configuration from miq to manageiq_connection

* All messeges start with non cap, fix typos, add examples, rename vars

* more typos fixes

* Make sure we insert only strings to logs by using % formating

* use suboptions keyword for the manageiq connection

* do not log the managiq connection struct (it include sensitive information like username and password)

* add missing from __future__

* ahh, wrong no-log line

* Use sub options
7 years ago
John R Barker 7f8aaf97de rst validation fix (#27698) 7 years ago
Greg DeKoenigsberg aca4504e96 Simple "good enought" index page (#27667)
Removing the FIXME, just a peppy little starter page.
7 years ago
John R Barker df58d943d3 Docs porting guides 2.0 & 2.3 (#27632)
* Create new "Porting Guide" section

Create new landing page
Add porting_guide_2.3

* correct CHANGELOG

* Document blocks

* Document named blocks

* OpenBSD & async action plugins

* OpenBSD & async action plugins

* versioadded for name

* review comments
7 years ago
scottb 3476b005b9 Initial pass at consolidating community content [work in progress] (#27661)
* Added placeholder topics for community info

* Setup community section index.

* Initial move of triage process docs.

* Typo/test

* Removed triage topic from index.
7 years ago
Adrian Likins ac37be9761 update roadmap (multiple vault secrets merged) (#27644) 7 years ago
Abhijit Menon-Sen 20b0716948 Allow variables to be passed in to template lookup plugin (#18662)
This allows a single template to be evaluated with different values in
the same task. For example, with a template like 'x:{{a}}', one could do
something like this:

    - foo:
        a: "{{ lookup('template', 'x.j2', template_vars=dict(a=foo[item])) }}"
        b: "{{ lookup('template', 'x.j2', template_vars=dict(a=bar[item])) }}"
      with_items:
        - x
        - y

…and "a" and "b" would expand to different strings based on what we
passed in to the template lookup.
7 years ago
Ganesh Nalawade 70ce394840 Persistent connection timer changes (#27272)
*  Add command_timeout timer that defines the amount
   of time to wait for a command or RPC call before
   timing out.
*  Remove connect_retries and connect_interval configuration
   varaible and replace it with connect_retry_timeout to control
   the timeout value of connection to local scoket.
*  Make required changes to netowrk action plugins and relevant
   network files in module_utils.
*  Required documentation changes.
7 years ago
Brian Coca 842951f00d added note about not all tasks being 'delegatable' 7 years ago
Scott Butler 12e349fe48 Updated package locations. 7 years ago
Matt Davis e4d153bd5d update WSL installation docs for current builds (#25237)
* supersedes #25224
7 years ago
Jordan Borean ad5fa60a2b Added initial developing module doc for Windows (#27308)
* Added initial developing module doc for Windows

* Added to dev index, made formatting changes and moved obsolete docs

* changes based on PR feedback

* some typos and extra information

* Minor updates

* minor wording clarifications
* remove references to "remote" Windows hosts
* update template/text to remove legacy `#WANT_JSON`/`#POWERSHELL_COMMON`
* use per-execution envvars for ANSIBLE_KEEP_REMOTE_FILES instead of stateful

* fix up minor sanity check issue
7 years ago
Matt Clay 51bd07204b Revert "Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)"
This reverts commit 520696fb39.
7 years ago
Toshio Kuratomi 520696fb39 Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)
* Revert "Update conventions in azure modules"

This reverts commit 30a688d8d3.

* Revert "Allow specific __future__ imports in modules"

This reverts commit 3a2670e0fd.

* Revert "Fix wildcard import in galaxy/token.py"

This reverts commit 6456891053.

* Revert "Fix one name in module error due to rewritten VariableManager"

This reverts commit 87a192fe66.

* Revert "Disable pylint check for names existing in modules for test data"

This reverts commit 6ac683ca19.

* Revert "Allow ini plugin to load file using other encoding than utf8."

This reverts commit 6a57ad34c0.
7 years ago
Toshio Kuratomi 3a2670e0fd Allow specific __future__ imports in modules
We do want to allow certain from __future__ imports in modules that make
it easier to code compatible python2 and python3.  Note that
unicode_literals is specifically left out and should never be allowed.
Now that python-3.4+ allows u"" there's no good reason to use
unicode_literals.

Also switch tables in the validate_modules documentation to simple table format
7 years ago
Yannig Perré 6a57ad34c0 Allow ini plugin to load file using other encoding than utf8.
- New option for ini plugins: encoding
  - Add a new option encoding to _get_file_contents
  - Use replace option in test/runner/lib/util.py when calling decode on stdout/err
    output when diff have non-utf8 sequences
7 years ago
Toshio Kuratomi bf42f94021 Fixes to pip with git install instructions
* use git+https:// in the example url because not everyone will have ssh
  keys registered on github
* Remove the link to the github tarballs as they do not work.  users can
  use releases.ansible.com instead.
7 years ago
scottb 058e67dcbe Minor edits. 7 years ago
Brian Coca 74e9e4bcbd updated --diff docs 7 years ago
David Moreau-Simard e2d874c744 Improve release and development cycle documentation
This commit:
- Adds a table highlighting the status of each version and provides
  a link to each major release's changelog
- Re-inforces how stable versions are maintained and for how long
- Moves this documentation out of the developer tree (this is
  interesting for users too!) while keeping a link there.
7 years ago
jokurz 732912b641 Add local_action example in case of multiple arguments (#26427)
* Add local_action example in case of multiple arguments

Add an example to show how local_action can be used in case of multiple arguments.

* Update playbooks_delegation.rst
7 years ago
Andrea Tartaglia 341cf290d3 Added become_exe and become_flags docs (#19554)
* Added become_exe and become_flags docs

* Minor edits
7 years ago
Martin Krizek 9c50933a80 docs: fix community meetings link (#27264) 7 years ago
Matt Davis 9986639681 various Windows/Azure roadmap updates 7 years ago
Abhijeet Kasurde 4fd7ab11ff Minor fix for typo - ismount to is_mount
Fix adds correction from ismount to is_mount filter in
playbooks_tests documentation.

Fixes: 27128

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Sam Doran dac519135d Change docs to reference BOTMETA.yml instead of MAINTAINERS.txt (#26912) 7 years ago
Sloane Hertel 7a8054812c updated roadmap (AWS) (#27011)
* update AWS roadmap

* Update ROADMAP_2_4.rst
7 years ago
Toshio Kuratomi f4bb71c0df Update roadmap with python3 status (#27171) 7 years ago
Matt Clay a53dabf664 Update testing progress on 2.4 roadmap. 7 years ago
Chris Alfonso c19d25cf67 Updating network roadmap segment to reflect any changes we decided (#27057)
upon during our 2.4 dev cycle.
7 years ago
rgm 13e7e00706 Fix double-quote chars in passwordstore examples (#27084)
Also add link to passwordstore.org and correct a typo.
7 years ago
Serge Bishyr 7694fd6f9f #27045 fix installation guide via apt (ubuntu) (#27049)
* #27045 fix installation guide via apt (ubuntu)

* Update intro_installation.rst

Re-added apt-get update as it is needed to get the latest package index from ppa:ansible/ansible
7 years ago
Adrian Likins 33a2d72290 Update facts/vault roadmap items (#27082)
* Update facts/vault roadmap items
7 years ago
James Mighion b8337ee9d3 New module aireos_command (#26769)
* Adding ciscowlc_command module and unit tests.

* Adding __init__.py for unit test.

* Fixing PEP8 W503.

* Renaming module from ciscowlc_command to aire_command.

* Renaming aire_command to aireos_command.
7 years ago
acrewdson 0a4c570153 Fix typo (#26988) 7 years ago
Ryan Brown beca565c79 [Docs] Add note on module development about the copyrights (#26812)
* Add note on module development about the copyrights

This matches what's in CODING_GUIDELINES.md as of July 2017

* Add recommendation for standardizing on `Copyright (c) 2017 Ansible Project`

* s/with/should have/

* Fix more unicode
7 years ago
James Mighion f682d9bf49 Adding aruba_command module along with unit tests. (#26625)
* Adding aruba_command module along with unit tests.

* Fixing PEP8 E303 too many blank lines.

* Adding default for timeout.

* Removing unused arguments. Moving default for timeout argument. Fixing cliconf to find hostname.

* Fixing PEP8 E302.
7 years ago
Toshio Kuratomi 37e757286d Add module_utils example next to library examples (#25390) 7 years ago
Dylan Silva 913a8f864a changed freeze date for modules (#27009) 7 years ago
Matt Clay 16f796460f Fix rstcheck issue. 7 years ago
Brian Coca 3477825fc9 updated roadmap 7 years ago
Matt Clay 8e66015564 Fix rst syntax in roadmap. 7 years ago
Adrian Likins 06e49dfbbd fix roadmap, strikethough does not quite work 7 years ago
Adrian Likins e6de059048 updating roadmap with facts status 7 years ago
Matt Clay e63f69464f Add ansible-test options and docs. (#26823)
* All integration commands support --continue-on-error
* The network-integration command supports --inventory
* Add landing page for compile test docs.
* Add bot documentation links.
7 years ago
Dylan Silva ba000abe1c Added in dates for freeze (#26814)
* Added in dates for freeze

* Update ROADMAP_2_4.rst
7 years ago
Matt Clay 789218c215 Initial ansible-test sanity docs. (#26775)
* Rename no-iterkeys test for consistency.

* Require docs for all ansible-test sanity tests.

* Initial ansible-test sanity docs.

* Fix capitalization of Python.

* Fix sanity code smell test false positives.

* Fix another code-smell false positive.
7 years ago
Lujeni 640131c464 Missing documentation about the include directive for requirements files (#20090)
* Missing documentation about the include directive for requirements files

* Code block needs blank line

* Correct casing
7 years ago
scottb 4f01a323a0 Replace 'simple module development' topic (#26267)
* WIP: Initial bulk move of quick start content into rst docs. Needs rewrite.

* Swapping out old quick start for new material (thanks @tstringer!). Still work in progress.

* Fixed formatting; removed extraneous file.

* Fixed some formatting errors.

* Once more, with feeling.

* Fixed formatting error
7 years ago
Pilou 2a92120ffa INI inventory plugin: add documentation about variable types (#25798)
* INI inventory: check variable types
* INI inventory: add doc about variable types

Fixes #25784
7 years ago
Pilou 4b3d6dfa8a Use pycodestyle instead of pep8 (#25947) 7 years ago
Dag Wieers cda6f602f1 Fix missing index (#26678) 7 years ago
Dag Wieers 292f109ad6 Restructure roadmap so that we can link to sub-parts (#26637)
* Restructure roadmap so that we can link to sub-parts

So we want to point to specific subsections in the roadmap from the Working Group pages.
This requires the use of subtitles rather than a long list of items and sub-items.

* RST syntax is hard...

* Fixes as requested

* Another fix

* Converted all ROADMAPs to new format
7 years ago
Dag Wieers 318f369969 filetree: Add documentation for lookup plugin (#26157)
* filetree: Add documentation for lookup plugin

This is the missing documentation for the filetree lookup plugin.

* Fix typo

* Edits for grammar and clarity
7 years ago
Chiyu Zhong 505dd9fe44 Update playbooks_loops.rst 7 years ago
John R Barker ed0aabe02d Tell people to look for an existing module PR (#26287)
* Tell people to look for an existing module PR

There are a number of different ways to find existing PRs that add new
modules. Tell people about them to potentially avoid duplicates.

* Light edits
7 years ago
Helio Campos Mello de Andrade 54c64deaab Remove unnecessary 'our"word. (#26221)
Remove unnecessary 'our"word.
7 years ago
Scott Butler ed17d7a0a5 Editing to fix wording from PR #26161. 7 years ago
Chainarong Tangsurakit ff30682740 [cloud][gce] Add necessary key for secrets.py (#25997)
Add necessary key for secrets.py
7 years ago
Sam Doran 6f73ab84c6 Correct note syntax so Docker on non-Linux note shows up (#26161)
The note only had one colon instead of two, which allowed it to pass rstcheck but failed to actually generate the note in the HTML.

Also remove an unnecessary trailing colon.
7 years ago
Sam Doran 67eae347cd Fix roles language in docs (#25811)
* Correct tag behavior with regards to roles

* Remove trailing spaces

* Furthe clarify include vs. import tag behavior
7 years ago
Brian Coca 8bcfb85918 display v added 7 years ago
Laurens Vanderhoven 6922a18c80 Update playbook_best_practices.rst, range notation (#25959)
Update --limit range notation.

Current notation triggers "[WARNING]: Use [x:y] inclusive subscripts instead of [x-y] which has been removed"
7 years ago
John R Barker 4ab4a6766e ansible-windows IRC (#25872) 7 years ago
John R Barker 5551e87755 RETURNS can include version_added (#25810) 7 years ago
Simon Dodsley 937d7993cc Initial commit for Pure Storage Ansible module (#25386)
* Initial commit for Pure Storage Ansible module

* Initial commit for Pure Storage Ansible module

* Initial commit for Pure Storage Ansible module

* Fix import issues as required by post-2.2

* Move last import to top

* Follow suggestions and only implement one module per PR
Fix documentation changes requested

* Documentation and formatting changes
7 years ago
Matt Martz 89c3151167 Give example of empty _meta in dyanmic inventory (#24085) 7 years ago
Sanket Jagtap dbb3fd0e5e Formatted Dynamic Inventory link for Openstack (#25351)
* Formatted Dynamic Inventory link for Openstack

* Create intro_dynamic_inventory.rst
7 years ago
Abhijeet Kasurde b89cb95609 Fix spelling mistakes (comments only) (#25564)
Original Author : klemens <ka7@github.com>

Taking over previous PR as per
https://github.com/ansible/ansible/pull/23644#issuecomment-307334525

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Brian Coca 9d23dcac29 fixed version added tag 7 years ago
John R Barker 4e6fee212a Correct link to plugins (#25530) 7 years ago
Pilou bf0d0274cf doc: PEP 8 compliance is required (#25524) 7 years ago
Dag Wieers 357069afcb Add missing modules (#25483) 7 years ago
George Nikolopoulos a00089c341 New module: manage Citrix Netscaler service configuration (network/netscaler/netscaler_service) (#25129)
* netscaler_service initial implementation

* Changes as requested by reviewers

* Skip some tests if under python2.6 and importing requests library

* Change option "operation" to "state"

* Remove print statements from netscaler module utils

* Catch all exceptions during login

* Fix fail message

* Add common option save_config
7 years ago
John R Barker 217c80ba7e New IRC groups + Formatting (#25441)
* New IRC groups + Formatting

* Edits for conciseness and clarity.
7 years ago
Matt Martz 004e99316c Allow template files to be vaulted (#22951)
* Allow template files to be vaulted

* Make sure to import exceptions we need

* get_real_file can't take bytes, since it looks specifically for string_types

* Now that we aren't using open() we don't need b_source

* Expand playbooks_vault docs to include modules that support vaulted src files

* Add vaulted template test
7 years ago
James Cammarata 45378e71d1 Removing auto-generated doc from previous import/include commit 7 years ago
James Cammarata 483df9c5f8 Imports and includes (#25399)
Initial commit to split includes into static imports/dynamic includes

This implements the new include/import syntax for Ansible 2.4:
* include_{tasks,role,variables} = dynamic
* import_{playbook,tasks,role} = static

The old bare `include` will be considered deprecated, as will any use of the `static: {yes|no}` option.

This also adds docs for import/include and reorganizing the "Playbook Reuse" section of the documentation.
7 years ago
Matt Davis 365d06c538 add Makefile target for single HTML page (#25313) 7 years ago
Brian Coca c7eaccb7b5 added delegate_to warning 7 years ago
Timo Sand aa9ea3d43a Adds documentation of implicit regex match removal (#24934)
regex_replace has a implicit parameter for `replacement` and thus can remove the matched string
7 years ago
Tyler Lubeck d6bfc11e6d Fix formatting for rst code block (#25185) 7 years ago
Dag Wieers 47738eb1dd docs: PEP8 compliance (#24681)
- Make PEP8 compliant
7 years ago
scottb 54bdcd734e Some cleanup of the intro and getting started sections. (#25083) 7 years ago
Iain Foulds a1709bf0f9 Correcting YAML identation (#25049) 7 years ago
Brian Coca 61060b66c2 make rst linter happy 7 years ago
scottb f315d4260f Update playbooks_intro.rst
Edits
7 years ago
Brian Coca 70b2ceebe5 document new 'order' keyword for plays 7 years ago
Brian Coca 8f97aef1a3 Transition inventory into plugins (#23001)
* draft new inventory plugin arch, yaml sample

 - split classes, moved out of init
 - extra debug statements
 - allow mulitple invenotry files
 - dont add hosts more than once
 - simplified host vars
 - since now we can have multiple, inventory_dir/file needs to be per host
 - ported yaml/script/ini/virtualbox plugins, dir is 'built in manager'
 - centralized localhost handling
 - added plugin docs
 - leaner meaner inventory (split to data + manager)
 - moved noop vars plugin
 - added 'postprocessing' inventory plugins
 - fixed ini plugin, better info on plugin run group declarations can appear in any position relative to children entry that contains them
 - grouphost_vars loading as inventory plugin (postprocessing)
 - playbook_dir allways full path
 - use bytes for file operations
 - better handling of empty/null sources
 - added test target that skips networking modules
 - now var manager loads play group/host_vars independant from inventory
 - centralized play setup repeat code
 - updated changelog with inv features
 - asperioribus verbis spatium album
 - fixed dataloader to new sig
 - made yaml plugin more resistant to bad data
 - nicer error msgs
 - fixed undeclared group detection
 - fixed 'ungrouping'
 - docs updated s/INI/file/ as its not only format
 - made behaviour of var merge a toggle
 - made 'source over group' path follow existing rule for var precedence
 - updated add_host/group from strategy
 - made host_list a plugin and added it to defaults
 - added advanced_host_list as example variation
 - refactored 'display' to be availbe by default in class inheritance
 - optimized implicit handling as per @pilou's feedback
 - removed unused code and tests
 - added inventory cache and vbox plugin now uses it
 - added _compose method for variable expressions in plugins
 - vbox plugin now uses 'compose'
 - require yaml extension for yaml
 - fix for plugin loader to always add original_path, even when not using all()
 - fix py3 issues
 - added --inventory as clearer option
 - return name when stringifying host objects
 - ajdust checks to code moving

* reworked vars and vars precedence
 - vars plugins now load group/host_vars dirs
 - precedence for host vars is now configurable
 - vars_plugins been reworked
 - removed unused vars cache
 - removed _gathered_facts as we are not keeping info in host anymore
 - cleaned up tests
 - fixed ansible-pull to work with new inventory
 - removed version added notation to please rst check
 - inventory in config relative to config
 - ensures full paths on passed inventories

* implicit localhost connection local
7 years ago
Dag Wieers cce133b14f WinRM: Add operation and read timeout variables to docs (#24922)
* Add operation and read timeout variables to docs

Since WinRM is not the most reliable protocol, it may be necessary to increase its timeout values to get a better experience.

* Update intro_windows.rst

Great idea to add this.
I changed 'experienced' -> 'experience' (present continuous rather than past tense).  Added some . to be consistent with other lines.
7 years ago
Michael De La Rue e9e661ebbb aws integration tests - provide an IAM policy for running (#24725)
* aws integration tests - provide an IAM policy that can be used for running them

* move documentation of aws policies into main integration testing documentation + some updates there

* Update testing_integration.rst

Edits
7 years ago
John R Barker f338dd2fc3 Render returned dictionaries Fixes #24775 (#24777)
plugin.rst.j2 was out of sync with syntax validator
7 years ago
John R Barker c9e05956b7 Update testing_units.rst (#24772) 7 years ago
Brian Coca 7bb0a8d4fc added order doc for inventory keyword 7 years ago
Brian Coca c7b9f2a6de added docs about url 7 years ago
Matt Clay 9178e176b5 Limit sphinx version on python 2.6. (#24678)
* Limit sphinx version on python 2.6.
* Fix issues identified by rstcheck.
7 years ago
Abhijeet Kasurde 9f3a405706 Fix URLs in dev_guide documentation (#24533)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
7 years ago
Matt Martz eb5e906014 Support py3 in plugin_formatter.py (#24384)
* Support py3 in plugin_formatter.py

* Do everything in bytes
7 years ago
Matt Davis 0f4026d626 add Windows docs for winrm automatic kerb ticket mgmt (#24456) 7 years ago
Brian Coca 91449ea231 removed autogenerated file and added to ignore 7 years ago
James Cammarata ed56f51f18 Fixing security issue with lookup returns not tainting the jinja2 environment
CVE-2017-7481

Lookup returns wrap the result in unsafe, however when used through the
standard templar engine, this does not result in the jinja2 environment being
marked as unsafe as a whole. This means the lookup result looses the unsafe
protection and may become simple unicode strings, which can result in bad
things being re-templated.

This also adds a global lookup param and cfg options for lookups to allow
unsafe returns, so users can force the previous (insecure) behavior.
7 years ago
Dylan Silva 6f4f7011f1 Updates to docs for developers (#24034)
- Added items to index for TOC
- Changed some formatting on overview_architecture
- removed some out of date items from developing_modules_general
7 years ago
Adrian Likins 5618f494a8 Fix docs/api sphinx-build err on 'make rpm' (#24334)
The makefile in docs/api/ had a top level check for the
'sphinx-build' tool, but the check was getting triggered
on 'make clean' when it is not needed and causing 'make rpm'
and similar builds to fail.

So this commit removes the check.

Fixes #24163
7 years ago
Matt Clay cec2b960f8 Fixes for pep8 and rstcheck issues. 7 years ago
scottb 02057f481b Added style guide (#24310)
* Added style guide

* Fixed index
7 years ago
Andrea Tartaglia 4e4fc9cb4c Added test for 'RETURN' field in validate-modules (#23322)
* Added test for 'RETURN' field in validate-modules

* print the field being tested.

Useful when the RETURN structure is complex.

* Fixed schema after CI traceback fail

* Fixed list_string_types

* Fixed line in 319 code for RETURN
7 years ago
Brian Coca 033fe5548b added epub entry for makefile 7 years ago
Dan Kolb 914f8e4596 Fixes minor type in docs (#24117)
Removes an extra `e` from the word `batch` in the the
`playbooks_delegation` documentation seen at:
http://docs.ansible.com/ansible/playbooks_delegation.html
8 years ago
John R Barker 8733253a76 Minor testing docs improvements (#24103)
Fix a few formatting issues spotted post review.
Also reapply missing commit
8 years ago
John R Barker ecbf8e933a Docs how to test (2nd) (#24094)
* Big testing doc refactor
* Combine all the testing documentation in to one place to make it easier to find
* Convert everything to RST
* Create testing_network guide
* Create testing landing page
* For each section detail "how to run" and "how to extend testing"
* More examples
* Lots more detail
8 years ago
Strahinja Kustudic 66a41f59fd Add a missing leading zero in a mode parameter
600 is an incorrect mode, because mode needs to be octal.
8 years ago
Strahinja Kustudic 6dddd5b167 Remove action keyword from do-until example
`action:` is old and not needed any more.
8 years ago
Toshio Kuratomi 51e3390333 Document deprecation of fetch module validate_md5 and update --tags merging deprecation (#24022)
* Document deprecation of fetch module validate_md5 and update --tags merging deprecation

Update the default of --tags merging config option to merge by default

* Update CHANGELOG.md

Minor edit
8 years ago
scottb 946658cd24 Update playbooks_python_version.rst
Minor edits
8 years ago
Toshio Kuratomi 78dd3496e2 Update version and change remove files from pep8 blacklist 8 years ago
Toshio Kuratomi 82ad8ff081 Add documentation of Jinja2 templating idioms that differ when run under Python3
Fixes #19514
8 years ago
Toshio Kuratomi 4c7a2e2622 Enable intersphinx for python stdlib and jinja2
This setting allows us to reference jinja2 and python stdlib docs
via docutils refs instead of hardcoding urls.

Fixes #18039

Remove extraneous sphinx config
8 years ago
Strahinja Kustudic 74e385e43a Move include_vars to host scope (#23868)
* Move include_vars to host scope

Module include_vars actually sets variables on a host level, and not the play level.

* Expand vars entires
8 years ago
David Mahler 09b247dd34 Minor grammatical corrections and improvements (#23886) 8 years ago
Brian Coca 3358abcf49 Add a new filter: strftime. Use the well known function to format a date output. (#23832)
(cherry picked from commit 3f5b304fc2)
rebased for @yannig
8 years ago
Eric Anderson 6aab341248 changed code block formatting to match format (#23615) 8 years ago
Adam Johnson f1c4b434cd Tidy example inventories in "Developing Dynamic Inventory Sources" (#18758)
Thanks @adamchainz!
8 years ago
Tomáš Karásek 0b585ec4fd Add guide for Packet host (#21346)
* Add guide for Packet host

* incorporate feedback from Packet

* Format headings according to Python doc guide

* fixed rstcheck issues in packet guide
8 years ago
Alexander Gubin d04a5246de Fix example fact(ansible_default_ipv4.address) for delegated_facts 8 years ago
John R Barker 33d7c12a97 Improve network debug wording (#23735) 8 years ago
Ian Levesque acd1dd8df1 Add ssh_connection / retries option documentation (#23463)
No docs were included when https://github.com/ansible/ansible/pull/9927 was merged.
8 years ago
Dag Wieers d188f56535 Add example task succeeding when RC is non-zero (#23698)
* Add example task succeeding when RC is non-zero

I added an example on how to use the return code to decide yourself
what is considered a failure.

This might have helped for #23679.

* Use diff as example command, instead of robocopy
8 years ago
Scott Butler 087159c4cd Switch Adobe tracking off staging. 8 years ago
Dag Wieers b6c00f722b Windows: Add Windows Subsystem for Linux documentation (#23515)
* Windows: Add Windows Subsystem for Linux documentation

As discussed during the Windows Working Group meeting we do want
documentation on running Ansible on Windows as it may help grow
the Windows/Ansible community and does work out-of-the-box.

However we do take care to emphasize that WSL is not fit for
production use.

* Update intro_windows.rst

Edits for mechanics and clarity.
8 years ago
Matt Clay cb1f57d4e5 Add rstcheck to ansible-test and correct issues. (#23550)
* Add rstcheck to ansible-test.
* Fix rst code-block languages and syntax errors.
* Fix rst inline literals.
* Update python 2 code block to pass tests on py 3.
8 years ago
John R Barker 729b0e3bee Use exports (#23542) 8 years ago
Brett Cannon ece2aa2d5f Fix reST markup (#23536) 8 years ago
John R Barker e575eae2ec Document how to debug network issues (#23503) 8 years ago
Brian Coca eaaf46a50d Revert "made example not fail"
This reverts commit 2c9543e0b7.

example won't fail but will prevent correct PATH from being set
using actual fix to deal with this corner case
8 years ago
cclauss 6314169afd Update the comments around Python 3
[Enterprise Linux 5 is at the end of "End of Production 3 phase"](https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux#Product_life_cycle) so that is no longer a reasonable reason to wait.  Also removed the comments about [Python 3 not being mainstream](http://python3wos.mybluemix.net/201).  Perhaps a link to https://docs.ansible.com/ansible/python_3_support.html would also be a useful addition to this question.
8 years ago
John R Barker 01e27b1083 Typo 8 years ago
Toshio Kuratomi 3180b4757e The Python3 dev doc is more general than just modules (#22950)
The Python3 dev doc is more general than just modules

* Rename it to make that obvious.
* Move generally applicable Python3 information to the Controller section
* Add a Py3/Py2 section on formatting strings
* Fix code-blocks to highlight as python
* Enhance python3 support page
* Add Python3/Python2 compat note
8 years ago
Matt Davis d85f4a443f mark runas become method experimental (#23235)
Due to the number of "real world" caveats in the current runas become method, it was agreed that we'd warn that it's experimental on use. A potential future version based on LogonUser/CreateProcessAsUser will have very different requirements and limitations.
8 years ago
Brian Coca 2c9543e0b7 made example not fail
fixes #23180
8 years ago
Scott Butler 5591d639f5 Fixed broken link. 8 years ago
Brian Coca 06e0b00035 fixed notation on entries, meant literal not italic 8 years ago
Brian Coca 42383656e7 using prefered format
(cherry picked from commit a78a0caf10e08200ef3dc82c4b78feeecef0d063)
8 years ago
John R Barker 22fe148ca5 Formatting of bullet points 8 years ago
Brian Coca a0a26700c9 remove author as it dupes 8 years ago
Brian Coca da045a9c1f more info for asciidoc to correctly build manpages 8 years ago
Toshio Kuratomi 0249918c7b When outputting text to a file, convert to bytes first.
Fixes #23137
8 years ago
Jerry Wardlow 8f4652ab2f Corrects typo in `inventory_ignore_extensions` (#23099)
Corrects a typo from 'Coma-separated' to 'Comma-separated'
8 years ago
John Nelson 99a160f9c7 Update playbooks_prompts.rst (#22910)
* Update playbooks_prompts.rst

Clarify prompting only occurs when not in extra_vars

* Update playbooks_prompts.rst

* Update playbooks_prompts.rst

Added non-interactive session clarification.

* Update playbooks_prompts.rst
8 years ago
Konstantin Suvorov c1b3d6a51f Fix 'sequence' lookup shortcut syntax and documentation (#22989)
* fix 'sequence' lookup shortcut syntax and documentation

* Update playbooks_loops.rst

Minor edits for grammar and clarity.

* Update playbooks_loops.rst

Another tweak for clarity.
8 years ago
John R Barker 6c101087ac RST Code should be ``--tags`` fixes 22717 (#23074) 8 years ago
Dylan Silva 24e7a77a32 Updated 2.4 roadmap for final publish (#23049)
* Updated 2.4 roadmap for final publish

* Update ROADMAP_2_4.rst

* Remove "code refactor and unit tests"

This is just technical debt work, and not note-worthy for the roadmap

* Update ROADMAP_2_4.rst

* Update ROADMAP_2_4.rst
8 years ago
Chris Houseknecht d2ea851d09 Adds k8s_common.py (#22899) 8 years ago
Toshio Kuratomi d8f86fa4d2 A couple more places where compat.six was used converted to module_utils.six (#22976) 8 years ago
Brian Coca 2a2e02aea4 .--. . .--. ---.. / .. ... / .- -. -. --- -.-- .. -. --. 8 years ago
Brian Coca 18a7a1ec31 added docs to CLI docstringsadded
removed 'now intermediate build files' from repo
adjusted gitignore
8 years ago
Brian Coca 424e1946f4 moved docs generation and templates to docs/ 8 years ago
Brian Coca b4c47ebf68 draft to generate man pages 8 years ago
Toshio Kuratomi 2fff690caa Update module_utils.six to latest (#22855)
* Update module_utils.six to latest

We've been held back on the version of six we could use on the module
side to 1.4.x because of python-2.4 compatibility.  Now that our minimum
is Python-2.6, we can update to the latest version of six in
module_utils and get rid of the second copy in lib/ansible/compat.
8 years ago
Brian Coca 6b8347ec60 updated doc man page 8 years ago
scottb fb48c45adf Added Adobe DTM tracking. (#22889) 8 years ago
Brian Coca a04dd375eb adjusted home examples to actual value 8 years ago
Brian Coca a36c66023f updated remote_tmp example 8 years ago
Brian Coca a1a5a2b1de fixed passwordstore lookup examples
plugin was renamed before acceptance, but examples kept original name
fixes #22735
8 years ago
Dag Wieers c254618d4f Improve test docs a bit more 8 years ago
Brian Coca 94b269b2ec documented some more keywords 8 years ago
Benjamin dc68503ef2 Update link URL to OpenStack documentation (#22776) 8 years ago
Bradford Dabbs 2472a4587e Flip setenforce boolean (#22752)
* Flip setenforce boolean

* Update example task name
8 years ago
René Moser b90517caf9 cloudstack: implement config overloading and ENV vars for API auth (#22724)
* cloudstack: fix connection by ENV vars and configs overloading

* cloudstack: pep8 cloudstack module_utils

* cloudstack: allow api_url to be set in ini config

* docsite: explain ENV vars support as written in python-cs for ansible
8 years ago
Toshio Kuratomi 8de05d3752 [WIP] Documentation: Ansible-2.4 no longer supports Python-2.4 and Python-2.5 (#22721)
* Documentation: Ansible-2.4 no longer supports Python-2.4 and Python-2.5
* Switched to bullet points to enhance readability.
8 years ago
jwg4 17b8bfc7a2 Change the example of playbook include. (#22697)
This (taken from https://github.com/ansible/ansible-examples/blob/master/language_features/nested_playbooks.yml) is a better example. It makes it clear that the full file name is used, and a single filename, as opposed to a YAML list. The old version, it was not clear if 'list_of_plays' was an *example* or a *variable*.
8 years ago
Brian Coca 001be55ef0 corrected with_dict example
fixes #17636
8 years ago
Brian Coca dd8d699981 namespace facts (#18445)
* namespace facts

always namespace facts, make the polluting of 'main' conditional on config

* updated to 2.4

* Update intro_configuration.rst
8 years ago
Dylan Silva 9dae697997 Updates to docs for metadata. (#22667)
* Updates to docs for metadata.

* Update developing_modules_documenting.rst
8 years ago
Brian Coca 0c44959800 added new tests any and all (#22665)
* added new tests any and all

* updated code names
8 years ago
Brian Coca b059a95714 2nd draft 8 years ago
Brian Coca 7cf16588e8 draft playbook path docs 8 years ago
Brian Coca b606bcec04 Doc directives (#22524)
* draft docs for directives

* updated to document directives
8 years ago
Toshio Kuratomi eb1214baad New metadata 1.0 (#22587)
Changes to the metadata format were approved here:
https://github.com/ansible/proposals/issues/54
* Update documentation to the new metadata format
* Changes to metadata-tool to account for new metadata
  * Add GPL license header
  * Add upgrade subcommand to upgrade metadata version
  * Change default metadata to the new format
  * Fix exclusion of non-modules from the metadata report
* Fix ansible-doc for new module metadata
* Exclude metadata version from ansible-doc output
* Fix website docs generation for the new metadata
* Update metadata schema in valiate-modules test
* Update the metadata in all modules to the new version
8 years ago
John R Barker 04e816e13b Stricter module documentation validation (#22353)
Raise the bar for module `DOCUMENTAION`
This validator update was used to find the issues in https://github.com/ansible/ansible/pull/22297/files

**Validation**
* Updated Validation and docs to enforce more (items fixed in https://github.com/ansible/ansible/pull/22297/files)
* Use `suboptions` to document complex options 
* Validate module name
* Validate deprecated modules have correct ANSIBLE_METADATA

**Module Documentation Generation**
* Document `suboptions:` Example https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718
* Tidy up HTML generation (valid HTML, no empty lists, etc)
 
**Documentation**
* Clarify the steps for deprecating a module
* Use correct RST headings
* Document `suboptions:` (options)
* Document `contains:` (returns)


**Details**
The aim is to get this (and corresponding module updates) complete by the time `devel` becomes `2.4`, as this allows us to raise the bar for new modules

Example `suboptions` https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718

The aim is to get this PR integrated into `devel` *before* we branch `stable-2.3`, this will allows us to:
* Raise the bar for new modules in 2.4
* Ensure the generated module documentation for 2.3 and higher is improved, important as we will be doing versioned docs moving forward.
8 years ago
Jason McKerr 1132f17d2c Update ROADMAP_2_3.rst 8 years ago
Artem Zinenko 990aa73ed8 Fix bug in 'Building A Simple Module' doc (#22447) 8 years ago
Ryan Brown 000ca2a2bc Update roadmap for Amazon Modules 8 years ago
fhiyo 0f82674c0e Add document about connecting to localhost (#20534)
* Add document about connecting to localhost

* Update intro_getting_started.rst

* Update intro_getting_started.rst

Edited.

* Added description about ansible_python_interpreter
8 years ago
Harlan Lieberman-Berg e24ddb4980 Add manpage for ansible-console. (Closes: #16244) (#16245)
* Add manpage for ansible-console. (Closes: #16244)

* Mark host as an optional field in ansible-console.1
8 years ago
John R Barker 3fa5c55182 Fix docs type (#22405)
Fix docs typo
8 years ago
Brian Coca 71c7220e45 fixed ungrouped definition 8 years ago
Aric Renzo 96538ec158 Standardizing syntax for 'Playbook Loops' documentation (#20863) 8 years ago
John R Barker 3afb67e9b2 Fix Docs build issues (#22295)
* restore network docs fragments

* Fix RST errors

* code-block formatting
8 years ago
Chris Tooley 6c2585f0c8 Add some additional value quoting examples (#20464)
The existing examples in the "Gotchas" section were rather simple. Expanded upon those to add some additional clarity around how the quoting in YAML works.
8 years ago
Joona Somerkivi df07866e8f Added example of referring to AWS-credentials (#21560)
* Added example of referring to AWS-credentials

.. when they're stored in variables. Spent few hours trying to figure out why credentials from vault/variables were not used.

* Update guide_aws.rst

Edited for grammar.
8 years ago
Pilou addedb12cf Inventory default groups 'all' and 'ungrouped': add tests and documentation (#21728)
* inventory: test 'all' & 'ungrouped' groups created by default

* Mention default groups 'all' & 'ungrouped'

* Update intro_inventory.rst

Minor grammatical edit.
8 years ago
Adam Johnson d01ac3a019 doc: Document --syntax-check flag for ansible-playbook (#22256)
It wasn't previously documented outside of the help / manpage, which made it less discoverable.
8 years ago
Marko Stanković 10125d520d Improve YAMLSyntax/Gotchas (#21575)
* Improve YAMLSyntax/Gotchas

Colons don't need to be quoted unless when followed by a space or the end of the line

* Update YAMLSyntax.rst

Minor edit.
8 years ago
Jeff Gibson 5cccb7a5d7 ansible_winrm_kerberos_delegation (#22113)
Add a note of how to turn on delegation when using kerberos.
8 years ago
Alan Rominger d542f069ef Update dead support link (#22212)
* Update dead support link

Visit https://www.ansible.com/, and you'll find the support link points to this URL, https://access.redhat.com/products/ansible-tower-red-hat/.

The current link is a dead link.

* update github code blocks link
8 years ago
Mark Janssen 73a7483803 Update documentation for passwordstore lookup (#21448)
* Update documentation for passwordstore lookup

* Style fixes

* Style fixes

* Reword introduction text

* Update playbooks_lookups.rst

Minor tweaks.
8 years ago
Andrea Tartaglia 10a260c622 Clarified when control_path is ignored (#20968) 8 years ago
Chris Alfonso b2a10e6e4b Bumping docs footer copyright year (#22210) 8 years ago
James Cammarata a2599cab79 Fix variable precedence of INI/script vars to be in-line with docs.
This commit also adds a new test script (ansible-var-precedence-check.py in code-smell/)
to provide us with another line of defense against precedence bugs going forward.

The precedence docs state that the INI vars have a lower precedence than group/host
vars files for inventory and playbooks, however that has not been the case since 2.0
was released. This change fixes that in one way, though not exactly as the docs say.
The rules are:

1) INI/script < inventory dir < playbook dir
2) "all" group vars < other group_vars < host_vars

So the new order will be (from the test script mentioned above):

8. pb_host_vars_file - var in playbook/host_vars/host
9. ini_host_vars_file - var in inventory/host_vars/host
10. ini_host - host var inside the ini
11. pb_group_vars_file_child - var in playbook/group_vars/child
12. ini_group_vars_file_child - var in inventory/group_vars/child
13. pb_group_vars_file_parent - var in playbook/group_vars/parent
14. ini_group_vars_file_parent - var in inventory/group_vars/parent
15. pb_group_vars_file_all - var in playbook/group_vars/all
16. ini_group_vars_file_all - var in inventory/group_vars/all
17. ini_child - child group var inside the ini
18. ini_parent - parent group var inside the ini
19. ini_all - all group var inside the ini

Fixes #21845
8 years ago
Chris Houseknecht d20d528dbd Adds --role-skeleton to ansible-galaxy man page (#22199) 8 years ago
Dag Wieers 98b978d1d1 Clarify what modules are available for Windows (#21888)
Remove repeated mentions of an incorrect list.

This fixes #20696
8 years ago
Matt Davis c98647ccf8 initial commit of win_domain module (#22179) 8 years ago
azenk bdf0ab451e Add role skeleton support (#17079)
* Add role skeleton support

The default role skeleton used by ansible-galaxy is good, but it doesn't
allow organizations to customize it to suit their needs.  This patch
addresses that by adding the option to point ansible-galaxy at a
role skeleton directory.  The contents of this directory are then
copied (or rendered) into the output role directory.  Appropriate
command line options and configuration entries are added to allow for
further customization from the role skeleton.

* Remove dependency on platforms list from test

Platforms are no longer provided to the template by galaxy init.
Removing the code in our test meta/main.yml template that relied on it.

* Fix whitespace issue
8 years ago
scottb 0bd2714122 Update playbooks_variables.rst
Minor edits
8 years ago
Brian Coca cf3edf0989 more examples and clearer override docs for conn
fixes #21866
8 years ago
Micah Abbott 6ea4e9f17f docks: add missing colon character
Without the missing colon character, the code block that followed
wasn't rendering properly.

Signed-off-by: Micah Abbott <miabbott@redhat.com>
8 years ago
Brian Coca bfb3467d52 more set/list stuff 8 years ago
Patrick Gagnon-Renaud d6b40c935f Fix Passlib example in FAQ (#21997)
* Fixes passlib example in FAQ to reduce the number of rounds to 5000

As stated in issue #15326, the default number for glibc is 5000, where
the default for passlib is 656000.

I actually found out when I spend few hours trying to understand why
ansible was taking almost x3 the time to run a playbook when using a
user with sudo and password (comparared to sudo with NOPASSWD set).
Well, it was because the user was created using ansible and the passlib
example found in the docs' FAQ.

Reducing the numbers of rounds to 5000 will ensure a better experience
with ansible for newcomers when using sudo with a password.

* Fixes passlib example in FAQ to reflect the API changes in passlib 1.7

Method encrypt() was deprecated in 1.7 and renamed to hash(), which
happened almost a year ago.

https://passlib.readthedocs.io/en/stable/lib/passlib.ifc.html#passlib.ifc.PasswordHash.encrypt
8 years ago
Toshio Kuratomi 9d85d81ed0 Make the metadata docs agree with what's currently implemented 8 years ago
Wouter 5d39056379 Correct link in documentation (#21894)
Fixes #20692
8 years ago
John R Barker fdd03916a3 Document ANSIBLE_METADATA (#21250)
* Document ANSIBLE_METADATA

* Formatting

* Reive feedback - WIP

* notes about Declarative

* fix headings

* Use field lists

* typo

* review feedback

* Imports

* typo

* Toshio's feedback
8 years ago
jhawkesworth d0278d1d1e [WIP] documentation: Remove assemble from list of windows modules, plus tweaks (#21859)
* Remove assemble from list of windows modules, but advise you can delegate appropriate modules to localhost.  Try to fix list of usable on windows modules to appear as a list instead of on one line.

* Update intro_windows.rst

Minor edit
8 years ago
Daniel d18bb96e88 Make pull-request sentence less ambiguous (#21802) 8 years ago
John R Barker 48c6dd2689 Point to cloud/amazon/GUIDELINES.md in main repo (#21780) 8 years ago
Matt Davis 67f74bbc81 CHANGELOG/roadmap updates for Windows 8 years ago
Robin Schneider 3700bcb6dd Use HTTPS instead of legacy HTTP for ansible.com (#16870)
Mechanical edit done by this "one-liner":

```Shell
git ls-files -z "$(git rev-parse --show-toplevel)" | xargs --null -I '{}' find '{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's#http://(www\.|galaxy\.|)ansible\.com#https://\1ansible.com#g;'
```

Related to: https://github.com/ansible/ansible/issues/16869
8 years ago
Michael Scherer 6fae1d2bbf Make password lookup treat /dev/null as a special case
I have from time to time a need of random password without
wanting to write them down (one example is mailman list creation,
that requires a password to be given to be sent to the list owner).

But using /dev/null do not return null, but the empty string, which
doesn't generate a password at all and so do not achieve my use case.
8 years ago
Toshio Kuratomi d7b7cbac1a Move to using a requirements.txt to install the python packages. (#21430)
Move to using a requirements.txt to install the python packages.

This makes it easy to keep the documentation and actual package
dependencies in sync.

Fixes #18453
8 years ago
John R Barker 53ac312382 validate-modules --arg-spec (#21331)
* validate-modules --arg-spec

* Update developing_modules_documenting.rst

* Never mock out ansible or ansible.module_utils

* No more false positives
8 years ago
Vlad Dm 32b92b53b0 service state typo 8 years ago
Pilou f2c22109fb Don't mix deprecations messages with warnings messages (#21337)
* Remove unused attribute '_passthrough'

* Don't mix deprecations with warnings

* Return values: add 'deprecations' key used internally

* 'deprecations' and 'warnings' return values: add tests
8 years ago
Peter Sprygada 58fa0bc1ea 2.3 roadmap updates for networking 8 years ago
John R Barker 0edda106f1 Delete link to test-network-modules (#21347) 8 years ago
Dylan Silva 8bf69411d9 Updated wording around support for different modules 8 years ago
927589452 a6cb377420 removed empty shell block (#21309) 8 years ago
Jeffrey Cafferata 4d0b62ede7 Update playbooks_best_practices.rst (#21288)
Updated the GitHub examples directory URL.
8 years ago
John R Barker cd6792a058 Docs partner checklist (bulk modules) (#20794)
* WIP Partners guide for adding multiple modules

* WIP

* WIP

* WIP

* WIP

* WIP

* HACK

* Revert hack

* Brian's feedback

* Remove squash notes

* Minor tidyups

* Unit & Integration tests (& minor tweaks)

* Details about Unit tests
* As we are about to feature freeze on Ansible 2.3 remove the notes about Ansible 2.4 and py2.4.
* Module names should be in the singular

* Scot & Dylan's feedback

* 5 PRs at once. Remove FIXMEs

* Formatting

* How to use Git & GitHub

* directories are in category & topic

* Expectations of Module authors

* Better wording for module author's responsibilities
8 years ago
John R Barker 959637ff59 How to document your module (#21021)
* How to document your module

* Remove blank lines

* note:: Versions should be strings

* requirements on the host that executes the module.

* option names & option values

* Feedback

* formatting

* Scott's final feedback
8 years ago
Craig Francis 2ccedc2ed9 Correct links to modules source code (#20650)
As per issue #20647, the modules are now in the main Ansible repository.
8 years ago
Pavlo Shchelokovskyy 6e875e81aa Fix docs re inventory_ignore_extensions config (#21132)
The list of ignored by default extensions is outdated in doc for dynamic
inventories, and this option is completely missing from configuration
file overview.
8 years ago
927589452 19df0e0bf5 removed a typo (#21153)
* removed a type

doubled half sentence at the end removed

* Update intro_configuration.rst

Minor wording tweak.
8 years ago
Damien b71a62283c New Module : aos_ip_pool as part of network/aos (#21044)
* Initial version of aos_ip_pool module

* Add examples for IP Pool

* Break down ip_pool into smaller function

* Refactor do_load_resource

* Add get_display_name_from_file

* Add ‘src’ as an option to load ip pool from JSON file

* Rename directory network/apstra to network/aos

* Remove exception handling temporary

* Remove all ‘Exception as XX’ to be python 2.4 compatible

* Replace ‘== False’ with ‘is False’ for PEP8 Test

* Update documentation to be Yaml compatible

* Lisg all method imported from module_utils.aos

* Refactor to align with collection.find() changes

* Update examples by @gundalow’s  recommendations

* Update Documentation per @gundalow’s recommendations

* Change the license per @gundalow recommendation

* Add exception handling for get_aos_session

* Change Auth format and add check_aos_version() to check minimum version

* Add a check for minimum version

* Refactor ‘src’ into ‘content’ to allow more options
Remove get_display_name_from_file in aos.py
Add content_to_dict in aos.py

* Fix variable name in do_load_resource

* Add mention of aos.py in module_utilities doc

* Add try/except for import yaml

* Add try/Except around main block of code and function

* Refactor to auto detect content_format, update doc accordingly

* Change create_new_ip_pool inputs

* Remove unused import

* Remove in_use as it’s never used

* Fix doc format

* Add version number in requirement doc
8 years ago
Dylan Silva 719b1fecfc [WIP] Added in bullet of Python 2.4+2.5 support discontinuation (#19264)
* Added in bullet of Python 2.4+ support discontinuation

* Update ROADMAP_2_4.rst

* Update ROADMAP_2_4.rst
8 years ago
Jordan Borean 719e1840da Added info on ntlm and credssp, updated configure script for credssp (#21175) 8 years ago
Brian Coca 5f29117e59 become options dont qualify as new anymore 8 years ago
Toshio Kuratomi a3eab4fc48 Add 2.3.0 entries for module_utils via pluginloader, selectors, and py3 (#21019)
* Add 2.3.0 entries for module_utils via pluginloader, selectors, and py3

* Add roadmap-2.3 updates and an item for roadmap-2.4
8 years ago
bverschueren 3b64bff7a5 fix missing ident in provider dict assignment (#21089)
Thanks @bverschueren!
8 years ago
John R Barker 9ddc94d0e9 Update ROADMAP_2_3.rst 8 years ago
Matt Davis 764e1cc630 update azure roadmap items 8 years ago
John R Barker 54a2be9e2e formatting 8 years ago
Adrian Likins a5d3b186ba update ansible-ssh in roadmap 8 years ago
John R Barker 965fe80f1a formatting 8 years ago
Jason McKerr 6a6f13a5bd Update ROADMAP_2_3.rst 8 years ago
Jason McKerr 64a3c8f9de Update ROADMAP_2_3.rst 8 years ago
Jason McKerr 31fbc6e203 Update ROADMAP_2_3.rst 8 years ago
Ryan Brown 0de96d68f6 Update roadmap for cloud work 8 years ago
John R Barker b773b99136 developing_module status 8 years ago
Jiri Tyr 5d9dd5934a Making the decoration more clear (#20931) 8 years ago
Matt Clay 22db51f15c Update Testing and CI section of 2.3 roadmap. 8 years ago
Brian Coca a2c38c47aa added docs for vault and made trigger shorter: !vault (#20985)
* added docs for vault and made trigger shorter: !vault

* added single var valuting

* Update playbooks_vault.rst

Edit pass for spelling and grammar. Ship it!

* Update playbooks_vault.rst

Typo fixes.
8 years ago
Adrian Likins 9703b0ff39 Add 'Improve testing of setup.py/facts.py' to 2.4 roadmap 8 years ago
John R Barker b038aad173 make webdocs speedup is done 8 years ago
Toshio Kuratomi 1df7d95cec Module utils default path (#20913)
* Make the module_utils path configurable
* Add a config value to define the path site module_utils files
* Handle module_utils that do not have source as an error
* Make an integration test for module_utils envvar working
* Add documentation for the ANSIBLE_MODULE_UTILS config option/envvar
* Add it to the sample ansible.cfg
* Add it to intro_configuration.
* Also modify intro_configuration to place envvars on equal footing with
  the config options (will need to document the envvar names in the
  future)
* Also add the ANSIBLE_LIBRARY use case from
  https://github.com/ansible/ansible/issues/15432 so we can close out
  that bug.
8 years ago
rektide 1df14ed121 Update loop docs to also describe register:'s value when inside loop. (#20991) 8 years ago
John R Barker 8d5f4dda06 Roadmap is draft (#20970)
The keyword is "draft",  not "final".
8 years ago
Brian Coca 114ef96572 added example keyring looukp 8 years ago
Scott Butler a002dca42d Edited for grammar, punctuation and spelling 8 years ago
Sebastian a8c038383e Update intro_installation.rst (#20854)
Added command to install the repository key to prevent errors
8 years ago
Albert Mikaelyan b89f222028 Some better explanation to release cycle 8 years ago
John R Barker 9bc4a12ae5 No more split repos (#20804)
* All bugs go to into `ansible/ansible`
* Issue template is automatically added when raising a new issue, so no manual steps needed
8 years ago
Matt Clay 10d9318de7 PEP 8 indent cleanup. (#20800)
* PEP 8 E121 cleanup.

* PEP 8 E126 cleanup.

* PEP 8 E122 cleanup.
8 years ago
Matt Clay d913f69ba1 PEP 8 W291 whitespace cleanup. 8 years ago
scottb 13fc909058 Refurbish developing modules content - stage 1 (#20673)
* Revamping module development docs - work in progress

* Refurb of developing modules content continues.

* Developing modules refurb work continues

* Continued refurb of developing modules content. Work-in-progress.

* Ibid

* Dev guide content refurb continues - WIP

* Ibid.

* Removed reference to old extras module repo

* Tweaks

* Removed some non-intro material; added link to github module PRs.

* Incorporated review feedback from @gundalow and @tkuratomi; fixed some links; renamed '*contributing' to '*checklist'
8 years ago
pietro 8c3b915721 Fix versionadded on math filters section (#20674)
Extra character was breaking the rendering of the file.
8 years ago
Brian Coca af59781b56 removed core/extras ref from module pages
fixes #20647
8 years ago
Brian Coca e5f7a22215 clarified tag usage 8 years ago
Sumit Kumar 9283772e54 Add doc_fragment and module util for NetApp platforms (#19607)
* Add doc_fragment and module util for NetApp platforms

* Make requested changes

* Fix links and change formatting.

* Fix description sections.
8 years ago
Matt Davis 06353c055a winrm managed kinit (#20416) 8 years ago
Brian Coca 9db1cfebbc docs fixes
fixed version number
updated C year
8 years ago
Jonathan Sabo 6a6fb28af5 Updating credstash link to the new link (#20598)
We changed the name of the github repo awhile back and I noticed it was out of date in the docs.
8 years ago
Adrian Likins d7615f68c4 Docs cleanup (#20517)
* build-site.py is no longer used, remove

Replacement is using the standard sphinx-build script.
Makefiles already use that, but standalone use of
build-site.py is no longer needed.

* build.sh no longer used in docs build
8 years ago
Brian Coca 216e2c8813 leaving os immediate 8 years ago
Brian Coca 0803c638bb set cpus only if not set already 8 years ago
Brian Coca c95bd7d9b0 fixed escape again 8 years ago
Toshio Kuratomi e7505220d4 Need to define the OS variable at this level too 8 years ago
Brian Coca 2a5d949c52 corrected path to edit docs on devel to new loc
fixes #20474
8 years ago
Will Thames 75a7ebe900 Deprecate ec2_vpc module (#20344)
* Deprecate ec2_vpc module

The deprecation of ec2_vpc module has been discussed for
2 years and is causing duplication of effort as changes
are implemented for ec2_vpc rather than for the newer
alternatives

* Improve module deprecation documentation

Update the developing modules documentation with the latest
instructions on how to deprecate a module.
8 years ago
Brian Coca 339312a6b4 added missing file to cleanup 8 years ago
Brian Coca e2a871b49e corrected which app adds plugins 8 years ago
Brian Coca 712be24a74 Doc fixes (#20353)
* cleanup to reflect current builds

* consolidate templating docs and minor rewording

* new templating intro page

* fixed warnings as per feedback

* Update playbooks_filters.rst

Edited for clarity.

* Update playbooks_templating.rst

Light edits
8 years ago
Sascha Vogt abe46dd75f Fix double colon which fixes block rendering
the 'EXPORT ANSIBLE_NOCOWS=1' rendering is broken due to a double colon in the paragraph above
8 years ago
Klaus Ethgen ae57b95313 Documentation fix (#20198) 8 years ago
Brian Coca c129fd7c81 added clarification on directives/blocks 8 years ago
Brian Coca 497347d600 fixed phrasing on 0 being non error 8 years ago
Adrian Likins 960be799fd Use correct path for docsite src (rst/) 8 years ago
Adrian Likins 3645893a5b update path to _themes 8 years ago
Scott Butler 1c8b85a6f1 Added support statement for older releases. 8 years ago
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.
8 years ago
Adrian Likins b3e7794c08 Fix docs/api paths so api docs build (#20240)
Add a 'webdocs' target to docs/api to be consistent
with docsite/
8 years ago
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'
8 years ago
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.
8 years ago
Brian Coca 4b3977d5af added note about custom modules/plugins in roles 8 years ago
Brian Coca 2538383cf4 updated docs to make clear new option scope
this does not affect user tasks with `setup`
8 years ago
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
8 years ago
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.
8 years ago
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.
8 years ago
scottb 745219d200 Update playbooks_lookups.rst
Edited.
8 years ago
Brian Coca f9f99ddfbc updated docs to suggest quote filter for shells
Also changed comments into -name in examples where appropriate.
8 years ago
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.
8 years ago
Jasper Lievisse Adriaanse 073c4df790 Update references to Passlib as homepage/docsite moved (#20082) 8 years ago
Brian Coca 54800ea47c better sections for module return docs 8 years ago
Brian Coca 0aad46c85b corrected common headers 8 years ago
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
8 years ago
Toshio Kuratomi 08d6990e67 Fix code-blocks to use correct syntax highlighting 8 years ago
Toshio Kuratomi adb7426c0c Some more code-block fixes 8 years ago
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
8 years ago
Brian Coca 3b2a4c1955 fixed porting guide headers 8 years ago
Toshio Kuratomi 1be3ac36df Fix block highlighting
Found out that we change the default highlighting to yaml.
So explicitly mark python code blocks as such.
8 years ago
John R Barker ebc8b927ce Fix RST Errors 8 years ago
Rodolfo Carvalho 8f3c435b27 Fix path to test plugin examples 8 years ago
Brian Coca d108a6f0fc fixed webdoc generation 8 years ago
Brian Coca 57f8b791d6 consolidated docs
point to new doc locations
removed non existing dirs
8 years ago
Carlos E. Garcia 0b8011436d minor spelling changes 8 years ago
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
8 years ago
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.
8 years ago
Brian Coca db8c952ee3 added new ksu method to man page
removed runas refrences, because it was never implemented
8 years ago
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.
8 years ago
Andrew Gaffney 4fd87f2dc6 Fix typo on -K/--ask-become-pass option in 'ansible' man page (#16667) 8 years ago
Shota 47f715fb37 Fix some typos (#16498) 8 years ago
Brian Coca dae0b833f5 updated man page with new pull options 8 years ago
Scott Radvan 72ca3b2b5b add very minor punctuation fixes (#15763) 8 years ago
Brian Coca e0573d3099 make vi the default editor if no EDITOR
fixes #15577
9 years ago
Tegan Snyder bf0da4aa3c add centrify dzdo escalation (#15219)
add dzdo context, and test
9 years ago
Brian Coca 0c92ec5e8f proposals were moved to ansible/proposals 9 years ago
Brian Coca 0cabef19ad updated man pages with imssing become option
also moved -K to become password to align with current code
fixes #15123
9 years ago
Brian Coca 92c887d1ed Merge pull request #14730 from chouseknecht/docker_image_proposal
Upated docker_image_module proposal
9 years ago
Brian Coca 4a01a5fbce Merge pull request #14733 from chouseknecht/docker_files_proposal
Adding docker_files module proposal.
9 years ago
Abhijit Menon-Sen f82639e4a2 Fix the other typo from #15036 9 years ago
Brian Coca 95495a6b38 fixed typo
fixes #15036
9 years ago
Greg DeKoenigsberg 03300e99ac Merge pull request #14929 from robynbergeron/devel
update proposals proposal
9 years ago
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.
9 years ago
Brian Coca a302ba0ab4 Merge pull request #14810 from chouseknecht/docker_network_proposal
Updating docker_network module proposal
9 years ago
Brian Coca 7c18dfbd5a Merge pull request #14799 from chouseknecht/auto_role_install_prop
14604 - Adding suggested comments related to securing Galaxy role ver…
9 years ago
Brian Coca d23c7949eb Merge pull request #14842 from resmo/patch-4
proposal: publish/subscribe for handlers
9 years ago
René Moser 66cb77107b proposal: publish/subscribe for handlers 9 years ago
René Moser d361f3b44e proposal: re-run handlers 9 years ago
chouseknecht efd02020a2 Updating docker_container module proposal 9 years ago
Brian Coca 1b96454d8e Merge pull request #14796 from resmo/patch-3
prop: ignore_checkmode is a better name
9 years ago
René Moser 130c995208 proposal: ignore_checkmode is a better name
as suggested by @bcoca
9 years ago
chouseknecht f389709558 Updating docker_network module proposal 9 years ago
chouseknecht 3d0637292c Update to docker_container module proposal 9 years ago
Robyn Bergeron 69a144bfbe Update proposals proposal with PR link 9 years ago
Robyn Bergeron 08777fdecd Create proposals_process_proposal.MD
Created proposals process proposal. Inception!
9 years ago
chouseknecht 11c1814146 14604 - Adding suggested comments related to securing Galaxy role versions 9 years ago
Brian Coca 171c925966 Merge pull request #14756 from chouseknecht/docker_network_proposal
Updating docker_network module proposal.
9 years ago
Brian Coca e438a26ada Merge pull request #14760 from yyoshiki41/docs-tag
Fixed docs typo
9 years ago
chouseknecht 6edf1443db Adding docker_files module proposal 9 years ago
yyoshiki41 64f445f3a1 Fixed docs typo 9 years ago
chouseknecht 485bd4acc3 Fix docker_volume module proposal file name. 9 years ago
chouseknecht d85589121e Updating docker_network module proposal. 9 years ago
Brian Coca ab182b2bdb Merge pull request #14726 from chouseknecht/docker_one
Updating docker_container_module proposal
9 years ago
Brian Coca ea71352bea Merge pull request #14731 from chouseknecht/docker_image_facts_proposal
Updated docker_image_facts module proposal.
9 years ago
Brian Coca 15c938f2a2 Merge pull request #14740 from chouseknecht/docker_volume_facts_proposal
Adding docker_volume_facts module proposal
9 years ago
Brian Coca 4b5bb5dd89 Merge pull request #14739 from chouseknecht/docker_network_facts_proposal
Adding docker_network_facts module proposal.
9 years ago
Brian Coca 2a1f955ea5 Merge pull request #14737 from chouseknecht/docker_network_proposal
Adding docker_network module proposal.
9 years ago
Brian Coca cc6adf44b6 Merge pull request #14738 from chouseknecht/docker_volume_proposal
Adding docker_volume module proposal
9 years ago
René Moser 26005dfa5b proposal: deprecate always_run in favor of checkmode_run 9 years ago
chouseknecht e0f41c7726 Updated docker_image_facts module proposal. 9 years ago
chouseknecht f10807eb42 Adding docker_network_facts module proposal. 9 years ago
chouseknecht d0137abf98 Adding docker_volume_facts module proposal 9 years ago
chouseknecht 3e1332495b Upated docker_image_module proposal 9 years ago
chouseknecht 76766aac8b Adding docker_network module proposal. 9 years ago
chouseknecht 804c6f9c09 Adding docker_volume module proposal 9 years ago
chouseknecht b2dd22e9f2 Updating docker_container_module proposal 9 years ago
chouseknecht 78f4d33c94 Add docker_container module proposal. 9 years ago
chouseknecht 66756078f3 Updated auto-install-roles proposal. 9 years ago
Will Thames 80ec66f64a Proposal for auto updating roles
Reflects discussion on ansible-devel.
9 years ago
Maxim Burgerhout 275bd1b121 Fix a typo in man1/ansible 9 years ago
Aleksi Aalto aea8900abe document exit status for ansible-playbook 9 years ago
Denis 4e95c9f1eb Fix typos. 9 years ago
James Cammarata 76b4b9ed2c Merge pull request #13501 from chouseknecht/galaxy-2.0-update
Galaxy 2.0 update
9 years ago
Robin Roth 0c954bd142 add --full flag to ansible-pull man page
add --full flag that was added in #13502
9 years ago
chouseknecht 06dde0d332 Fixed documentation typos and bits that needed clarification. Fixed missing spaces in VALID_ACTIONS. 9 years ago
chouseknecht bc73920090 Updated ansible-galaxy man page. Removed -b option for import. 9 years ago
Brian Coca 9f148fc046 removed requirement of destination and set documented default 9 years ago
Brian Coca 2e05304f66 typo fix 9 years ago
Brian Coca 8eda94c591 normalized descriptions for most man pages
also removed the intermediate man page
added intermidieate manpages to gitignore
9 years ago
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
9 years ago
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).
9 years ago
Abhijit Menon-Sen 4afe1cf422 Update ansible-vault manpage to describe new encrypt/decrypt behaviour 9 years ago
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.
9 years ago
Damian Gerow 1c5611100e Add become support for OpenBSD doas 9 years ago
snetting 15669d98ca correct ansible-playbook man1 9 years ago
snetting 4693531851 update ansible man1 9 years ago
Till Maas f36a92f729 Re-Generate man pages 10 years ago
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.
10 years ago
Chris AtLee 1bf8f78b18 Add --list-hosts to man pages.
Fixes #9574
10 years ago
Brian Coca f734306c13 Merge pull request #9859 from autotune/devel
Added description for -S flag and --ask-su-pass #9846
10 years ago
Giovanni Tirloni bcbf819a8b Add how to load extra variables directly from a file (using @). 10 years ago
mixpix3ls 8866378e89 Fixing ticket 9845: man pages contain duplicate AUTHOR section 10 years ago
autotune d052bf8276 Added description for -S flag and --ask-su-pass 10 years ago
Toshio Kuratomi fa51e8f36d Document the --offline parameter to galaxy init
Fixes #9758
10 years ago
Michael Scherer 9c10a11aea Fix the synopsis in ansible-pull man page. 10 years ago
Michael DeHaan e43ae3c0f7 Update test strategies guide. 10 years ago
Cristian Ciupitu 7cb4b7ab89 Fix typos in ansible-playbook man page source
Note: the man page needs to be rebuilt.
11 years ago
James Tanner 33eec0dc55 Fixes #6398 Add missing parameters to ansible-playbook manpage 11 years ago
James Cammarata 12c812f030 Adding a man page for ansible-vault
Fixes #6471
11 years ago
James Cammarata ba4fbd2b66 Adding man page for ansible-galaxy
Partially resolves #6471
11 years ago
James Cammarata 6f405c8970 Updated footer date and adding in misc. file generated by earlier doc update 11 years ago
Maykel Moya 0b1320e48c Update doc, irc and mailing list information in manpages input 11 years ago
Maykel Moya 06beddfe68 Fix documentation url 11 years ago
Maykel Moya 0b44a3e54f Minor grammar fix in manpages 11 years ago
Michael DeHaan 388365b90a Add reference to Guru to sidebar. 11 years ago
Matthew Phipps d78951e767 Add skip_tags to ansible-playbook man page 11 years ago
Michael DeHaan 0882eefdff Merge conflict 11 years ago
Michael DeHaan 2f811c40d7 Basic docsite formatting fixups 11 years ago
Michael DeHaan fdb8505a5e Add ansible-pull's -o to the manpage. 11 years ago
Michael DeHaan 52b2cfedfc Add release history for 1.4.1 into 1.5 branch. 11 years ago
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.
11 years ago
jctanner 2d9087b806 Merge pull request #4484 from mscherer/add_short_hostname
ansible-pull by default will look for local.yml and $fqdn.yml.
11 years ago
jctanner 127efdf3ef Merge pull request #4576 from mscherer/pull_temporary_dir_2
add a default value for the -d option of ansible-pull
11 years ago
Ray b5266a562d minor correction
Same doc-typo (confirmed) as https://github.com/ansible/ansible/pull/4759

--remote-user  *should be*  --user
11 years ago
Ray a66f0462cd minor correction
--remote-user= does not work:
 ansible: error: no such option: --remote-user

--user= does. Updating docs
11 years ago
Michael DeHaan ad5731b4a8 Add module utils path to setup.py 11 years ago
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.
11 years ago
Michael Scherer 92147aff0f also fix the doc, forgot in last commit 11 years ago
James Cammarata 97e3e967a7 Merge branch 'devel' of https://github.com/jflorian/ansible into jflorian-devel 11 years ago
James Cammarata 8283183023 Adding sshpass as packaging requirement and fixing VERSION 11 years ago
John Florian c8a5aabf39 Added -f/--force option to ansible-pull 11 years ago
Stephen Fromm 77b8ee1f84 Update ansible-pull man page doc (issue #3372) 11 years ago
Michael DeHaan f0d7324e25 Merge pull request #3094 from sfromm/issue2464-redux
Updates to ansible-pull and ansible-pull docs
11 years ago
Michael DeHaan 4ae3ef8af9 Disable inventory test 11 years ago
Stephen Fromm a611027329 Update ansible-pull documentation 11 years ago
Michael DeHaan b19609b98b Slight docs tweak 11 years ago
Michael DeHaan 0837c9785f Merge pull request #3040 from bfabio/devel
Support JSON in --extra-vars.
11 years ago
Michael DeHaan 267b29cec7 Manpage tweaks, docs rebuild 11 years ago
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.
11 years ago
Michael Vogt d7b5b47efe improve wording, thanks to Michael DeHaan 11 years ago
Michael Vogt 22b0cf9275 use the same text for -M in ansible.1 and ansible-playbook.1 11 years ago
Michael Vogt 8338e75463 document in the man-page that {ansible,ansible-playbook} -M can also be overriden with the ANSIBLE_LIBRARY environment 11 years ago
Michael DeHaan aa4ad80bda Update release version. 12 years ago
Yves Dorfsman 8b10cc5946 Mention of ansible-doc and man pages for modules. 12 years ago
r-p-e 1f1eb4125f align manpages with actual code for --syntax-check 12 years ago
Michael DeHaan 2a66185920 update manpage for new options. 12 years ago
Oscar Korz ba807ed5a8 Correct -u description in ansible man page 12 years ago
Michael DeHaan 318e3302fb Fix up some version related things on the devel branch. 12 years ago
Michael DeHaan 70bb7d1e54 Merge pull request #1696 from gregorg/enhance_limit
Allow regex to be used to select hosts in addition to fnmatch pattern
12 years ago
Gregory Duchatelet ba4f71db27 Moved docs about "--limit=~REGEX" from man page to asciidoc. 12 years ago
Gregory Duchatelet 8bc1b69c58 Add a unit test to subset limiting via a regex, and some doc in man
page.
12 years ago
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
12 years ago
Michael DeHaan 6a5df97393 Manpage documentation ALSO should be sorted 12 years ago
Fabian Arrotin 96770a3057 - Fixed some typos for the ansible config file
- added the ANSIBLE_CONFIG environment variable
12 years ago
Michael DeHaan 5bdc16338e Release version bump for 0.9 (development branch) 12 years ago
Michael DeHaan aa98c84a62 HP and vsphere modules are crazy awesome but I am thinking these belong in contrib not core. 12 years ago
Michael DeHaan 70ed560fb3 Add FILES to manpage 12 years ago
Michael DeHaan 6d2f003ceb Update formatter to not include orange blocks all over docsite page 12 years ago
Michael DeHaan dbeb26ad6d Don't check in modules.js either 12 years ago
Michael DeHaan fc9a6bb07c Docs/json should not be checked in 12 years ago
Marco Vito Moscaritolo ee679c0190 Unified document generator and make to generate JSON and JS files 12 years ago
Tim Bielawa 9541b47b52 Keep the man3 directory. 'make docs' breaks without it. 12 years ago
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.
12 years ago
Michael DeHaan 4a95194424 Docs rebuild in new project structure. 12 years ago
Jan-Piet Mens a9dad7f3bd remove duplicate private-key option from manpage 12 years ago
Michael DeHaan 761330b125 Fix module formatter indexing 12 years ago
Tim Bielawa 85fb7c6d4b Library functions and modules should be in the 3 man page section. Also the files should end in '.3' 12 years ago
Michael DeHaan 53d24ef002 Check in generated manpage documentation from modules 12 years ago
Michael DeHaan 31a4fe412f Complain when modules do not have documentation. 12 years ago
Jan-Piet Mens d47e15a1f2 module_formatter in hacking/ 12 years ago
Michael DeHaan 975c323e39 Release version bump 12 years ago
Michael DeHaan 4920533c05 Add --limit to manpage 12 years ago
Tim Bielawa 698bcaa581 Fully document the -v option. 12 years ago
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
12 years ago
Tim Bielawa bf7e83bea6 Update man pages and the message for an exception. 12 years ago
Michael DeHaan 6ea022de01 docs build 12 years ago
Michael DeHaan 8fa4dc3920 Small change to previous patch, make ranges of hosts inclusive. 12 years ago
Chin Fang e3b2521f01 Added a host expansion feature to ansible's inventory parsing 12 years ago
Michael DeHaan a490213d45 Release bump to start development on 0.6 12 years ago
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.
12 years ago
Michael DeHaan da3816d370 Move version files to 0.5 for devel branch 13 years ago
Michael DeHaan 8e8cde3a2c override hosts gone 13 years ago
Michael DeHaan eda2333b24 Update manpage to mention -U (--sudo-user). 13 years ago
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.
13 years ago
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
13 years ago
Tim Bielawa 621dc83ac2 Fix man page option description indentation. 13 years ago
Tim Bielawa d43cf592eb Renaming asciidoc sources to .in.
Change manpages to build from *.in and add comments about how the make
targets work.
13 years ago
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
13 years ago
Michael DeHaan 9ce27be878 Remove extra_vars tests 13 years ago
Michael DeHaan b24ec71ca3 Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook 13 years ago
Michael DeHaan 579bd1d417 manpage updates 13 years ago
Michael DeHaan c3cad50075 Update manpages, fix missing variable assignment 13 years ago
Stephen Fromm b506567c37 Update ansible.1 manpage for option -c, --connection 13 years ago
John Eckersberg 5aad4bacc7 Bump release to 0.0.2 13 years ago
Tim Bielawa 446ba1795a Show when options require arguments in the man pages. 13 years ago
Michael DeHaan f1c8fc63cb host file must be marked config(noreplace), update rpm build to use checked in manpage src 13 years ago
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).
13 years ago
Michael DeHaan ee69bd18cc Add -T to playbook manpage 13 years ago
Michael DeHaan 6660a5efbd add polling info to manpage 13 years ago
Tim Bielawa 3f245498c4 Fixup RPM building: Makefile, Spec File, .gitignore
Fixup distutils: setup.py

Clean old cruft: section 5 man pages
13 years ago
Michael DeHaan 209760f8f6 Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site. 13 years ago
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.
13 years ago
Michael DeHaan fb3bfa1c51 Tweak the matrix 13 years ago
Michael DeHaan 9c5341116b Update to comparison matrix 13 years ago
Michael DeHaan ee6db0531b Attempt at adding more comparison info 13 years ago
Michael DeHaan 937de08794 HTML test 13 years ago
Michael DeHaan 06d3cc930d This was supposed to be markdown with embedded HTML 13 years ago
Michael DeHaan 077e4f2381 Added start of comparison table so it's easy to explain at a glance what this project is. 13 years ago
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}.
13 years ago
Tim Bielawa 6343aa6214 Add environment updating script 'env-setup' to facilitate running ansible from a git checkout. 13 years ago
Tim Bielawa e9ae5eb9d5 Correct see-also in playbook manpage 13 years ago
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.
13 years ago
Michael DeHaan 847846af0e -p has been replaced by a required option. Various docs changes. 13 years ago
Michael DeHaan 4ce1f1dd5e README/doc/example updates to go with group support and CLI option changes.
Minimizing manpage until CLI options stabilize.
13 years ago
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
13 years ago
Michael DeHaan d8b5e667d8 Doc rebuild 13 years ago
Michael DeHaan 442c2488ba Minor playbook doc updates 13 years ago
Michael DeHaan d0906e187f Correct file location error in example 13 years ago
Michael DeHaan 058fa5bd15 Manpage and doc updates 13 years ago
Michael DeHaan 6fcce9a97e rebuild manpage due to license change 13 years ago
Michael DeHaan be4cb64c92 Relicensing to GPLv3, all previous committers ok'd on mailing list. 13 years ago
Michael DeHaan c0b4c80ba1 Docs rebuild 13 years ago
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?
13 years ago
Michael DeHaan 28afd7208e Try once more. 13 years ago
Michael DeHaan 03bf465c3a attempt to fix asciidoc so it shows up on github 13 years ago
Michael DeHaan f3246fb72e Remove 'pending' comment. 13 years ago
Michael DeHaan 4201865bba Add note about facter/ohai integration into module docs. 13 years ago
Michael DeHaan e766bb6a6c update manpage output 13 years ago
Michael DeHaan 155c3ca89e update playbook docs with updated syntax / minor edits 13 years ago
Michael DeHaan 2860c14bc2 module doc updates 13 years ago
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.
13 years ago
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 13 years ago
Tim Bielawa afc7f4d246 This is configuration, not command. Rename to section 5 13 years ago
Tim Bielawa 9680de37c9 Manpages formatting 13 years ago
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. 13 years ago
Tim Bielawa 86bf871e07 Fixup the naming of the docs. 13 years ago
Michael DeHaan 136d8fa33a add manpage crossreferences 13 years ago
Michael DeHaan 2262705ea3 Added stub for ansible-playbook (format) docs. Docs on ansible-playbook script TBD once
written.
13 years ago
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.
13 years ago
Michael DeHaan 4e5da11217 Revert "don't check in manpage output file"
This reverts commit 70ec508ee0.
13 years ago
Michael DeHaan 226da501d3 Take notes about other modules that are in plan. 13 years ago
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
13 years ago
Michael DeHaan 77a7ddeebc Add start of documentation for modules 13 years ago
Michael DeHaan 70ec508ee0 don't check in manpage output file 13 years ago
Tim Bielawa f0b0211772 Because everything should have a man page 13 years ago