Commit graph

316 commits

Author SHA1 Message Date
Matt Davis
e4d153bd5d update WSL installation docs for current builds (#25237)
* supersedes #25224
2017-07-31 18:07:07 -07:00
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
2017-08-01 08:02:56 +10:00
Matt Clay
51bd07204b Revert "Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)"
This reverts commit 520696fb39.
2017-07-27 18:15:56 -07:00
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.
2017-07-27 17:08:31 -07:00
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
2017-07-27 15:37:26 -07:00
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
2017-07-27 14:20:18 -07:00
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.
2017-07-26 16:28:42 -07:00
scottb
058e67dcbe Minor edits. 2017-07-26 10:50:01 -04:00
Brian Coca
74e9e4bcbd updated --diff docs 2017-07-26 10:50:01 -04:00
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.
2017-07-25 23:38:08 -07:00
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
2017-07-25 19:06:59 -07:00
Andrea Tartaglia
341cf290d3 Added become_exe and become_flags docs (#19554)
* Added become_exe and become_flags docs

* Minor edits
2017-07-25 18:59:57 -07:00
Martin Krizek
9c50933a80 docs: fix community meetings link (#27264) 2017-07-25 09:23:01 -04:00
Matt Davis
9986639681 various Windows/Azure roadmap updates 2017-07-24 08:32:54 -07:00
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>
2017-07-24 08:56:46 -04:00
Sam Doran
dac519135d Change docs to reference BOTMETA.yml instead of MAINTAINERS.txt (#26912) 2017-07-21 17:51:02 -04:00
Sloane Hertel
7a8054812c updated roadmap (AWS) (#27011)
* update AWS roadmap

* Update ROADMAP_2_4.rst
2017-07-21 13:56:06 -07:00
Toshio Kuratomi
f4bb71c0df Update roadmap with python3 status (#27171) 2017-07-21 12:17:49 -07:00
Matt Clay
a53dabf664 Update testing progress on 2.4 roadmap. 2017-07-20 22:02:59 -07:00
Chris Alfonso
c19d25cf67 Updating network roadmap segment to reflect any changes we decided (#27057)
upon during our 2.4 dev cycle.
2017-07-20 08:22:19 -06:00
rgm
13e7e00706 Fix double-quote chars in passwordstore examples (#27084)
Also add link to passwordstore.org and correct a typo.
2017-07-20 12:29:29 +10:00
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
2017-07-20 11:52:21 +10:00
Adrian Likins
33a2d72290 Update facts/vault roadmap items (#27082)
* Update facts/vault roadmap items
2017-07-19 18:44:51 -04:00
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.
2017-07-19 23:14:52 +05:30
acrewdson
0a4c570153 Fix typo (#26988) 2017-07-19 08:33:04 -04:00
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
2017-07-19 06:58:52 -04:00
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.
2017-07-19 09:49:12 +05:30
Toshio Kuratomi
37e757286d Add module_utils example next to library examples (#25390) 2017-07-18 17:09:32 -07:00
Dylan Silva
913a8f864a changed freeze date for modules (#27009) 2017-07-18 14:11:15 -07:00
Matt Clay
16f796460f Fix rstcheck issue. 2017-07-18 11:42:56 -07:00
Brian Coca
3477825fc9 updated roadmap 2017-07-18 14:22:52 -04:00
Matt Clay
8e66015564 Fix rst syntax in roadmap. 2017-07-18 10:47:59 -07:00
Adrian Likins
06e49dfbbd fix roadmap, strikethough does not quite work 2017-07-18 12:58:51 -04:00
Adrian Likins
e6de059048 updating roadmap with facts status 2017-07-18 12:45:17 -04:00
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.
2017-07-14 16:52:11 -07:00
Dylan Silva
ba000abe1c Added in dates for freeze (#26814)
* Added in dates for freeze

* Update ROADMAP_2_4.rst
2017-07-14 09:30:09 -07:00
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.
2017-07-14 14:24:45 +01:00
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
2017-07-14 10:48:51 +01:00
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
2017-07-13 19:06:01 -07:00
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
2017-07-13 12:04:20 -07:00
Pilou
4b3d6dfa8a Use pycodestyle instead of pep8 (#25947) 2017-07-13 11:46:31 -07:00
Dag Wieers
cda6f602f1 Fix missing index (#26678) 2017-07-12 13:48:52 +01:00
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
2017-07-11 20:57:01 +01:00
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
2017-07-04 15:20:46 -07:00
Chiyu Zhong
505dd9fe44 Update playbooks_loops.rst 2017-07-03 22:43:31 -04:00
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
2017-06-30 20:16:26 +01:00
Helio Campos Mello de Andrade
54c64deaab Remove unnecessary 'our"word. (#26221)
Remove unnecessary 'our"word.
2017-06-29 11:22:46 -07:00
Scott Butler
ed17d7a0a5 Editing to fix wording from PR #26161. 2017-06-28 23:12:52 -07:00
Chainarong Tangsurakit
ff30682740 [cloud][gce] Add necessary key for secrets.py (#25997)
Add necessary key for secrets.py
2017-06-28 16:04:24 -04:00
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.
2017-06-28 10:06:56 +01:00
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
2017-06-26 23:10:07 -07:00
Brian Coca
8bcfb85918 display v added 2017-06-23 16:44:48 -04:00
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"
2017-06-21 23:01:41 -07:00
John R Barker
4ab4a6766e ansible-windows IRC (#25872) 2017-06-19 16:45:47 +01:00
John R Barker
5551e87755 RETURNS can include version_added (#25810) 2017-06-16 20:17:38 +01:00
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
2017-06-16 11:28:50 +01:00
Matt Martz
89c3151167 Give example of empty _meta in dyanmic inventory (#24085) 2017-06-15 09:51:34 -05:00
Sanket Jagtap
dbb3fd0e5e Formatted Dynamic Inventory link for Openstack (#25351)
* Formatted Dynamic Inventory link for Openstack

* Create intro_dynamic_inventory.rst
2017-06-15 03:00:00 -07:00
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>
2017-06-12 07:55:19 +01:00
Brian Coca
9d23dcac29 fixed version added tag 2017-06-09 14:09:14 -04:00
John R Barker
4e6fee212a Correct link to plugins (#25530) 2017-06-09 13:06:08 +01:00
Pilou
bf0d0274cf doc: PEP 8 compliance is required (#25524) 2017-06-09 12:20:56 +01:00
Dag Wieers
357069afcb Add missing modules (#25483) 2017-06-08 17:31:10 +01:00
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
2017-06-08 08:33:32 -06:00
John R Barker
217c80ba7e New IRC groups + Formatting (#25441)
* New IRC groups + Formatting

* Edits for conciseness and clarity.
2017-06-08 10:59:30 +01:00
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
2017-06-07 14:16:03 -04:00
James Cammarata
45378e71d1 Removing auto-generated doc from previous import/include commit 2017-06-06 16:54:43 -05:00
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.
2017-06-06 16:39:48 -05:00
Brian Coca
c7eaccb7b5 added delegate_to warning 2017-06-02 10:38:42 -04:00
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
2017-06-01 12:49:35 +01:00
Tyler Lubeck
d6bfc11e6d Fix formatting for rst code block (#25185) 2017-05-31 15:04:57 +01:00
Dag Wieers
47738eb1dd docs: PEP8 compliance (#24681)
- Make PEP8 compliant
2017-05-30 18:08:25 +01:00
scottb
54bdcd734e Some cleanup of the intro and getting started sections. (#25083) 2017-05-28 01:42:50 -07:00
Iain Foulds
a1709bf0f9 Correcting YAML identation (#25049) 2017-05-26 16:11:01 +02:00
Brian Coca
61060b66c2 make rst linter happy 2017-05-24 14:29:05 -04:00
scottb
f315d4260f Update playbooks_intro.rst
Edits
2017-05-24 14:29:05 -04:00
Brian Coca
70b2ceebe5 document new 'order' keyword for plays 2017-05-24 14:29:05 -04:00
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
2017-05-23 17:16:49 -04:00
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.
2017-05-23 11:10:25 +01:00
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
2017-05-19 14:37:39 -07:00
John R Barker
c9e05956b7 Update testing_units.rst (#24772) 2017-05-18 10:26:45 +01:00
Brian Coca
c7b9f2a6de added docs about url 2017-05-16 15:52:30 -04:00
Matt Clay
9178e176b5 Limit sphinx version on python 2.6. (#24678)
* Limit sphinx version on python 2.6.
* Fix issues identified by rstcheck.
2017-05-17 01:00:15 +08:00
Abhijeet Kasurde
9f3a405706 Fix URLs in dev_guide documentation (#24533)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2017-05-15 13:23:46 +01:00
Matt Davis
0f4026d626 add Windows docs for winrm automatic kerb ticket mgmt (#24456) 2017-05-10 16:22:54 -07:00
Brian Coca
91449ea231 removed autogenerated file and added to ignore 2017-05-09 11:08:01 -04:00
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.
2017-05-08 12:43:46 -05:00
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
2017-05-08 09:08:55 -07:00
Matt Clay
cec2b960f8 Fixes for pep8 and rstcheck issues. 2017-05-05 10:47:05 +08:00
scottb
02057f481b Added style guide (#24310)
* Added style guide

* Fixed index
2017-05-04 13:25:13 -07:00
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
2017-05-02 09:01:53 +01:00
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
2017-04-28 16:47:35 -04:00
John R Barker
8733253a76 Minor testing docs improvements (#24103)
Fix a few formatting issues spotted post review.
Also reapply missing commit
2017-04-28 11:58:38 +01:00
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
2017-04-28 09:08:26 +01:00
Strahinja Kustudic
66a41f59fd Add a missing leading zero in a mode parameter
600 is an incorrect mode, because mode needs to be octal.
2017-04-27 09:35:27 -07:00
Strahinja Kustudic
6dddd5b167 Remove action keyword from do-until example
`action:` is old and not needed any more.
2017-04-27 09:34:46 -07:00
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
2017-04-26 19:57:21 -07:00
scottb
946658cd24 Update playbooks_python_version.rst
Minor edits
2017-04-25 12:26:40 -07:00
Toshio Kuratomi
78dd3496e2 Update version and change remove files from pep8 blacklist 2017-04-25 12:26:40 -07:00
Toshio Kuratomi
82ad8ff081 Add documentation of Jinja2 templating idioms that differ when run under Python3
Fixes #19514
2017-04-25 12:26:40 -07:00