Commit Graph

305 Commits (7d553aad2909bd4a1b218441404639b26447ce38)

Author SHA1 Message Date
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) 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
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
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