Commit Graph

730 Commits (f4dc8596fa555125494ba62c01f3b16ff7c4575a)

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
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
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
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
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
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 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
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
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
8 years ago
Chiyu Zhong 505dd9fe44 Update playbooks_loops.rst 8 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
8 years ago
Helio Campos Mello de Andrade 54c64deaab Remove unnecessary 'our"word. (#26221)
Remove unnecessary 'our"word.
8 years ago
Scott Butler ed17d7a0a5 Editing to fix wording from PR #26161. 8 years ago
Chainarong Tangsurakit ff30682740 [cloud][gce] Add necessary key for secrets.py (#25997)
Add necessary key for secrets.py
8 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.
8 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
8 years ago
Brian Coca 8bcfb85918 display v added 8 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"
8 years ago
John R Barker 4ab4a6766e ansible-windows IRC (#25872) 8 years ago
John R Barker 5551e87755 RETURNS can include version_added (#25810) 8 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
8 years ago
Matt Martz 89c3151167 Give example of empty _meta in dyanmic inventory (#24085) 8 years ago
Sanket Jagtap dbb3fd0e5e Formatted Dynamic Inventory link for Openstack (#25351)
* Formatted Dynamic Inventory link for Openstack

* Create intro_dynamic_inventory.rst
8 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>
8 years ago
Brian Coca 9d23dcac29 fixed version added tag 8 years ago
John R Barker 4e6fee212a Correct link to plugins (#25530) 8 years ago
Pilou bf0d0274cf doc: PEP 8 compliance is required (#25524) 8 years ago
Dag Wieers 357069afcb Add missing modules (#25483) 8 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
8 years ago
John R Barker 217c80ba7e New IRC groups + Formatting (#25441)
* New IRC groups + Formatting

* Edits for conciseness and clarity.
8 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
8 years ago
James Cammarata 45378e71d1 Removing auto-generated doc from previous import/include commit 8 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.
8 years ago
Matt Davis 365d06c538 add Makefile target for single HTML page (#25313) 8 years ago
Brian Coca c7eaccb7b5 added delegate_to warning 8 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
8 years ago
Tyler Lubeck d6bfc11e6d Fix formatting for rst code block (#25185) 8 years ago
Dag Wieers 47738eb1dd docs: PEP8 compliance (#24681)
- Make PEP8 compliant
8 years ago
scottb 54bdcd734e Some cleanup of the intro and getting started sections. (#25083) 8 years ago
Iain Foulds a1709bf0f9 Correcting YAML identation (#25049) 8 years ago
Brian Coca 61060b66c2 make rst linter happy 8 years ago
scottb f315d4260f Update playbooks_intro.rst
Edits
8 years ago
Brian Coca 70b2ceebe5 document new 'order' keyword for plays 8 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
8 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.
8 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
8 years ago
John R Barker c9e05956b7 Update testing_units.rst (#24772) 8 years ago
Brian Coca 7bb0a8d4fc added order doc for inventory keyword 8 years ago
Brian Coca c7b9f2a6de added docs about url 8 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.
8 years ago
Abhijeet Kasurde 9f3a405706 Fix URLs in dev_guide documentation (#24533)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
8 years ago
Matt Davis 0f4026d626 add Windows docs for winrm automatic kerb ticket mgmt (#24456) 8 years ago
Brian Coca 91449ea231 removed autogenerated file and added to ignore 8 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.
8 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
8 years ago
Matt Clay cec2b960f8 Fixes for pep8 and rstcheck issues. 8 years ago
scottb 02057f481b Added style guide (#24310)
* Added style guide

* Fixed index
8 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
8 years ago
Brian Coca 033fe5548b added epub entry for makefile 8 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