Commit Graph

457 Commits (13adee7f44c856245c078e8af9b75d06ff548b56)

Author SHA1 Message Date
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
7 years ago
John R Barker 8733253a76 Minor testing docs improvements (#24103)
Fix a few formatting issues spotted post review.
Also reapply missing commit
7 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
7 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.
7 years ago
Strahinja Kustudic 6dddd5b167 Remove action keyword from do-until example
`action:` is old and not needed any more.
7 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
7 years ago
scottb 946658cd24 Update playbooks_python_version.rst
Minor edits
7 years ago
Toshio Kuratomi 78dd3496e2 Update version and change remove files from pep8 blacklist 7 years ago
Toshio Kuratomi 82ad8ff081 Add documentation of Jinja2 templating idioms that differ when run under Python3
Fixes #19514
7 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
7 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
7 years ago
David Mahler 09b247dd34 Minor grammatical corrections and improvements (#23886) 7 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
7 years ago
Eric Anderson 6aab341248 changed code block formatting to match format (#23615) 7 years ago
Adam Johnson f1c4b434cd Tidy example inventories in "Developing Dynamic Inventory Sources" (#18758)
Thanks @adamchainz!
7 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
7 years ago
Alexander Gubin d04a5246de Fix example fact(ansible_default_ipv4.address) for delegated_facts 7 years ago
John R Barker 33d7c12a97 Improve network debug wording (#23735) 7 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.
7 years ago