Commit graph

1404 commits

Author SHA1 Message Date
Bianca Henderson
89a9bc0488 Change intro portion of Testing page (#48692)
* Change intro portion of Testing page
2018-11-20 09:43:53 -05:00
Felix Fontein
891687284f docker_* modules: improve diff (#48546)
* Add difference tracking tool

* Improve --diff mode for docker_container.

* Improve diffs of sets by ordering the sets.

* Rewrite imports, get rid of HAS_DOCKER_PY_x variables and use docker_version instead.

* Rename container -> active (more generic).

* Add --diff for docker_volume. Change old diff output.

* Add --diff for docker_network. Change old diff output.

* Add --diff for docker_swarm_service.

* Add changelog.

* Add entry for porting guide on docker_network and docker_volume.
2018-11-19 09:59:54 +00:00
Bojan Vitnik
b0cc240665 New module: xenserver_guest - manages XenServer VMs (#41041)
* XenServer related modules - initial commit

 - New module_util: xenserver. Contains common module arguments, functions
   and classes useful for future XenServer related modules.
 - New module_docs_fragment: xenserver. Describes common module arguments.
 - New module: xenserver_guest. Supports VM deployment, reconfiguration,
   removal, detection of changes, state management, fact gathering and
   Ansible check mode. Module is fully documented.
 - Updated: developing_module_utilities.rst.
 - Module params, workflow and some functions are based on or taken from
   vmware_guest module.

* Implemented support for configuring custom VM params in xenserver_guest module

* Compatibility fixes and documentation update

 - xenserver module_util: implemented support for XenAPI.py version older
   than 7.2.
 - xenserver module_util: PEP8 fixes.
 - xenserver module_util: Added missing imports.
 - xenserver module_util: Copyright notice fixes.
 - xenserver_guest module: updated module documentation with notes regarding
   module requirements and compatibility.
 - xenserver_guest module: bumped version_added to 2.7.
 - xenserver_guest module: minor fixes.

* VM power state management refactoring, subargument specs in xenserver_guest module, other fixes

 - VM power state management code moved from xenserver_guest module to xenserver
   module_util (set_vm_power_state function).
 - Code for waiting for VM IP address moved from xenserver_guest module to
   xenserver module_util (wait_for_vm_ip_address function).
 - xenserver module_util: implemented get_object_ref function to clean up
   a lot of repeated code in xenserver_guest module.
 - xenserver module_util: added additional aliases 'host' and 'pool' for
   'hostname' common module argument. They are more in line with what
   XenServer users are familiar with.
 - xenserver module_util: minor fixes.
 - xenserver_guest module: removed VM state management other than 'present',
   'absent' and 'poweredon'. Other states are to be managed by separate module.
 - xenserver_guest module: added subargument specs and cleaned up custom code
   for subargument validation.
 - xenserver_guest module: reorganized code for disk and network reconfiguation
   to minimize code duplication.
 - xenserver_guest module: renamed 'cdrom.iso' module argument to
   'cdrom.iso_name', avoids cryptic error message when parameter is
   missing.
 - xenserver_guest module: documentation update.
 - xenserver_guest module: changes in error messages.
 - xenserver_guest module: minor fixes.

* Implemented guest OS network parameter configuration and other

 - xenserver module_util: moved code for validating MAC addresses from
   xenserver_guest module and implemented a range of functions for validating
   IP addresses and related entities and converting prefixes to netmasks and
   vice versa.
 - xenserver module_util: updated fact gathering code to support guest OS
   network parameters.
 - xenserver module_util: added docstrings.
 - xenserver module_util: minor changes.
 - xenserver_guest module: implemented support for guest OS network parameter
   configuration.
 - xenserver_guest module: changed CD-ROM handling code.
 - xenserver_guest module: changed so that user friendly version of changes
   list is always returned in module result.
 - xenserver_guest module: error message changes.
 - xenserver_guest module: added docstrings.
 - xenserver_guest module: documentation update.
 - xenserver_guest module: minor changes and fixes.

* Various fixes and code cleanup

 - xenserver module_util: implemented get_xenserver_version function.
 - xenserver module_util: moved customization agent detection code to
   gather_vm_params function. customization_agent variable is now part of
   vm_params. An exception in customization agent detection code that prevented
   deployment of new VMs is also fixed.
 - xenserver module_util: added support for alternative VM state names with
   dash and underscore in set_power_state function.
 - xenserver_guest module: removed customization agent detection code
   as it is now implemented in xenserver module_util.
 - xenserver_guest module: fixed a bug in xenserver_data update code that
   occured when "networks.mac" was not specified in module params and
   other fixes.
 - xenserver_guest module: some code cleanup.
 - xenserver_guest module: bumped version_added to 2.8.
2018-11-19 01:50:20 -05:00
Matt Clay
8066acc90c
Support skip of platforms by version in tests. (#48826)
* Support skip of platforms by version in tests.

Previously a remote platform could be skipped completely using the alias:

`skip/{platform}` such as `skip/rhel`

Now a specific platform version can be skipped using the alias:

`skip/{platform}{version}` such as `skip/rhel7.6`

This feature is available for platforms specified with the `--remote` option.

* Add skip by version to the docs.
2018-11-16 16:38:47 -08:00
Alex Ratner
0c7f6e5047 fixes for typos, grammar, and links (#48721)
* fixes for typos, grammar, and links on magic vars page
2018-11-15 17:46:41 -06:00
Dag Wieers
fd02ecd290 Code example improvements in Windows documentation (#45055)
This PR includes:
- Using explicit yaml+jinja code-blocks
- Work around pygments lexer issues with colons (in URLs and options)
2018-11-15 16:17:29 -05:00
Xaroth
87d10b9b78 Include dependency role names in role_names. (#46483)
* -Change: Include dependency role names in `role_names`.
-Add: `play_role_names` magic variable to include only explicitly named roles (formerly `role_names`).
-Add: `dependent_role_names` magic variable to include all dependency names for all roles.

* -Change: use the ansible_ prefix for new magic variables.
-Change: keep `role_names` as a deprecated variable, using the old functionality.

* -Add: changelog fragment for the role_names rework.

* -Add: Tests for the role_names (and ansible_*role_names) special variables

* -Fix: resolve erroneous documentation snippet that was introduced after rebasing.

* -Fix: explicitly sort to ensure list comparison works in test.
2018-11-15 10:01:29 -05:00
Martin Krizek
9ce9c9698a committer_guidelines.rst: update core committers (#48662)
* committer_guidelines.rst: update core committers

* Another update
2018-11-14 15:07:57 -05:00
Toshio Kuratomi
b759862daa Add an example to serial usage (#48669) 2018-11-14 11:57:10 -05:00
Dylan Silva
498bb74717 Updated roadmap to reflect dates for 2.8 (#48626)
* Updated roadmap to reflect dates for 2.8
2018-11-14 15:54:15 +00:00
Matt Clay
1a3bf09f8a
Add test to require docs for action plugins. (#48376) 2018-11-13 22:52:36 -08:00
Adam Miller
2b1ca25e59 docs - adapted abadger's changelog announcement email into dev process (#48172)
* docs - adapted abadger's changelog announcement email into dev process

Signed-off-by: Adam Miller <admiller@redhat.com>

* migrate changelog docs to one place, add ref to old location

Signed-off-by: Adam Miller <admiller@redhat.com>

* add changes based on feedback

Signed-off-by: Adam Miller <admiller@redhat.com>

* Refines changelog docs, minor re-org of page

* moves links and anchors for new content

* Further reorg of page

* fixes header per jamescassell
2018-11-13 22:42:02 +00:00
Michael Scherer
2ca7279cae Correct the variable name in example (#48603)
Changed from 'ansilbe_python_interpreter' to 'ansible_python_interpreter'
2018-11-13 22:00:13 +05:30
Matt Martz
8765d2a8e8
code-smell test that can find deprecated config items (#46273)
* Start of code-smell test that can find deprecated config items

* Strip deprecated.version from config item

* Don't use os.walk, rely on explictly passed list of files

* Properly disable the test

* Add docs

* Make config an orphan
2018-11-13 09:29:39 -06:00
Andreas Krüger
806442b3ec Document the tests that are currently run on documentation pull requests. (#48436) 2018-11-13 08:39:00 -06:00
Martin Krizek
1465f70eb5 Add ansible_play_name magic var (#48562) 2018-11-12 11:18:49 -05:00
Brian Coca
7ca6af396e added faq entry on ansible_host + delegation (#48438) 2018-11-12 10:26:15 -05:00
Felix Fontein
9a848ca883 Fixing typo in developing_locally.rst (#48535)
`cacheing` → `caching`

+label: docsite_pr
2018-11-12 08:21:58 +01:00
Lars Kellogg-Stedman
220d224433 add note regarding {host,group}_vars directory lookup semantics (#48066)
* add note regarding {host,group}_vars directory lookup semantics

While the 'ansible-playbook' command will look for {host,group}_vars in
both the playbook and inventory directories, the 'ansible' command
will only look in the inventory directory. This follows from a close
reading of the documentation but isn't explicit and leads to the
perhaps unexpected result that you can run both commands with the same
configuration in the same directory and get different results.

This commit adds a note to the documentation making the difference in
behavior explicit.

Closes #48065

* incorporates bcoca feedback
2018-11-09 15:22:23 -05:00
Alicia Cozine
d27d956d71 clarifies FAQ answer about env vars (#48432) 2018-11-09 14:31:29 -05:00
Rémy Léone
f4fa3314c4 Add support for Scaleway object storage (#46353) 2018-11-09 16:16:53 +00:00
Keith Maxwell
7db2861961 Remove unnecessary --recursive option to git clone (#48379)
From installing / Running from source.
Since the repomerge, Ansible doesn't use submodules. Also, between 2.12.0 and 2.13.0 git dropped '--recursive' in favor of '--recurse-submodules'.
2018-11-08 19:43:43 -06:00
Andreas Krüger
e2bba149d6 playbooks_reuse_roles.rst long and shorthand example actually made equivalent. (#48339) 2018-11-08 08:28:16 -06:00
Rushan
cc5b9c5fe1 enchance yaml filter documentation (#46629)
* update to_*_yaml filter documentation

* update to*_yaml filter documentation
2018-11-07 20:23:46 -05:00
Abhijeet Kasurde
47aa752df0 VMware: Documentation for SSL installation methods (#43992)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-11-07 17:41:33 -05:00
Matt Martz
f728f2bff0
Add a new "contains" jinja2 test (#45798)
* Add contains jinja2 test

* backticks
2018-11-07 14:49:00 -06:00
Brian Coca
8ccb44aa63 clarify insane ini typing (#48169)
* clarify how variables are interpreted in the ini inventory plugin
2018-11-07 14:19:23 -06:00
angystardust
09ff2da651 VMware: further improvements to the scenario_clone_template (#48141)
Follow-up to #47889. Fixes the list of required privileges for cloning a vmware template.
2018-11-07 10:04:54 -06:00
majekw
383da46c32 Document installation procedure on Slackware (#47657)
Add section with installation procedure on Slackware Linux using sbopkg and SlackBuilds.org build scripts repository.
2018-11-07 09:54:00 -06:00
Jordan Borean
501acae5ab
Added basic equivalent to PowerShell modules (#44705)
* Added basic equivalent to PowerShell modules

* changes based on latest review

* Added tests

* ignore sanity test due to how tests are set up

* Changes to work with PSCore

* Added documentation and change updated more modules

* Add some speed optimisations to AddType

* fix some issues in the doc changes

* doc changes
2018-11-07 10:53:17 +10:00
InputValidation
7760b04020 Updated Red Hat Repo (#48173)
Updated Red Hat Repo to current version number
2018-11-06 11:26:22 -06:00
Matt Martz
45ff6df1af Remove Deprecated configs 2.8 (#46825)
* Removed deprecated ANSIBLE_HOSTS

* Bump sudo/su configs to match deprecation version for cli and playbook args

* Bump include configs to match deprecation version for 'include'
2018-11-05 12:08:13 -05:00
Adam Miller
8c362da6dc swap out RM for 2.8, it me now (#48013)
Signed-off-by: Adam Miller <admiller@redhat.com>
2018-11-03 15:45:36 +00:00
Aren
6243f36319 gcp additional info & edit (#45986)
* There were 2 introduction headings

line 36 was a duplicate 'introduction' heading, and the section is more of a requisites description.

+label: docsite_pr

* edit for line 32+33 & 45>50 added
2018-11-02 17:05:23 -04:00
Mark Jeromin
8d2f6c31de updated user_guide for regex test, #24155 (#47893) 2018-11-02 15:53:55 -05:00
mbk87
5ab30e0079 protocol (#47666)
* clarifies reference to SSH, adds link for further reading
2018-11-02 14:02:13 -05:00
Risto Oikarinen
4b2a090418 Fix vars_prompt "private" description and improve example (#47688)
* Fix vars_prompts "private" description and improve example

* Fix indentation
2018-11-02 14:57:39 -04:00
Risto Oikarinen
f000baf6f7 Add yaml version of using host variables example (#47700) 2018-11-02 14:50:42 -04:00
Bianca Henderson
e38796bf7b Slight Change in Wording in "Reporting Bugs and Features" (#47984)
* Adding a link for PR info

* Not specifying Google Groups in wording
2018-11-02 14:48:30 -04:00
Brian Coca
40d8b91d07 added missing vars (#47993)
fixes #31900
2018-11-02 13:38:29 -05:00
Bianca Henderson
248827227a Correcting syntax of PyYAML package (#47987) 2018-11-02 11:46:56 -05:00
Christian Kotte
754c377dbd VMware: Improve output of vmware_local_role_facts (#47871) 2018-11-02 14:28:36 +05:30
angystardust
89f03314ce VMware: improve readability and fix privileges names on scenario_clone_template (#47889) 2018-11-02 11:42:41 +05:30
Abhijeet Kasurde
ab0d90f882 VMware: Fix documentation for cloning template (#47847)
Fixes: #46700

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-11-01 15:05:22 +10:00
Martin Krizek
ec32bda2ef ansible-galaxy docs: fix init of container role (#47853) 2018-10-31 15:38:55 -04:00
Moritz Grimm
1a91b797bd updated documentation fixing #47202 (#47267) 2018-10-31 09:36:35 -05:00
Jordan Borean
73141d5035 pip: produce better error msg on import error (#47743)
* pip: produce better error msg on import error

* Added porting guide entry for 2.7
2018-10-31 15:30:37 +01:00
John R Barker
f536944e3a Molecule is now IRC: ansible-molecule (#47860) 2018-10-31 09:42:56 -04:00
John R Barker
4572d9ccd7
ansible-lint and molecule part of Red Hat (#47826) 2018-10-30 18:54:10 +00:00
Alicia Cozine
7db63851e0 Updates variables docs: facts examples, headers, links, etc. (#47767)
* refreshes ansible facts output and updates some references/headers
2018-10-30 11:37:34 -04:00
Bianca Henderson
e6d99cb2bf Adding a link for PR info (#47778) 2018-10-30 09:54:42 -05:00
Abhijeet Kasurde
6d36849f72 Update plugin filter documentation (#46665)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-10-29 15:04:32 -04:00
John R Barker
d189e58f63 Correct AWX community link (#47742) 2018-10-29 08:11:37 -04:00
mbk87
24e1da972e bad space (#47667)
removes whitespace
2018-10-28 18:55:25 -05:00
John R Barker
749af9fd22 Document all Working Group, email lists and IRC channels (#47615)
Put all communication info in one place so we can update links to point here.
2018-10-28 18:52:34 -05:00
John R Barker
72359a10e6 Tidy up Contributors Docs (#47619)
* Tidy up docs on GitHub, direct people to docs.ansible.com
* De-duplicate documentation and move useful info
2018-10-28 17:11:40 -05:00
John R Barker
166e84b9c4 Docs: No need to follow up on backport PRs (#47616)
Also tidy up `notes` section into a single box
2018-10-28 16:40:39 -05:00
Ben Cornett
6229f89369 Fix spelling (#47692) 2018-10-28 15:55:41 -05:00
Johannes Brunswicker
d3be5d5327 Creates base Sophos UTM module (#45781)
* Fixes #18568
* Commit of the first set of utm modules
* added documentation line for module_utils file
* removed other utm modules for the first pr
* added maintainers to botmeta
* implemented fixes for shippable
* fixed whitespaces and newlines in included doc fragment
* added types and choices to documentation
* fix for E501
* Implemented change requests
* changed utm_utils license to BSD
* changed str() to to_native()
* added a status state that will just return information about my object
* renamed state 'status' to 'info'
* added team_e-spirit to botmeta and added the team as maintainer for the utm_utils
* only return a result if the lookup was not empty. Do not return a null result
* removed info state
* added boilerplate
* made preparation for info-only modules
2018-10-26 23:21:54 +05:30
Andrea Perotti
8bc4a18500 Updates intro to dynamic inventory page (#46799)
* Added Foreman to the list of inventory scripts
2018-10-26 18:35:44 +01:00
Abhijeet Kasurde
e5318c5c4f doc: Scenario guide for VMware HTTP API usage (#47117)
This adds scenario guide for using VMware HTTP API using uri module.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-10-26 13:24:56 -04:00
Matt Martz
f7ba63e047
Add shorthand debugger method to recreate the task from the original ds (#46987)
* Add shorthand debugger method to recreate the task from the original ds, and re-template. Fixes #46321

* Fix rst header

* Indicate update_task was added in 2.8
2018-10-25 16:35:59 -05:00
d3nisko
6c2e4c1ca8 Update YAMLSyntax.rst (#47491)
* Update YAMLSyntax.rst to correct syntax of a list vs dict.
2018-10-25 16:23:47 -04:00
Simon Legner
5959158612 doc(user_guide): fix typos (#47425) 2018-10-24 12:01:24 -04:00
Alicia Cozine
4219d25fc7 Add docs about contributing to docs (#46481)
* adds page on community contributions to docs
2018-10-24 11:14:01 -04:00
Aurelio Jargas
e58e43279c Fix markup: inline literal with spaces (#47560)
Fixes rST/Sphinx error on the YAML syntax page of the core docs.
2018-10-24 09:55:25 -05:00
Jordan Borean
ddfd1dbfc6
Add helper function to return helpful import error msg (#47409) 2018-10-24 07:21:36 +10:00
markafarrell
94eab56d51 Update netconf jumphost documentation (#47339)
* doc/update netconf jumphost docs

* Remove requirement for nc. Option for Port 830

Based on https://en.wikibooks.org/wiki/OpenSSH/Cookbook/Proxies_and_Jump_Hosts#Passing_Through_a_Gateway_Using_stdio_Forwarding_(Netcat_Mode)

* Fix formatting

* More formatting fixes

* Remove incorrectly added newline
2018-10-23 14:06:19 -04:00
He Guimin
85ba30a3db Add new module ali_instance (#36898) 2018-10-23 13:02:21 -05:00
Ganesh Nalawade
335a979f1d
Fix prompt mismatch issue for ios (#47004)
* Fix prompt mismatch issue for ios

Fixes #40884 #44463

*  If the command prompt is matched check if data is
   still pending to be read from buffer.
*  This fix adds a new timer `buffer_read_timeout`
   which will be trigerred after command prompt
   is matched and data is attempted to be read from channel.
   If not data is present of channel the timer will expire
   and response we be returned to calling function.

* Fix unit test failure

* Update to make buffer timeout float

* Update doc and fix review comment

* Fix CI issues

* Update doc

* Fix review comments

* Fix review comments
2018-10-22 21:05:15 +05:30
Richard Metzler
acda7bae5f fix callback name
+label: docsite_pr
2018-10-19 18:17:49 -04:00
Alicia Cozine
f1ad012375 removes docs/api dir from .gitignore and Makefile (#47366)
* removes docs/api dir from .gitignore and Makefile

* reduces noise on removing build artifacts
2018-10-19 17:06:15 -04:00
Alicia Cozine
cd7232eeb7 refines vmware sample scenario page (#47320) 2018-10-19 11:06:40 -04:00
Artem Zinenko
3fa33ce96b Fixed typos in winrm doc (#47351) 2018-10-19 10:34:03 -04:00
Adam Miller
9e2c02455a add note about named tasks in blocks (#46984)
* add note about named tasks in blocks

Signed-off-by: Adam Miller <admiller@redhat.com>

* adds names to tasks within example block, removes 2nd example

* removes traces of bad rebase
2018-10-18 16:24:52 -04:00
Bianca Henderson
e52761fbd3 Making minor changes (#47311)
<!--- Your description here -->

+label: docsite_pr
2018-10-18 16:18:29 -04:00
John R Barker
4991ef30c2 ROADMAP_2_8.rst link to GH project (#47265) 2018-10-18 05:49:17 -04:00
Luke Short
9cf407f683 Gentoo installation no longer requires a workaround. (#47151)
The default Python version has been 3.6
since June 2018 and was 3.5 before then.
Ansible supports Python 3.5 and above.
2018-10-17 10:23:23 -05:00
Jon Stevens
0272fd4b37 docs: Fix restructuredtext link format (#47199)
Fix two links on guide_online.rst
2018-10-17 09:28:48 -05:00
Petr Ruzicka
53217a3dbd with_items is obsolete - using loop instead (#46806) 2018-10-16 15:54:09 -05:00
Petr Ruzicka
559c92f9b6 with_items is obsolete - using loop instead (#46805) 2018-10-16 15:53:22 -05:00
Petr Ruzicka
b17f02a89a with_items is obsolete - loop should be used instead (#46524) 2018-10-16 15:52:32 -05:00
Dag Wieers
4fc6ab55aa This fixes a weird indentation issue in the menu (#45089) 2018-10-16 12:00:43 -05:00
Matt Martz
abe64775cf Add porting guide note about inline vars on import/include_tasks (#47121)
* Add porting guide note about inline vars. Fixes #47102
2018-10-16 10:33:40 -05:00
Page Bowers
1ec71e503e Update the document to link to the script itself (#46986)
Added a link to the dynamic inventory script to make it easier for a user to find.
2018-10-16 09:12:11 -05:00
Matt Clay
c3a6737004 Add BOM check to shebang sanity test.
Includes fixes for docsite files with a UTF-8 BOM.
2018-10-15 12:03:58 -07:00
Alicia Cozine
b26aa66a41
fixes local toc, updates language (#47054) 2018-10-15 08:39:06 -05:00
Sandra McCann
db3d920cfd WIP: fix build errors due to missing certified_supported label (#46835)
* fix build errors due to missing certified_supported label

* fixed references and toc
2018-10-14 19:08:06 -05:00
Bianca Henderson
ffc46e1648 Making minor grammatical changes (#46844)
fixes to dev_guide page
2018-10-12 09:59:08 -05:00
Sloane Hertel
f3d5ebb355 add more consistent extension matching for inventory plugins (#46786)
* Add consistent extension matching for inventory plugins that support YAML configuration files

* Document extension matching expectations
2018-10-11 11:06:52 -05:00
Alicia Cozine
9764f32513 adds stub API docs in a single file (#46663)
* adds stub API docs in a single file
2018-10-11 10:15:24 -04:00
Risto Oikarinen
e1cfc2500c Clean playbook filters doc by adding whitespaces (#46569) 2018-10-11 09:02:12 -05:00
Dag Wieers
1771874ac8 Indentation 2018-10-10 01:52:44 +02:00
Dag Wieers
d0f3aaff62 Update wording as requested by review
Also improve wording.
2018-10-10 01:52:44 +02:00
Hayden
a2ac3482b6 Update windows_faq.rst
<!--- Your description here -->

+label: docsite_pr

Windows Subsystem for Linux is now officially supported by Microsoft. It is out of beta and will be shipping on Windows Sever 2019.
2018-10-10 01:52:44 +02:00
Mike Klebolt
5c93068223 incorrect ref (#46492) 2018-10-08 16:33:50 -04:00
Robert Herhold
850355b314 Update links to module sources (#46553)
The documentation still points to the old links for the [core](https://github.com/ansible/ansible-modules-core/tree/devel) and [extras](https://github.com/ansible/ansible-modules-extras/tree/devel) modules. This PR updates the links to the main ansible repository.

+label: docsite_pr
2018-10-08 14:24:19 -05:00
Sloane Hertel
43d12c11be Add 'auto' to documented default enabled inventory plugins (#46621)
* Correct default inventory plugins enabled in docs and example/ansible.cfg

* Fix headers
2018-10-08 14:07:46 -05:00
Sloane Hertel
c4d1f0d416 Add docs for inventory caching (#46402)
* Add docs for inventory caching

* Fix subsection headers

* Fix top header
2018-10-08 13:34:24 -04:00
Matt Clay
a4c9f57b38 Move docsite requirements to the docs/docsite dir. (#46518) 2018-10-05 11:27:43 -05:00
Jordan Borean
b570af020c added porting guide for PowerShell EAP changes (#46451) 2018-10-04 15:32:17 -04:00
Alicia Cozine
e97391b7ab updates language about documentation versions and releases on index page (#46465) 2018-10-04 15:26:37 -04:00
Dag Wieers
92037679c4 Fix subelements example correctly (#46482) 2018-10-04 14:18:00 -05:00
Matt Clay
e2b6047514
Add symlinks sanity test. (#46467)
* Add symlinks sanity test.
* Replace legacy test symlinks with actual content.
* Remove dir symlink from template_jinja2_latest.
* Update import test to use generated library dir.
* Fix copy test symlink setup.
2018-10-04 07:02:42 -07:00
Alicia Cozine
ba9348883b
updates latest in docs conf.py (#46400) 2018-10-03 21:56:11 -05:00
Andrew Paradi
641c569a20 Fix spelling error in subelements Filter example (#46446)
<!--- Your description here -->

+label: docsite_pr
2018-10-03 21:54:36 -05:00
Haidara Mohamed El Mouctar
cd4415d4ec Docsite: Add a new tool: Ansible Playbook Grapher (#46435)
Add Ansible Playbook Grapher: a tool create a graph representing your Ansible playbook tasks and roles.

https://github.com/haidaraM/ansible-playbook-grapher

+label: docsite_pr
2018-10-03 10:19:19 -05:00
Sandra McCann
a1fae193c7 disable gather facts and update playbook output (#46409)
* disable facts gather and update playbook output

* fix output
2018-10-02 13:59:10 -05:00
Alicia Cozine
04b726dc14 Updates release & maintenance version docs for 2.7 2018-10-02 11:27:31 -05:00
Artur Juraszek
c0de93310f Mention YAML as a AWS CloudFormation template language (#46345) 2018-10-01 12:23:56 -04:00
Enno Gröper
1ff331e66a Update playbooks_delegation.rst (#46254)
Fix example variable lookup.

+label: docsite_pr
2018-09-28 13:38:52 -05:00
Alicia Cozine
66eb5681f4 yes, we do run validate_modules in Shippable (#46280) 2018-09-28 14:09:14 -04:00
Andrii Trykush
90126f37cd Corrected typo
Corrected typo
ansible_serach_path --> ansible_search_path
+label: docsite_pr
2018-09-28 12:41:05 -04:00
Brendan Jurd
ab96bbdef9 Clean up Vault docs in User Guide. (#46188)
* Fix spelling of 'separate' throughout.

* Various cleanups in the User Guide for Vault.

- Fix spelling of 'algorithm'
- Fix indentation of nested list in payload format
- Fix mysterious refernce to 'b_pkey1'.
- Fix reference to newline as '\n': the backslash is lost when rendered
to the docs website. Specify the hex value for newline instead of the
backslash escape.

* Fix formatting

* Update vault.rst
2018-09-28 10:16:58 -04:00
Kevin Breit
a690917b5f Meraki scenario guide - Changed section markup types (#46158)
* Changed section markup types, small fixes for style
- Add dashes per style guide
- Add TOC in case this grows
2018-09-28 08:58:41 -05:00
Sam Doran
4c929d3a7a Correct loop syntax in example (#46178) 2018-09-27 11:55:11 -04:00
Deric Crago
065b7ac300 moved 'strftime' filter into 'Other Useful Filters' section (#45801) 2018-09-27 11:52:50 -04:00
John R Barker
f1038a5c05
ROADMAP_2_8 stub (#46120)
* ROADMAP_2_8 stub

* Update ROADMAP_2_8.rst
2018-09-25 17:47:50 +01:00
Rémy Léone
1d4d49369e Add a guide for Scaleway (#44810) 2018-09-25 11:40:33 -04:00
Alicia Cozine
d1beb8436b restores legacy testing file (#46095)
* restores legacy testing file

* corrects links to legacy testing page

* oops, copy-pasta fix
2018-09-25 08:52:47 -04:00
Peter Sprygada
1e68881c40 adds support for null values to the ternary filter (#45303)
* adds support for null values to the ternary filter

This change adds a third optional argument to the ternary filter to
handle a null value.  If the third option is specified null and false
are treated differently.

For instance, take the following example:

{{ enabled | ternary('no shutdown', 'shutdown') }}

If enabled == True, then 'no shutdown' is used.
If enabled in (False, None), then 'shutdown' is used.

With this change the following is possible:

{{ enabled | ternary('no shutdown', 'shutdown', omit) }}

If enabled == True, then 'no shutdown'
If enabled == False, then 'shutdown'
If enabled == None, then omit

* update documentation with example of filter

* update filter documentation example per comments

* fix logic error in user_guide example
2018-09-24 18:57:19 -04:00
Mark Phillips
76a0323918 Changed hash_merge to link for ANSIBLE_HASH_BEHAVIOUR (#45996)
* Changed hash_merge, which goes nowhere, to link for ANSIBLE_HASH_BEHAVIOUR
* Changed link as per bcoca suggestion
2018-09-24 15:03:55 -05:00
Sandra McCann
df3655968f Infoblox scenario guide (#45664)
* creates infoblox scenario guide
* adds link to infoblox guide from modules
* adds WAPI to prerequisites
2018-09-24 14:25:01 -05:00
Simon Metzger
fc7e5f16e8 Update developing_modules_general_aci.rst
<!--- Your description here -->

+label: docsite_pr
2018-09-21 23:52:51 +02:00
Brian Coca
03d8b68549 added note about cli execution of include_x (#45227) 2018-09-21 14:08:57 -05:00
Rémy Léone
d3d1ff7990 Add a guide for using Online with Ansible (#45277) 2018-09-21 11:43:56 -05:00
Omar Osman
623f803e0b update example to YAML style in documentation (#45968)
The example is in a key=value format which is deprecated.

+label: docsite_pr
2018-09-21 08:42:31 -05:00
Jordan Borean
27c10fa502
add skip/docker alias to skip tests when running on Docker (#45955)
* add skip/docker alias to skip tests when running on Docker

* changed warning message wording
2018-09-21 16:09:54 +10:00
Jordan Borean
5c73d4f4bd
async: use async_dir for the async results file directory (#45461)
* win async: use async_dir for the async results file directory

* tried to unify POSIX and PowerShell async implementations of async_dir

* fix sanity issue
2018-09-20 19:37:54 +10:00
Eric Helms
74b94e119e Deprecate foreman and katello modules (#42043)
* Deprecate foreman and katello modules in 2.8, remove in 2.12
2018-09-19 11:41:54 -05:00
Pilou
60160c1e90 doc: exercising module code locally: update cmd (#45697)
The documented way to execute module code locally wasn't always working:

    $ python ./lib/ansible/modules/files/file.py <<< '{"ANSIBLE_MODULE_ARGS": {}}'
    Traceback (most recent call last):
      File "./lib/ansible/modules/files/file.py", line 177, in <module>
        from ansible.module_utils.basic import AnsibleModule
      File "~/ansible/lib/ansible/module_utils/basic.py", line 78, in <module>
        import tempfile
      File "~/ansible/lib/ansible/modules/files/tempfile.py", line 69, in <module>
        from tempfile import mkstemp, mkdtemp
    ImportError: cannot import name 'mkstemp'
2018-09-19 10:10:55 -04:00
Alicia Cozine
f430f60541
Restore license agreement (#45809)
* adds page for CLA in community docs with links from dev and community docs
2018-09-18 14:47:22 -05:00
Owen Kuemerle
4e532e0ad9 Add workaround for non-standard kerberos environments (#41465)
* Add workaround for non-standard MIT kerberos environments

* Generalize platform specific troubleshooting steps for Kerberos
2018-09-18 09:33:09 -05:00
Veaceslav Mindru
84a4257774 adding git+ssh uri scheme (#36025)
* incorporates git+ssh into existing example
2018-09-17 17:33:56 -05:00
Raymond Wanyoike
c41632fad2 Add the key_name/value_name options to the dict2items filter (#45550)
* Add the key_name/value_name options to dict2items - as with items2dict, allow users to configure the key/value name for dict2items, add "version added" and examples
2018-09-17 15:53:52 -05:00
Kamil Wilczek
78e9f452a5 Simplify PPA installation for Ubuntu (#45690)
Adds the `--update` flag to automatically update the cache and the `--yes` flag to disable the Ansible repo description and skips confirmation dialog. +label: docsite_pr
2018-09-17 08:59:20 -05:00
skylerbunny
a892a6ef03 Add undocumented configuration parameter and explain in porting guide (#36059)
* Add undocumented configuration parameter and explain in porting guide
2018-09-17 12:08:25 +01:00
Anil Kumar Muraleedharan
4ec317ceca Lenovo doc update (#45483)
* Merge issue

* Update cnos_rollback.py

* Updating license for the refactored method

* Update cnos_rollback.py

* Removing the BSD License as suggested by Legal

* To add Documentation for ENOS as well as CNOS

* Merge issue

* Revert "To add Documentation for ENOS as well as CNOS"

This reverts commit 80e6e39054be0c3a8f95d16dc39ca9d93baf8c4b.

* Adding Docs for ENOS and CNOS

* Update cnos.py

* Update cnos_rollback.py

* Update cnos.py

* Update platform_cnos.rst

* Update platform_enos.rst

* Removed version 2.7

* Removing 2.7
2018-09-14 15:23:57 -04:00
Matt Martz
829f48e3f5
Flip default for AGNOSTIC_BECOME_PROMPT (#45563)
* Flip default for AGNOSTIC_BECOME_PROMPT

* simplify AGNOSTIC_BECOME_PROMPT porting guide entry

* clarify AGNOSTIC_BECOME_PROMPT changelog entry

* fixes version typo

* uses alternate wording (rather than escaping *)
2018-09-14 11:16:13 -05:00
John R Barker
822236810e
BOTMETA Validator + Bulk tidyup, support:(core,community,network) (#44903)
plugins/ is COMMUNITY
Set sensible defaults for directories
support:network for the platforms that we Networking SUPPORTS,
everything else is COMMUNITY
Mark other support:network (ansible-connection, etc)
Infoblox is support:core
contrib/ by definition should be support:community
Remove duplicated labels
Make yamllint happy(ier)
Adds sanity test to ensure BOTMETA.yml is valid
2018-09-14 12:33:23 +01:00
Dag Wieers
e038338e9f Improvements to structure 2018-09-14 09:24:08 +02:00
Jacob McGill
78d7769bd9 ACI: Move dev_guide from Wiki to Ansible docs 2018-09-14 09:24:08 +02:00
Kevin Breit
3b38bf377e meraki - Remove YAML formatting on JSON code block (#45526)
* Remove YAML formatting on JSON code block
2018-09-13 13:16:32 -05:00
Dag Wieers
afea00fa9f Improve the local toctree (and title) (#45590)
Make toctree for Windows dev guide local, remove 'Ansible' from the title, since
this documentation is about Ansible.
2018-09-13 13:12:43 -05:00
Dag Wieers
6999bf318f Fix link and toctree (#45595) 2018-09-13 12:38:49 -05:00
Pilou
95649dc793 FAQ: fix a typo, add link to 'vars' lookup (#42412)
* FAQ: add link to vars plugin doc

* Typo (s/Techinically/Technically/)
2018-09-12 17:33:07 -04:00
Dag Wieers
310b0a2521 Docs: Make docsite rebuilds smarter/faster (#45062)
* Make the following scripts  idempotent so that we only have to rebuild changed docs, not all docs:

  * plugin_formatter
  * generate_man
  * dump_keywords.py
  * dump_config.py
  * testing_formatter.sh
2018-09-12 13:50:36 -07:00
Alicia Cozine
6e68d77f6d adds license details to dev guide pages (#45574)
* adds license details to dev guide pages

* fixes capitalization error
2018-09-12 16:10:38 -04:00
FloMiau
e35c4be1c1 Change "Defaulting Undefined Variables" (#41379)
Rewording the text for the second parameter of default because the original text was misunderstandable. +label: docsite_pr
2018-09-12 14:52:22 -05:00
Alicia Cozine
228fee4f3a lineinfile note belongs in changelog for 2.6, not 2.7 (#45517) 2018-09-11 22:00:40 +01:00
Brian Coca
e9c2695ce7 updated fbsd install instructions (#45309) 2018-09-11 15:55:21 -05:00
tterranigma
f68cd1acc6 Update implicit_localhost.rst (#45455)
Adds a clarification about `inventory_dir/file` magic variables when using implicit localhost as per #45385 . +label: docsite_pr
2018-09-11 15:17:50 -05:00
Artem Goncharov
8ae14bebda update porting guides (#40784)
* update porting guides

With PR #40532 `shade` library was retired and replaced with direct use
of `openstacksdk`. Porting guides and doc about dynamic inventory were
not updated.
2018-09-11 18:14:26 +01:00
Alicia Cozine
4264be2b18 Remove more docs build errors (#45364)
* orphans testing pages to avoid not-in-toctree errors

* orphans various pages pending reorg

* adds module_utils and special_vars to main TOC

* uses a glob for scenario_guide TOC

* normalize and Sentence-case headings on community pages, typos

* re-orgs community TOC, adds all pages to toctree

* removes scenario guides index page

* adds style guide to community index

* basic update to style guide

* fix typo that created a new error

* removes not-in-toctree from ignore errors list

* leave removing files for future cleanup task
2018-09-11 17:51:47 +01:00
Sam Doran
5d6f844eba Add docs on how to write changelog fragments (#42428)
* Add docs on how to write changelog fragments

* Make recommended changes

* Restore lines and make recommended changes

* Add link to new style changelog

Remove redundant mention of old style changelog
2018-09-11 12:23:22 -04:00
Jordan Borean
01398f61d5
Win deprecate 2.8 (#45473)
* Remove deprecated/expired functionality

* win:_msi: Remove the win_msi module

* removed some missed deprecated return options and added porting guide reference

Co-authored-by: dagwieers <dagwieers@users.noreply.github.com>
2018-09-11 14:23:48 +10:00
Jordan Borean
ec6d82435f
win_scheduled_task: add deprecation warning for repetition format (#45468)
* win_scheduled_task: add deprecation warning for repetition format

* fixed up sanity issues
2018-09-11 14:22:57 +10:00
Kevin Breit
ec3ce1f39c Meraki scenario guide (#41827)
* Initial commit for the Meraki scenario guide

* Added Meraki guide to indexes, fixed an error

* Added common parameters to scenario guide

* Add additional information for first draft
- Added very common parameters everyone uses.
- Documented common format for returned data from Meraki.
- High level explanation of error handling.

* Fix .rst formatting error

* Added section about handling returned data. More to come.

* Small formatting changes
2018-09-10 14:59:23 +02:00
Meecr0b
2f6b8591b1 tower_credential: expect ssh_key_data to be a string instead of path (#45158)
* expect ssh_key_data to be a string instead of path

ssh_key_data should be a string filled with the private key
the old behavior can be archived with a lookup

Fixes #45119

* clarifies ssh_key_data description, adds newline
2018-09-07 13:41:09 -04:00
Alicia Cozine
9a76441c02
rewrite of the developer guide, part 1 (#45179)
* rewrite of the developer guide, part 1
2018-09-07 08:57:36 -05:00
Brian Coca
44510448b0 prefer ansible_facts namespace and dict notation (#44980)
* prefer ansible_facts namespace and dict notation

* fixed mistranslation
2018-09-06 10:26:58 -05:00
Markus Suonto
0d81386144 Add single quotes around package name (#45152)
<!--- Your description here -->
`pip install ansible[azure]` results in `zsh: no matches found: ansible[azure]` at least in my computer (zsh on Ubuntu). I don't know if it is the case with all shells, but at least for me it is. Since square brackets `[]` are special characters in bash, I propose adding single quotes to make sure that package name is always interpreted as literal. The same error is also resolvable by setting noglob.
2018-09-06 10:09:40 -05:00
Ian Wienand
6be42a2a0e docs: Clarify include_task v import_tasks with conditionals (#43856)
Correct and clarify "set_fact" example, expanding on what is happening
in the easy-to-get-wrong import mode. Add some additional links to "group_by" documentation and the main import/include discussion.

Closes: #31596
2018-09-05 14:06:02 -05:00
Brian Coca
70f3f084ac fixed chlog path 2018-09-05 10:41:49 -04:00
Sandra McCann
fe119c18ef fixed formatting (#45164)
(cherry picked from commit 58ca82fa1c)
2018-09-04 09:33:01 -05:00
Matt Martz
f89d873698
Stub out modules scheduled for 2.8 removal (#44985)
* Remove modules scheduled for 2.8

* Add changelog and porting guide

* Skip docs test on removed modules

* Don't link to removed modules
2018-08-31 16:27:32 -05:00
Sam Doran
d257095976 Change Mac OSX to macOS in installation docs (#44971)
* Change Mac OSX to macOS in docs

* Lowercase via
2018-08-31 11:12:12 -05:00
Yanis Guenane
857a553fa1 Vultr: Create the Vultr Guide (#44515) 2018-08-31 10:42:07 -04:00
Brian Coca
cbd54a4b2c added more reasons to avoid dot notation (#43724) 2018-08-31 09:32:36 -05:00
James Polley
7988266bb7 Improve clarity of precedence when command-line parameters are used. (#39059)
* Improve clarity of precedence when command-line parameters are used.

* Add command-line values into the precedence list.
* Several sample config snippets were included without any explanation
  of how those snippets would be processed. Added descriptions so that
  the reader can understand what each snippet will (or won't) accomplish.

* Don't focus on inventory as much

Expand on the fact that it's the fact that a variable is set that
matters, not the source of the variable.
2018-08-31 09:56:58 -04:00
Sandra McCann
cccf5e6e77 fixed grammar and spelling issues (#44931)
* fixed grammar and spelling issues

* fixed autocorrect mistake and sanity test errors
2018-08-31 08:44:31 -05:00
Brian Coca
3f657ca28f clarify priority setting (#44865)
* clarify priority setting

* updated as per fb
2018-08-31 09:20:26 -04:00
Dag Wieers
ac3781d40b Fix broken CI (#44937)
* Fix document structure

* Fix broken CI
2018-08-30 16:46:29 -07:00
Dag Wieers
32fc6746d8
Fix document structure (#44935) 2018-08-31 00:16:36 +02:00
Christopher Torgalson
2dfff57f57 Extends 'which notation should I use' section in FAQ (#43729)
* Extends 'which notation should I use' section in FAQ
2018-08-30 15:47:39 -05:00
Ritesh Puj
ff654ccfe8 replaced 'ansible_os_platform' to 'ansible_os_family' (#44676)
replaced 'ansible_os_platform' to 'ansible_os_family' as 'ansible_os_platform' variable is no longer available.
2018-08-30 15:02:39 -05:00
Felix Fontein
376dcb9f84 docker scenario guide: docker-py -> docker (#44856)
* Don't install docker-py by default, but the more modern docker library.

* Addressing the review comments.
2018-08-30 14:38:03 -05:00
Abhijeet Kasurde
6059da245b VMware: Concept documentation (#43927)
* VMware: Concept documentation

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* update docs

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-08-30 12:49:37 -04:00
Sloane Hertel
33e9d67801
Add some inventory plugin documentation (#44727)
* Add some additional documentation about getting inventory plugins working using YAML inventory configuration files
2018-08-30 09:35:56 -04:00
pierremahot
d11e078366 adding an option for the filter ipsubnet and testing (#40670)
* adding an option for the filter ipsubnet
2018-08-30 13:21:22 +01:00
Jordan Borean
533656694e
win_disk_image: return all mount paths in return value (#44799) 2018-08-30 16:25:45 +10:00
Chris Archibald
7cded31ec9 Depreciate elementsw modules (#44792)
* rename deprecated files
2018-08-29 17:51:52 +01:00
John R Barker
da59a8a678 Use updated pygments (#44846)
Before this PR we were not using _static/ now we do
Remove all old files so we don't replace 2018 versions with 2011
2018-08-29 11:51:40 -05:00
Greg Chavez
a5b02d6c7c "encountered" is an adj. here, need vb. "are" (#44833)
<!--- Your description here -->

+label: docsite_pr
2018-08-29 09:14:09 -05:00
Sloane Hertel
aa51072981 Update AWS pull request links (#44777) 2018-08-29 09:03:27 -05:00
Sandra McCann
1c42198f1e fixed network automation index issues (#44732)
* fixed network automation index issues

* replace :doc: with :ref:

* fixed anchor misspelling

* fix toc/nav issue -do not put toctree under a subheader
2018-08-29 15:37:00 +02:00
Brian Coca
86037bc840
improved block docs (#43611)
* improved block docs

 - broke down examples per keyword
 - clarified which errors are handled
 - clarified forcing error in rescue
2018-08-28 13:40:12 -04:00
Brian Coca
893d59fabe
updated guides to avoid connection: local (#44227)
- want they really need is `delegate_to: localhost`
 - also reduced 'local_action' usage in favor of same
2018-08-28 13:27:21 -04:00
Yuma Inaura (稲浦悠馬)
2655fd2cbd Update playbooks_conditionals.rst (#43055)
+label: docsite_pr
2018-08-27 18:33:49 -05:00
Brian Coca
93f5c10714 vars list (#43171)
* vars list

(cherry picked from commit 463b85cf0bcf7a557b857d1ebd3e8bf1b693fa4c)

* updated as per fb
2018-08-27 14:57:32 -05:00
Matthias Fuchs
7871027c9d Share the implementation of hashing for both vars_prompt and password_hash (#21215)
* Share the implementation of hashing for both vars_prompt and password_hash.
* vars_prompt with encrypt does not require passlib for the algorithms
  supported by crypt.
* Additional checks ensure that there is always a result.
  This works around issues in the crypt.crypt python function that returns
  None for algorithms it does not know.
  Some modules (like user module) interprets None as no password at all,
  which is misleading.
* The password_hash filter supports all parameters of passlib.
  This allows users to provide a rounds parameter, fixing #15326.
* password_hash is not restricted to the subset provided by crypt.crypt,
  fixing one half of #17266.
* Updated documentation fixes other half of #17266.
* password_hash does not hard-code the salt-length, which fixes bcrypt
  in connection with passlib.
  bcrypt requires a salt with length 22, which fixes #25347
* Salts are only generated by ansible when using crypt.crypt.
  Otherwise passlib generates them.
* Avoids deprecated functionality of passlib with newer library versions.
* When no rounds are specified for sha256/sha256_crypt and sha512/sha512_crypt
  always uses the default values used by crypt, i.e. 5000 rounds.
  Before when installed passlibs' defaults were used.
  passlib changes its defaults with newer library versions, leading to non
  idempotent behavior.

  NOTE: This will lead to the recalculation of existing hashes generated
        with passlib and without a rounds parameter.
        Yet henceforth the hashes will remain the same.
        No matter the installed passlib version.
        Making these hashes idempotent.

Fixes #15326
Fixes #17266
Fixes #25347 except bcrypt still uses 2a, instead of the suggested 2b.

* random_salt is solely handled by encrypt.py.
  There is no _random_salt function there anymore.
  Also the test moved to test_encrypt.py.
* Uses pytest.skip when passlib is not available, instead of a silent return.
* More checks are executed when passlib is not available.

* Moves tests that require passlib into their own test-function.

* Uses the six library to reraise the exception.

* Fixes integration test.

When no rounds are provided the defaults of crypt are used.
In that case the rounds are not part of the resulting MCF output.
2018-08-27 08:40:41 -07:00
Donghyun Kang
5fecf8baab doc: fixed typo (#44685) 2018-08-26 21:36:11 +02:00
Toshio Kuratomi
68c60ad307 Change validate-modules for removed modules
Removed modules now don't have documentation.  Need to account for that
when checking them in validte-modules
2018-08-24 15:37:13 -07:00
Toshio Kuratomi
ee891c2b16 Fix refs broken by removal of old module docs 2018-08-24 15:37:13 -07:00
akira6592
62ec0409e5 fix variable names in vars file example (#44643) 2018-08-24 12:06:06 -04:00
Ihor Dvoretskyi
5d5782ce9d Fixed links to the CLI clients (#35792)
CLI clients link is incorrect, fixed.
2018-08-24 08:40:53 -05:00
Toshio Kuratomi
8ed7e80fc8
Remove from roadmap, thing that aren't going to make it for 2.7 (#44481)
* Remove from roadmap, thing that aren't going to make it for 2.7
* Added actual Windows roadmap deliverables
2018-08-23 19:32:27 -07:00
Dag Wieers
cc2164f92a
ACI: Add specific info about running locally (#43903)
Since the ACI modules (like most network-related modules) run on the
local controller, this PR adds the necessary details so users are aware
of this particular feature.
2018-08-24 01:28:39 +02:00
sirkubax
07375be490 Fix docs errors (#33704) 2018-08-23 16:11:07 -05:00
Ganesh Nalawade
d8e362e701
Update 2.7 network roadmap done items (#44575) 2018-08-23 21:50:20 +05:30
Dag Wieers
47711d0cec docs: Use GitHub syntax highlighting styles (#44449)
This PR changes the CSS stylesheet so the documentation (and module)
examples look more like how they look on GitHub.
2018-08-23 11:13:22 -05:00
jctanner
653d9c0f87 New keyword: ignore_unreachable (#43857) 2018-08-23 11:41:02 -04:00
skylerbunny
d4e15d40e8 Update tags documentation to explain newer tags behavior (#44274) 2018-08-23 09:46:54 -04:00
Trishna Guha
6ddd034906
mark cli_config as done on roadmap (#44567)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2018-08-23 18:57:43 +05:30
Ryan Brown
4c8808ec9d
Extend module_defaults by adding default groups for cloud modules (#44127)
Extends `module_defaults` by adding a prefix to defaults `group/` which denotes a builtin list of modules. Initial groups are: `group/aws`, `group/azure`, and `group/gcp`
2018-08-22 21:33:27 -04:00
Pilou
af786cb9d7 Fix a typo in docs: s/patent/parent/ (#44529) 2018-08-22 23:05:42 +02:00
♫ Christian Krause ♫
d779eb1f15 doc: fixes the the repetitions (#43937)
Wow, this does not seem to be an uncommon misspelling. Might be there
are some left that span over two lines. I noticed the one in the git
module and then used `grep -rw 'the the'` to find some more.
2018-08-22 21:53:30 +02:00
pcahyna
8dc31a88e8 Describe subset and superset as "set theory tests" (#43926)
subset and superset do not belong to group theory but to set theory.

+label: docsite_pr
2018-08-22 15:22:10 -04:00
flawaetz
1682ce5263 Update playbooks_blocks.rst (#40951)
Blocks currently don't support loops such as with_items or sequence.  It would be helpful to make this clear in the docs otherwise it's a bit of a gotcha.

+label: docsite_pr
2018-08-22 14:07:24 -05:00
muxator
a34d8a5e47 doc: minor language corrections to loop docs (#42854)
"described more" -> "better described"
"more simple" -> "simpler"

+label: docsite_pr
2018-08-22 15:00:25 -04:00
Chris Archibald
66ae8efbd3 Bug Fixes for ontap_net_vlan.py (#44209)
* Bug Fixes for ontap_net_vlan.py

* Make documentation changes
2018-08-22 09:00:49 -07:00
Brian Coca
57293b3c64 correct vault example (#44507)
* correct vault example

fixes #43897

* corrected text and code blocks
2018-08-22 10:25:33 -04:00
Toshio Kuratomi
0e7b470a01 Remove deprecated tags config option (#44479)
* Remove deprecated tags config option

* wordsmith porting guide entry

acozine via github
2018-08-21 14:57:06 -05:00
Ganesh Nalawade
ce541454e9
Update netconf_config module (#44379)
Fixes #40650
Fixes #40245
Fixes #41541

*  Refactor netconf_config module as per proposal #104
*  Update netconf_config module metadata to core network supported
*  Refactor local connection to use persistent connection framework
   for backward compatibility
*  Update netconf connection plugin configuration varaibles (Fixes #40245)
*  Add support for optional lock feature to Fixes #41541
*  Add integration test for netconf_config module
*  Documentation update
* Move deprecated options in netconf_config module
2018-08-21 20:41:18 +05:30
Tina
0186449e7b Update index.rst (#43490)
Update mention of 'current released version'

+label: docsite_pr
2018-08-16 18:53:47 -04:00
Lucid One
4c62722675 Fixed opensearch double slash issue (#44137)
http://www.sphinx-doc.org/en/stable/config.html#confval-html_use_opensearch
"(without trailing slash)"
2018-08-16 16:28:58 -05:00
Matt Davis
6b81c36533
restore task arg splatting (#43798)
* restore task arg splatting

* reverts #41804
* supersedes #41295
* fixes #42192
* after lots of discussion amongst the core team, we decided to preserve this feature, clarify the runtime warnings/docs, and prioritize a path toward fixing the underlying behavior that causes this feature to be insecure (un-namespaced facts).

* update faq text

note that warning is disabled when inject_facts_as_vars is

* wordsmithing FAQ entry
2018-08-14 12:58:00 -07:00
akira6592
9a39b49ebc fix typo of nos_command module example (#44125)
Thanks for the fix!
2018-08-14 13:26:57 -04:00
Chris Archibald
9dceca8a88 Deprecated Old NetApp Cdot Modules (#43781)
* MVP2 Post ElementSW OSRB sync

* Revert "MVP2 Post ElementSW OSRB sync"

This reverts commit c13db2ad962cd56bffce052c2891c558a2240c72.

Undoing bad push

* move deprecated files

* add documentation

* add new line

* Fix version issue

* fix issue with ignore file, hopefully

* Add ontap modules to porting guide

* fix refs

* add _module to ref
2018-08-14 09:39:52 -07:00
Matt Clay
26a1c534be Fix rst link. 2018-08-13 13:41:37 -07:00
Andreas Olsson
00e5123e4c Update documentation based on 301 permanent redirects (#43675) 2018-08-13 14:54:14 -05:00
Ian Wienand
e5dcebaa8e docs: remove "make viewdocs" reference (#43860)
The "viewdocs" target was removed in
0381bc170c681b6ea8a94467c62e0694e3d9029d; running "make webdocs" gets
you the output for initial testing purposes.
2018-08-13 10:39:09 -04:00
Toshio Kuratomi
a0e6ab09d1 Add note to the porting guide about why we're dropping python-2.6 controller support 2018-08-13 07:38:38 -07:00
Toshio Kuratomi
da26ba3760 Documentatin fixes 2018-08-13 07:38:38 -07:00
Toshio Kuratomi
c4951cce0b Exorcise Python-2.6 2018-08-13 07:38:38 -07:00
Matt Martz
c1c229c6d4
Remove use of simplejson throughout code base (#43548)
* Remove use of simplejson throughout code base. Fixes #42761

* Address failing tests

* Remove simplejson from contrib and other outlying files

* Add changelog fragment for simplejson removal
2018-08-10 11:13:29 -05:00
Lindsay Hill
898d1c8d81 added platform guides for NOS and VOSS (#43854) 2018-08-09 16:54:22 -04:00
Pilou
32eab149b6 [doc] import_role: mention version from which behavior changed and fix some typos (#43843)
* [doc] fix some typos

* [doc] import_role: mention version from which behavior changed
2018-08-09 09:00:59 -05:00
Etienne Deneuve
379fb87b44 add group_by_os_family in azure dynamic inventory (#40702) 2018-08-09 17:00:17 +08:00
Andreas Olsson
4a0b32083c Fix link description typo in tools documentation (#43828) 2018-08-08 16:03:50 -07:00
Will Smith
2de692348f change raising errors example to raise error (#43664)
Example instantiates an AnsibleError which derives from Exception but doesn't actually raise it like intended. This is misleading as it's not clear without examining the code for AnsibleError to know that it's not some function which would raise the exception automatically.
2018-08-06 14:57:55 +05:30
Andreas Olsson
1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
2018-08-01 08:20:40 -07:00
Matt Davis
f24054121a
add RMs to current roadmaps (#43511) 2018-07-31 14:52:41 -07:00
Felix Fontein
e7e63ec1e8 Improving syntax highlighting in HTML docs (#42472)
* Adding improved YAML lexer for HTML docs.

* Fixing (some of) the warnings.

* Fixing more warnings.

* Removing ansible- prefix from lexer names.

* Rename extensions -> _extensions.

* Removing superfluous module search path extension.
2018-07-31 15:28:16 -05:00
Matt Martz
01c0446cb5
Add AnsibleModule signature schema, and fix associated issues (#43512) 2018-07-31 15:04:22 -05:00
John R Barker
321081c3b4 atom & yamllint (#43498)
* atom & yamllint
2018-07-31 14:22:38 -05:00
Lindsay Hill
2e873be9b5 Networking Docs - Added platform guides for EXOS and SLX-OS (#43116)
* Added platform guides for EXOS and SLX-OS

* Fixed RST formatting
2018-07-31 14:43:15 -04:00
Jordan Borean
ccb2e9d32f Updated release and maintenance page (#42613) 2018-07-31 09:43:24 -05:00
Ajay Chenampara
d79027b77f Update with Emacs info (#43450)
* Update other_tools_and_programs with Emacs info
2018-07-30 16:23:33 -05:00
Alicia Cozine
5fa8747af3 fixes broken link (#43458) 2018-07-30 14:12:36 -07:00
Abhijeet Kasurde
e2e3bf4073 VMware: documentation update (#42451)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-07-30 13:12:08 -05:00
Brian Coca
c809500c79 document rescue vars (#43101) 2018-07-30 13:05:16 -05:00
Abhijeet Kasurde
9e221da44a VMware: vmware_guest_find scenario guide (#42450)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-07-30 12:53:33 -05:00
Ganesh Nalawade
89676c801f Update troubleshooting doc for command timeout (#43292)
* Update troubleshooting doc for command timeout

* Update timeout document to reflect the new way to set
  command timeout per task basis for network_cli and netconf
  connection type as per PR #42847

* Fix CI failure

* Fix review comment

* Fix typo in doc
2018-07-30 13:29:35 -04:00
Abhijeet Kasurde
d1c0b7a597 VMware: restructure docs (#43065)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-07-30 11:00:00 -05:00
Egor Zaitsev
249a6aae22 New module: routeros — manage MikroTik RouterOS (#41155)
* Implement initial RouterOS support

* Correct matchers for license prompts

* Documentation updates & mild refactor

* Remove one last Cisco function

* Sanity test fixes

* Move imports to the beginning

* Remove authorize property

* Handle ANSI codes

* Revert to_lines function

* CR fixes

* test(routeros): add unit tests

* Added another test (with ANSI colors and banner in fixture).

* Ignore CRLF line endings in system_package_print file

* fix: review by ganeshrn
2018-07-30 10:28:03 +05:30
Lindsay Hill
4a98802b52 Ironware: Deprecate provider, support network_cli (#43285) 2018-07-27 12:51:45 +05:30
Toshio Kuratomi
52449cc01a AnsiballZ improvements
Now that we don't need to worry about python-2.4 and 2.5, we can make
some improvements to the way AnsiballZ handles modules.

* Change AnsiballZ wrapper to use import to invoke the module
  We need the module to think of itself as a script because it could be
  coded as:

      main()

  or as:

      if __name__ == '__main__':
          main()

  Or even as:

      if __name__ == '__main__':
          random_function_name()

  A script will invoke all of those.  Prior to this change, we invoked
  a second Python interpreter on the module so that it really was
  a script.  However, this means that we have to run python twice (once
  for the AnsiballZ wrapper and once for the module).  This change makes
  the module think that it is a script (because __name__ in the module ==
  '__main__') but it's actually being invoked by us importing the module
  code.

  There's three ways we've come up to do this.
  * The most elegant is to use zipimporter and tell the import mechanism
    that the module being loaded is __main__:
    * 5959f11c9d/lib/ansible/executor/module_common.py (L175)
    * zipimporter is nice because we do not have to extract the module from
      the zip file and save it to the disk when we do that.  The import
      machinery does it all for us.
    * The drawback is that modules do not have a __file__ which points
      to a real file when they do this.  Modules could be using __file__
      to for a variety of reasons, most of those probably have
      replacements (the most common one is to find a writable directory
      for temporary files.  AnsibleModule.tmpdir should be used instead)
      We can monkeypatch __file__ in fom AnsibleModule initialization
      but that's kind of gross.  There's no way I can see to do this
      from the wrapper.

  * Next, there's imp.load_module():
    * https://github.com/abadger/ansible/blob/340edf7489/lib/ansible/executor/module_common.py#L151
    * imp has the nice property of allowing us to set __name__ to
      __main__ without changing the name of the file itself
    * We also don't have to do anything special to set __file__ for
      backwards compatibility (although the reason for that is the
      drawback):
    * Its drawback is that it requires the file to exist on disk so we
      have to explicitly extract it from the zipfile and save it to
      a temporary file

  * The last choice is to use exec to execute the module:
    * https://github.com/abadger/ansible/blob/f47a4ccc76/lib/ansible/executor/module_common.py#L175
    * The code we would have to maintain for this looks pretty clean.
      In the wrapper we create a ModuleType, set __file__ on it, read
      the module's contents in from the zip file and then exec it.
    * Drawbacks: We still have to explicitly extract the file's contents
      from the zip archive instead of letting python's import mechanism
      handle it.
    * Exec also has hidden performance issues and breaks certain
      assumptions that modules could be making about their own code:
      http://lucumr.pocoo.org/2011/2/1/exec-in-python/

  Our plan is to use imp.load_module() for now, deprecate the use of
  __file__ in modules, and switch to zipimport once the deprecation
  period for __file__ is over (without monkeypatching a fake __file__ in
  via AnsibleModule).

* Rename the name of the AnsiBallZ wrapped module
  This makes it obvious that the wrapped module isn't the module file that
  we distribute.  It's part of trying to mitigate the fact that the module
  is now named __main)).py in tracebacks.

* Shield all wrapper symbols inside of a function
  With the new import code, all symbols in the wrapper become visible in
  the module.  To mitigate the chance of collisions, move most symbols
  into a toplevel function.  The only symbols left in the global namespace
  are now _ANSIBALLZ_WRAPPER and _ansiballz_main.

revised porting guide entry

Integrate code coverage collection into AnsiballZ.

ci_coverage
ci_complete
2018-07-26 20:07:25 -07:00
John R Barker
3ab9030f05 Document more tools (#43053)
* Document more tools
2018-07-26 17:23:00 -05:00
Yanis Guenane
d94cc3568a CloudStack: Fix typos in the Guide (#43303) 2018-07-26 16:08:32 -04:00