Commit graph

2344 commits

Author SHA1 Message Date
Alicia Cozine
6e07d4c1d9 add general facts-to-info paragraph (#64293) 2019-11-01 16:09:03 -04:00
Pierre Prinetti
2444fae208 Add a named parameter to the filter to_uuid (#64057)
Let the caller choose a namespace for `to_uuid` and document the
behaviour of both the default case, and the new explicit case.

This PR does not change the existing behaviour of the `to_uuid` UUIDv5
filter.
2019-11-01 13:11:34 -04:00
Sandra McCann
56d5fd34e3 [Docs-Release-2.9] clean up porting guide links and network text (#64124)
* clean up porting guide links and network text
* fix shippable error
2019-11-01 08:56:41 -05:00
Sandra McCann
3f808d9ed6 [Doc-Release-2.9] update release and maintenance page for 2.9 (#64166)
* update release and maintenance page for 2.9
* only 2.4 and earlier used the old changelog system
2019-10-31 20:20:34 -05:00
Sandra McCann
f264e9cfca update backport instructions to use stable-2.9 (#64168) 2019-10-31 19:49:17 -05:00
Sandra McCann
4d087ba6bd reorder porting guides (#64122) 2019-10-31 19:48:05 -05:00
Sandra McCann
0812516208 [Doc-Release-2.9] Add Roadmap 2.10 (#64162)
* add 2.10 roadmap shell and remove very old roadmaps
2019-10-31 19:46:33 -05:00
Sandra McCann
409545825f docs: update to latest 3 versions (#64109) 2019-10-31 19:32:05 -05:00
brasswood
090dca7569 Note for virtual environment users (#64040) 2019-10-31 11:47:09 -04:00
parmsib
a5d69f2a26 Make docker_stack adhere to standard ansible return values (#63467)
* Make docker_stack adhere to standard return values

The names of the various fields returned from ansible modules are e.g defined here https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#msg.

Adhering to this improves usability and makes use of functionality for e.g stdout_lines etc.

* Update lib/ansible/modules/cloud/docker/docker_stack.py

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Fix under-indentation of continuation line (pep8)

Issue exposed in test here https://app.shippable.com/github/ansible/ansible/runs/146667/1/console

* Don't break old playbooks/roles

Made sure the changes are only adding new variables, not removing anything existing yet.

* Added comment

* Minor fixes

* Update lib/ansible/modules/cloud/docker/docker_stack.py

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Update lib/ansible/modules/cloud/docker/docker_stack.py

Co-Authored-By: Felix Fontein <felix@fontein.de>

* minor change to docker_stack.py

* Add changelog fragment for PR 63467

* Format changelog fragment

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Add fragment about docker_stack return val depr

* Add docker_stack doc note about deprecated vals

* Remove whitespace in empty line

* Add docker_stack depr notice to porting guide

* Update changelogs/fragments/63467-docker-stack-return-fix.yml

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Update docs/docsite/rst/porting_guides/porting_guide_2.10.rst

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Update lib/ansible/modules/cloud/docker/docker_stack.py

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Added back a missing new line
2019-10-30 19:42:19 +01:00
Hugh
d529e37eed Update porting_guide_2.9.rst (#64082)
Porting guide should redirect `azure_rm_availabilityset_facts` to `azure_rm_availabilityset_info` on line 365, not to `azure_rm_availabilityset`
2019-10-30 12:48:57 -05:00
Matt Clay
e9f8a34dce
Fixes for validate-modules import handling. (#63932)
* Fix validate-modules support for collections.

- Relative imports now work correctly.
- The collection loader is now used.
- Modules are invoked as `__main__`.

* Remove obsolete validate-modules code ignores.

* Handle sys.exit in validate-modules.

* Add check for AnsibleModule initialization.

* Remove `missing-module-utils-import` check.

This check does not support relative imports or collections.

Instead of trying to overhaul the test, we can rely on the `ansible-module-not-initialized` test instead.

* Fix badly named error codes with `c#` in the name.

The `#` conflicts with comments in the sanity test ignore files.

* Add changelog entries.
2019-10-30 09:48:21 -07:00
Brian Coca
885ee62b53 clarified some points on environment keyword usage (#64065) 2019-10-29 13:17:41 -04:00
Austin Macdonald
1aee11c860 add newline to render table correctly (#63769) 2019-10-29 13:09:18 -04:00
Sloane Hertel
1e52782d6b Fix indentation of example (#63789)
Remove no_log since module_defaults aren't displayed like set_fact was
2019-10-29 13:08:41 -04:00
Felix Fontein
5c973dd147 docker_container: get rid of defaults (#63419)
* Add container_default_behavior option to get rid of some defaults.

* Add changelog.

* Fix option.
2019-10-28 16:40:48 -04:00
Marek Czernek
18f4f0549f Correct a typo (#64020) 2019-10-28 15:01:10 -05:00
Sandra McCann
ee8a088205 combine galaxy.com install roles details (#63486)
* combine galaxy.com install roles details
* flatten dev guide and user guide for galaxy
2019-10-28 14:59:14 -05:00
Chris Budzilowicz
5c962ef859 revisions to docsite README (#63957) 2019-10-28 12:04:59 -05:00
Mark Chappell
8d7580a59f AWS S3 : Fixup sanity test issues and deprecate 2 unused options (#63989)
* S3 module Sanity check fixes.

* s3_lifecycle: deprecate unused 'requester_pays' option

* s3_sync: deprecate unused retries option

* Add changelog fragment
2019-10-28 09:18:08 +00:00
Mark Chappell
fd54c54b51 AWS IAM Sanity test cleanup and deprecate unused 'fail_on_delete' option (#63961)
* AWS IAM Sanity test cleanup

* Changelog and porting guide updates

* Review recommendations
2019-10-28 09:18:58 +01:00
AndrewCi
c562e17659 Fixed example error in windows_winrm user guide (#63922)
##### SUMMARY
The example code to configure TLS 1.2 Support using Ansible had an indention error. The register variable 'enable_tls12' was not indented. This caused the subsequent task to fail since the variable was not registered. 


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2019-10-24 14:31:47 -05:00
Sandra McCann
6a2902c8d5 clarify no subfolders and md only for collections /docs folder (#63808) 2019-10-22 15:50:02 -05:00
Pouyan Azari
cfe2beae46 added a link to install instruction of OpenSSH (#63548) 2019-10-21 17:02:19 -04:00
Jill R
9cda5819b9 Update AWS dev guide to recomment module_defaults and point to CI policy repo (#63589) 2019-10-21 17:01:19 -04:00
Ruben De Zaeytijd
c2d1cc6f5b Confusing indication of no notable module changes (#63685) 2019-10-21 16:58:51 -04:00
Felix Fontein
4b1fdee119
docker_container: deprecate trust_image_content (#63420)
* Deprecate trust_image_content.

* Add changelog.

* Mention it has never been used; removed test stub.
2019-10-18 13:03:42 +02:00
Jobin George
8a77f17dea Update vmware ansible modules requirements section (#62797)
* Update vSphere Automation Python SDK to the requirement section

Signed-off-by: Jobin George <jgeorge@vmware.com>
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-10-18 11:34:02 +05:30
Felix Fontein
ba686154b9
openssl_csr: deprecate version option (#63432)
* Deprecate openssl_csr's version.

* Add changelog.

* Change PR so that version will no longer accept values != 1 from 2.14 on.

* Make sure it is a string.
2019-10-17 10:42:05 +02:00
Pouyan Azari
f638f29e44 Replaced old DSC links that given 404 (#63556)
Replace DSC links that returned "not found" with updated, working links.
2019-10-16 12:52:30 -05:00
pando85
e0f67b58ce Fix doc - porting_guide_2.8 value example (#63493) 2019-10-15 10:50:10 -05:00
Petr Ruzicka
876a2d57be Changed with_items to loop in VMware example (#63022) 2019-10-14 21:48:20 +05:30
Amrita42
7a8c909876 Enter should be Italics as it is a menu option (#63441) 2019-10-14 11:04:05 -04:00
Felix Fontein
054285c34c crypto modules: improve return value list documentation (#62929)
* Improve return value documentation by allowing entry for return values.
* Add docs formatting, adjust styling.
* Fix sample return value. (Taken from https://tools.ietf.org/html/rfc7517#appendix-A.1.)
* Work around abuse of .
2019-10-11 13:59:15 -05:00
Sandra McCann
ae265bc546 Move galaxy appendix info to a new Galaxy section (#63356)
* start galaxy docs restructure
* shared snippets in txt files
* moved all content to galaxy section
2019-10-11 13:19:44 -05:00
Gonéri Le Bouder
73febd4ea6 prepare_vmware_tests: use module_defaults (#63209) 2019-10-11 19:46:54 +05:30
Sandra McCann
bdd0fac606 add note about collection links (#63346) 2019-10-11 08:27:26 -05:00
Abhijeet Kasurde
35cc228b3b VMware: name is not required parameter for vmware_guest_custom_attributes
Fixes: #63222

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-10-10 17:25:20 -04:00
thaim
021d095625 Fix broken link (#63185) 2019-10-09 14:36:43 -05:00
Felix Fontein
aa04e61c89 docker_* modules: add docker module defaults group (#63164)
* Add docker module defaults group.
* Add footnote about docker_stack not being included (instead of remarks column)
2019-10-09 14:12:02 -05:00
Michael C
19587b35da docs: add Centos and Ubuntu to examples for playbook conditionals (#63085)
* docs: add Centos and Ubuntu to examples for playbook conditionals

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-10-09 14:05:21 -05:00
Toshio Kuratomi
5997d33381 Updated with slipped dates for the 2.9.0 release (#63243) 2019-10-08 14:13:45 -04:00
Alicia Cozine
941a9b68fc Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
Abhijeet Kasurde
deda9d4cc5 VMware: Add module defaults for VMware modules (#63197)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-10-07 14:24:58 -04:00
Adrian Likins
239d639fee Add support for automation-hub authentication to ansible-galaxy (#63031)
Adds support for token authentication in Automation Hub. Fixes: ansible/galaxy-dev#96
2019-10-04 17:57:37 -04:00
Kathryn Morgan
f2214951c5 Update intro_installation.rst (#62994) 2019-10-03 16:57:30 -04:00
Sam Doran
0311897722 Add docs on hiding sensitive data in loops (#63096) 2019-10-03 10:15:00 -05:00
tchernomax
25ac7042b0 pacman: remove 'recurse' deprecated option (#61961)
* pacman: remove 'recurse' deprecated option

* pacman: remove recurse deprecated option

* pacman: remove recurse deprecated option
2019-10-03 00:02:06 +02:00
Matt Martz
594a0fa9ae Add new truthy and falsy jinja2 tests (#62602) 2019-10-02 13:58:28 -04:00
Chris Houseknecht
911aa6aab9
Default collection install path to first path in COLLECTIONS_PATHS (#62870) 2019-10-02 10:22:00 -04:00
Felix Fontein
8bfc39e231 ACME module defaults (#62719)
* Add module defaults group 'acme'.

* Start YAML document.
2019-10-01 17:14:22 -04:00
Akira Yokochi
6bbd9c9eca add ios/iosxr deprecated modules (#62908) 2019-09-30 18:18:57 -04:00
Andreas Olsson
0d79013f51 Modernize Vagrant documentation (#62923)
* By requiring a slightly newer Vagrant version (from 2015) we get the
  same generated Ansible inventory format is still used by today's
  version of Vagrant. That extended inventory format also has the
  benefit of allowing for simpler Ansible examples.

* Switching to a current and supported Ubuntu LTS version.
2019-09-30 17:47:57 -04:00
Andreas Olsson
c8315bfd60 Prefer https:// links in the docs site (#62939)
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
2019-09-30 15:11:19 -04:00
Gonéri Le Bouder
7ecfa4a471 vmware guidlines: adjust the location of cloud-config-vcenter.ini.template (#62970)
Update the location of the cloud-config-vcenter.ini.template template.
The file has been moved by: 2e7d36a3f9.
2019-09-30 14:21:35 -04:00
mohamed chiheb ben jemaa
e7436e278f Remove Latin phrases from the docs (#62419)
* add styleguide about avoiding use of latin words
2019-09-26 15:12:24 -04:00
Sloane Hertel
d41050b28b Add some documentation about plugins in collections (#62465)
* Add some documentation about using plugins in collections

- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching
2019-09-26 12:00:26 -04:00
Jeff Pettorino
cea8a222a3 Update playbooks_environment.rst (#62800) 2019-09-26 10:42:23 -04:00
Michael Prokop
b33ae14949 doc: fix typos (#62852) 2019-09-26 10:18:29 -04:00
Sandra McCann
7e01de96d7
add more anchors to collections docs (#62827) 2019-09-25 08:32:44 -04:00
Sandra McCann
1b3bf33bdf
add anchors to support galaxy links (#62808) 2019-09-24 16:23:32 -04:00
akcozine
09ac8c154a Update developing_modules_general_windows.rst (#62796)
Use American spelling of favor.
2019-09-24 13:37:49 -04:00
Sandra McCann
b17581a307
[Docs] Document the resource module builder (#62222) 2019-09-23 11:10:05 -04:00
James Mighion
679d3a46fa doc: fix typo (#62668) 2019-09-20 22:10:52 +02:00
Sviatoslav Sydorenko
2969614c2c Fix link syntax and a typo in dev collections doc (#62650) 2019-09-20 09:36:23 -04:00
Sandra McCann
7badeb6df0 [docs] split collections into user and dev guide sections (#62363)
* split collections into user and dev guide sections

* sentence case
2019-09-19 15:09:19 -05:00
Sandra McCann
6d35f9026f added networking porting guide info (#61999)
* added networking porting guide info

* Update docs/docsite/rst/porting_guides/porting_guide_2.9.rst

Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>

* implemented review comments
2019-09-19 14:29:15 -05:00
Horst Gutmann
7047b66d34 Add examples for various inventory setups to the documentation (#62323)
* Add examples for various inventory setups to the documentation. This closes #12480.

* Update docs/docsite/rst/user_guide/intro_inventory.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update docs/docsite/rst/user_guide/intro_inventory.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update wording in inventory examples

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Update wording in inventory examples

Co-Authored-By: Sandra McCann <samccann@redhat.com>

* Use code-block and rename groups in inventory setup examples

* Fix group name in inventory setup example

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-09-19 09:32:04 -04:00
Jordan Borean
bf5b6695ec Add hint for config option priority (#62463)
* Add hint for config option priority

* Fix some spelling issues
2019-09-18 16:36:08 -04:00
Jordan Borean
d16ee65ecd Add link to become plugins in become docs (#62462) 2019-09-18 15:53:16 -04:00
Sloane Hertel
b1afb37ac9 Add implicit localhost hostvars note (#61956) 2019-09-16 14:00:29 -04:00
Felix Fontein
a0bec0bc32 Remove deprecated letsencrypt alias of acme_certificate (#61648) 2019-09-14 23:24:32 +02:00
Glandos
2d19150757 Update mitogen link (#62247) 2019-09-13 09:20:19 -04:00
Abhijeet Kasurde
1c3effe92e
VMware: Change return key results from VMware modules (#62161)
Following module used internal results key as part of return json, this commit
changes this to appropriate values -
* vmware_datastore_maintenancemode.py
* vmware_host_kernel_manager.py
* vmware_host_ntp.py
* vmware_host_service_manager.py
* vmware_tag.py

Fixes: #62083

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-09-13 09:57:04 +05:30
Sam Doran
041c52d629 Add info about layering properties 2019-09-12 18:55:13 -07:00
Sam Doran
5deb01c84d Remove suggestion to go caving 2019-09-12 18:55:13 -07:00
Sam Doran
9b348e690c Improve documentation on doc fragments
Add information and examples on how to use additional properites from a doc fragment
2019-09-12 18:55:13 -07:00
Sloane Hertel
09f1c286e0 Add some details to any_errors_fatal documentation (#62029) 2019-09-12 16:15:02 -04:00
Felix Fontein
0e72cbd451 openssh_keypair file permissions/ownership: add porting guide entry (#62176)
* Add porting guide entry for 2.9.
2019-09-12 15:05:01 -05:00
Evgeni Golov
c1773d5d2b document suboptions for type:list options too (#62177) 2019-09-12 16:00:06 -04:00
Evgeni Golov
740ec90688 sanity ignores for a collection need to go to tests/sanity/ (#62182)
collections use tests/ not test/ as the folder for tests
2019-09-12 15:55:19 -04:00
Evgeni Golov
48a39f5616 typo: missing-subption-docs → missing-suboption-docs (#62180)
updates the name of the test and all ignore.txt entries
2019-09-12 14:51:20 -05:00
Martin Klapproth
dc7a765e57 fix fact caching plugin name from json to jsonfile (#62198) 2019-09-12 15:45:43 -04:00
Akira Yokochi
6952295114 explicited RouterOS does not support connection: local (#62203) 2019-09-12 13:45:28 -04:00
Toshio Kuratomi
46f633598e Add guidelines for when to use a doc_fragment (#61828) 2019-09-12 12:55:50 -04:00
Sorin Sbarnea
179eb623d7 docs: avoid confusing double negation (#62143)
Avoid "no backward incompatible interface" term which uses a double
negation and replaces it with easier "backward compatible interface"
contruct.
2019-09-11 11:26:22 -04:00
Kevin Breit
f79d03d292 Elaborate on note that docker-priv only works with integration (#62035) 2019-09-11 08:20:49 -04:00
createchange
e3ea89801b Update playbooks_prompts.rst (#62003)
Fixed typo: "wierd" > "weird"
2019-09-10 06:57:01 +05:30
Nathaniel Case
646a0b9024
Add missed eos modules to porting guide (#61994) 2019-09-09 12:07:42 -04:00
Toshio Kuratomi
f58899eef7 Update release name for 2.10
Add a list of previously used release names to make it easy to tell what
release names are no longer usable.

Add a test that new release names have been added to the used list.

Fixes #61616
2019-09-05 18:36:06 -07:00
Christopher Engelhard
375eb9723a Add caution about handlers & import to Pitfalls (#61060)
* Add caution about handlers & import to Pitfalls on the playbooks_reuse page.
The fact that handlers lose their name: when using import_tasks:, while logical, is not intuitive and should be noted.
Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-09-05 14:18:09 -05:00
Jordan Borean
2fbe4ca102 Fix galaxy server reference in the docs (#61823) 2019-09-05 10:47:19 -04:00
ndclt
aadb192846 documentation: modify the link to the docker.txt listing all images (#61838)
The file was moved.
2019-09-05 08:07:09 -05:00
John R Barker
41055b5dc8 Proposals aren't really used much, delete it (#61800) 2019-09-04 13:56:57 -05:00
Sandra McCann
7efaad711e Minify ansible (#61792)
* make all comments special to survive minify
* minified css
2019-09-04 12:57:05 -05:00
Sandra McCann
de826b437d Minify theme (#61734)
* moved most ansible edits out of theme.css
* remove unnecessary edit to theme.css
* replace with upstream minified theme.css for 0.4.3
2019-09-04 10:45:16 -05:00
Jeff Geerling
f1180f3d3f Fix documentation to reflect CLI usage for collections-path (#60164) 2019-09-03 16:50:58 -04:00
anshulbehl
bfaa29303b adding a collection local try section (#61626) 2019-09-03 11:33:32 -04:00
Wojciech Sciesinski
7e7b7bb0b6 Correct indentation of the code in the example (#61622) 2019-09-03 10:09:47 -05:00
Kevin Breit
54906a68fe Docs - Add Meraki to platform option list (#61651) 2019-09-03 11:04:39 -04:00
Sebastián Estrella
615f9949c0 Update unit tests requirements/units.txt path (#61656) 2019-09-03 15:49:15 +01:00
René Moser
fd4ff54580 apt: honor cache_update=false on auto-install deps (#56549)
* apt: honor cache_update=false on auto-install deps
* add porting guide
2019-08-30 15:57:58 -04:00
Sandra McCann
1d40d2b572 fix width (#61619) 2019-08-30 13:44:41 -05:00
Alicia Cozine
0e1ec04efb roadmap should reflect upstream release, not downstream (#61611) 2019-08-30 13:07:24 -04:00
Toshio Kuratomi
8f6dbb732a
[WIP] Cleanups and version bumping for 2.10 (#61572)
* Cleanups and version bumping for 2.10

* Fix changelog url now that stable has been branched

* Fix the lenth of the porting guide title now that the version is two digits
2019-08-30 09:54:12 -07:00
Ganesh Nalawade
d3d9c5c273 Fix doc for network_cli connection retry timer (#61509) 2019-08-29 10:24:43 -04:00
Felix Fontein
0c592c8225
CloudStack modules: rename _facts -> _info (#61090)
* Rename cloudstack _facts -> _info

* Add changelog.

* Fix errors due to overloaded get_result having different parameter names.

* Fix examples.

* Change debug tasks.

* Remove unneeded code.

* Change from rename -> deprecate+new module.

* Make cs_zone_info return a list.

* Make cs_instance_info return a list.

* Fix return value docs.

* Fix typo.

* Improve tests.

* Fix cs_zone_info.

* Linting.

* Fix alias/option switch.

* Fix version numbers.

* Extend docs.
2019-08-29 16:14:51 +02:00
Matt Martz
017562013a
Add porting guide entry for gathering facts tag change (#61180)
* Add porting guide entry for gathering facts tag change

* Use code-block
2019-08-29 08:38:13 -05:00
Sloane Hertel
0b7d478200 add porting guide for bare vars in conditionals (#60943) 2019-08-29 08:08:29 -04:00
René Moser
3bfeae9040 vultr: add changelog and update porting guide (#61520) 2019-08-29 11:49:00 +02:00
Felix Fontein
a6f828e2ab Reordering entries. (#61491) 2019-08-28 18:49:14 -05:00
James Cammarata
51b33b79c0
T woerner max concurrent (#60702)
* play, block, task: New attribute forks

With this it is possible to limit the number of concurrent task runs.
forks can now be used in play, block and task. If forks is set in different
levels in the chain, then the smallest value will be used for the task.

The attribute has been added to the Base class as a list to easily provide
all the values that have been set in the different levels of the chain.

A warning has been added because of the conflict with run_once. forks will
be ignored in this case.

The forks limitation in StrategyBase._queue_task is not used for the free
strategy.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Handle forks in free strategy

The forks attribute for the free strategy is handled in run in the free
StrategyModule. This is dony by counting the amount of tasks where the uuid
is the same as the current task, that should be queued next. If this amount
is bigger or equal to the forks attribute from the chain (task, block,
play), then it will be skipped to the next host. Like it is also done with
blocked_hosts.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Test cases for forks with linear and free strategy

With ansible_python_interpreter defined in inventory file using
ansible_playbook_python.

Signed-off-by: Thomas Woerner <twoerner@redhat.com>

* Changing forks keyword to throttle and adding some more docs
2019-08-28 18:47:39 -05:00
Sam Doran
73248bf27d validate-modules - Use error codes instead of numbers (#60711) 2019-08-28 14:12:56 -07:00
Felix Fontein
59ab4d9307
oVirt: rename _facts -> _info (#61299)
* Rename oVirt _facts -> _info

* Adjust PR #.

* Forgot update BOTMETA / ignore.txt for doc fragment.

* Compatibility for 3rd-party modules using module_utils or info doc fragment.

* Update note.

* Fix/improve docs.

* Update lib/ansible/modules/cloud/ovirt/ovirt_event_info.py

Co-Authored-By: Sloane Hertel <shertel@redhat.com>

* Fix variable.

* Fix return value documentation for ovirt_external_provider_info.
2019-08-28 21:01:46 +02:00
Spencer
21892aaf51 Correct grammar of contribute-message in footer. (#61414)
Adds a comma to the "you can edit this documentation" message in the footer on every documentation page.
2019-08-28 11:41:07 -05:00
Sandra McCann
92d57796dd Update Ansible sphinx theme to rtd theme version 0.4.3 (#61189)
* update theme.conf, header, footer, etc.
* clean up layout.html
* move large Ansible changes out of theme.css
* maxify theme to help merge
* remove redundancies, fix top nav bar
* add Ansible color to header and left-nav menu
2019-08-28 10:47:11 -05:00
smile37773
161c1ce17e Rename Azure modules: "facts"->"info" (#61417)
* rename

* add symlink

* add the log

* fix the ignore file

* fix

* fix
2019-08-28 19:01:10 +08:00
Ganesh Nalawade
768dbe5490
Add support for network_cli connection retry (#61103)
* Add support for network_cli connection retry

*  Add network_cli connection configuration option
   to allow retrying the connection initialization
   with remote host.

* Add docs

* Fix test failures

* Fix review comments
2019-08-28 09:46:42 +05:30
Matt Clay
f510d59943
Support relative imports in AnsiballZ. (#61196) 2019-08-27 18:11:21 -07:00
Jordan Borean
66f52b74b1 Change collection PS util import pattern (#61307)
* Change collection PS util import pattern

* Add changes for py2 compat

* fix up regex and doc errors

* fix up import analysis

* Sanity fix for 2.6 CI workers

* Get collection util path for coverage collection
2019-08-27 16:02:27 -07:00
Alicia Cozine
a6f585eb62 remove the word "support" from Windows pages, add Windows Server 2019 (#61404)
* remove support from Windows pages, add Windows Server 2019

* jborean feedback

* Removed CBT info

Removed the CBT note about what transports Ansible actually supports. We've worked with both NTLM and Kerberos for a while now.
2019-08-28 08:05:12 +10:00
Felix Fontein
c9a9bd9d64
OneView: rename _facts -> _info (#61208)
* Rename OneView _facts modules -> _info

* Adjust PR #.

* Forgot to update test names.

* Remove superfluous blank line.

* Some more things from review.
2019-08-27 23:21:40 +02:00
Alicia Cozine
6ad40fd6b8 removes the word 'support' from appendix pages (#61409) 2019-08-27 17:11:53 -04:00
smile37773
5438013191 Rename Azure modules: facts -> info (#60987) 2019-08-28 04:44:57 +08:00
Felix Fontein
2db4e044ab smartos_image_facts: rename to smartos_image_info (#60915)
* Rename smartos_image_facts -> smartos_image_info

* Add changelog.
2019-08-27 16:43:10 -04:00
Felix Fontein
e176023c6b Scaleway: rename _facts -> _info (#61095)
* Rename scaleway _facts -> _info

* Add changelog.

* Improve docs.
2019-08-27 16:39:24 -04:00
Felix Fontein
185a1fcb07 Online: rename _facts -> _info (#61091)
* Rename online _facts -> _info

* Add changelog.
2019-08-27 16:36:55 -04:00
Felix Fontein
1906c05348
vertica_facts: rename to vertica_info (#60916)
* Rename vertica_facts -> vertica_info

* Add changelog.

* Fix porting guide.
2019-08-27 21:28:36 +02:00
Felix Fontein
c91929b2b3 OpenStack: rename _facts -> _info (#61197)
* Rename openstack _facts -> _info

* Add new module names to module_defaults.yml.
2019-08-27 11:50:14 -04:00
pratikgadiya12
8ee7d9f598 VMWare - Rename _facts to _info (#57474)
Deprecate vmware's _facts modules and add new modules.

Fixes: #57278
2019-08-26 14:45:34 -04:00
Felix Fontein
47c2ff4c26
Redfish modules: rename _facts -> _info (#60992)
* Rename redfish_facts -> redfish_info, idrac_redfish_facts -> idrac_redfish_info

* Update porting guide.

* Add changelog.

* Fix metadata.

* Remove copy artefacts.

* Change from deprecate/new module to rename.
2019-08-26 20:42:04 +02:00
Felix Fontein
e536d0e128
openssl_*: deprecate PyOpenSSL backends (#59907)
* Deprecate PyOpenSSL backends.

* Add changelog.

* Add porting guide entry.

* Improve tests to ignore deprecations when comparing results.

* Deprecating pyopenssl backend for get_certificate and openssl_publickey.

* Fix typo.
2019-08-26 18:26:10 +02:00
Nathaniel Case
f3f30c146b
Deprecate net_* modules (#60818)
* Deprecate net_ modules

* Move modules to finish deprecation

* Add missing `why`, move net_static_route

* Add changelogs and porting guide
2019-08-26 09:07:54 -04:00
Trishna Guha
5a04b4feb6
Add nxos_l2_interfaces resource module (#61120)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2019-08-26 16:46:05 +05:30
Felix Fontein
c3b1a0a7e8 Vultr: rename _facts -> _info (#61239) 2019-08-24 17:54:17 +02:00
Jay Carman
fabd912fa5 Fix typo in 'Ansible and Python 3' dev guide (#61226)
The underscore does not need to be escaped inside of the RST inline
literal.
2019-08-23 15:53:25 -04:00
Ryan Conway
e4c1c05363 Renaming onepassword_facts to onepassword_info. (#61237)
* Renaming `onepassword_facts` to `onepassword_info`.

* Update module examples.

* Add changelog fragment.

* Add module rename to the 2.9 porting guide.

* Document the parameter types in the module docs.

* Fix incorrect parameter name.

* Update docs/docsite/rst/porting_guides/porting_guide_2.9.rst

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Remove `onepassword_facts` as it has been renamed to `onepassword_info` including fixes for the sanity tests.
2019-08-23 20:45:13 +02:00
Rohit
11ba2a965d
platform guide updates (#61121)
* platform guide updates

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>
2019-08-23 20:23:50 +05:30
Felix Fontein
fa70690e5c
openssl_certificate/csr(_info): add support for SubjectKeyIdentifier and AuthorityKeyIdentifier (#60741)
* Add support for SubjectKeyIdentifier and AuthorityKeyIdentifier to _info modules.

* Adding SubjectKeyIdentifier and AuthorityKeyIdentifier support to openssl_certificate and openssl_csr.

* Fix type of authority_cert_issuer.

* Add basic tests.

* Add changelog.

* Added proper tests for _info modules.

* Fix docs bug.

* Make sure new features are only used when cryptography backend for openssl_csr is available.

* Work around jinja2 being too old on some CI hosts.

* Add tests for openssl_csr.

* Add openssl_certificate tests.

* Fix idempotence test.

* Move one level up.

* Add ownca_create_authority_key_identifier option.

* Add ownca_create_authority_key_identifier option.

* Add idempotency check.

* Apparently the function call expected different args for cryptography < 2.7.

* Fix copy'n'paste errors and typos.

* string -> general name.

* Add disclaimer.

* Implement always_create / create_if_not_provided / never_create for openssl_certificate.

* Update changelog and porting guide.

* Add comments for defaults.
2019-08-23 14:01:42 +02:00
Trishna Guha
f0ef624cff
Add nxos_l3_interfaces resource module (#61021)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2019-08-23 15:06:26 +05:30
Felix Fontein
18f7c3b850
Netapp: rename _facts -> _info (#60980)
* Rename na_ontap_gather_facts -> na_ontap_info
Rename netapp_e_facts -> netapp_e_info

* Add changelog.

* Fix sanity.

* Forgot test.

* Forgot to remove 'gather'.

* Fix sanity ignore.

* Remove netapp_e_facts from PR.

* Remove superfluous version_added.
2019-08-22 22:51:45 +02:00
Brett Campbell
5b16e012a4 Doc fixes for readability (formatting/punctuation) (#61086)
Variable-width font was extremely difficult to read in a couple places.
Fixed missing close-quote, colon, spelling, etc.
2019-08-22 15:29:53 -04:00
Nilashish Chakraborty
d06930d6f6 Add iosxr platform guide (#60936)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2019-08-22 14:05:15 -04:00
Toshio Kuratomi
c1547f10d6 Fix table headers and width (#60549) 2019-08-21 16:55:16 -04:00
Dustin Miller
20ced48717 Update link to user data knowledge base (#60991)
Removes old broken link, replaces with with updated and confirmed working link
2019-08-21 13:26:44 -05:00
G. Weixelbraun
ab027611d5 fix typo in become.rst (#61011)
change remote_src: yex to remote_src: yes in documentation
2019-08-21 10:58:45 -05:00
Lukas Kämmerling
96199be96b Rename hcloud_*_facts to hcloud_*_info (#60926)
* Rename hcloud_datacenter_facts to hcloud_datacenter_info

* Rename hcloud_location_facts to hcloud_location_info

* Rename hcloud_image_facts to hcloud_image_info

* Rename hcloud_floating_ip_facts to hcloud_floating_ip_info

* Rename hcloud_server_type_facts to hcloud_server_type_info

* Rename hcloud_server_facts to hcloud_server_info

* Rename hcloud_ssh_key_facts to hcloud_ssh_key_info

* Rename hcloud_volume_facts to hcloud_volume_info

* Fix typo in hcloud_image_info

* Add to porting guide and add changelog fragment

* Reword porting guide
2019-08-21 14:55:37 +02:00
Felix Fontein
c1b2aa1d11
nginx_status_facts: deprecate/rename to nginx_status_info (#60979)
* Rename nginx_status_facts -> nginx_status_info

* Add changelog.

* Remove warnings.

* Re-add ignore.txt entries.

* ...

* Raw strings for docs.

* Use U(...) for link.
2019-08-21 09:09:22 +02:00
Rohit
8b3ff933af
Vyos lldp interfaces (#60931)
* module_utils checkin

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* vyos lldp_interfaces merging

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* shippable fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* merge changes

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* failure added in ignore list

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* comments incorporated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* comments incorporated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* test cases updated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* remove global commands

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>
2019-08-21 12:30:13 +05:30
Toshio Kuratomi
5f227fe260 Install ansible-test (#60718)
* Install ansible-test

Modify the install script to install ansible-test and its supporting
code.  Alternative to #60701 that doesn't change package_dir ansible for
fear that it might regress https://github.com/ansible/ansible/issues/10437

Also:
* No longer use package_data.  Everything in the package dirs is going
  to be installed.  Anything that shouldn't be installed needs to be
  moved elsewhere.
* modify the algorithm to store symlinks which are in the same tree
  instead of same directory

* Add ansible_test files to package-data sanity test

* MANIFEST.in cleanups

* Add lib/ansible/config/*.yml
* Make most things in code directories (lib/ansible and test/lib/ansible_test/)
  use explicit file extensions instead of wildcards for maintainability
* Exclude common file extensions that we don't want included in the code
  directories

* Change package-data test to be more complete

* Now compares the repository, sdist, and install
* Compares both that everything in the sdist is in the repo and
  everything in the install is in the sdist in addition to comparing that
  everything in the repo that we want is in the install

* Leave out test artifacts

Only include the directory structure for test/results and test/cache not
any files that may have been generated by test runs

Remove test/utils files from the sdist as these are only needed for our CI

cleanup of docs in MANIFEST.in; getting rid of build files.

* Add the ability to output sdist and snapshot to specific directory

* Add a warning about modifying the heuristic to setup.py

* Address generated files

* Use make snapshot instead of sdist to generate changelog and man pages
  and make sure they're included
* Ignore both the test/utils and generated test files (results, cache)
* Deal with Python3 __pycache__ byte code caches
* Don't check documentation, that isn't built for the sdist
* Restructure for clarity

* Add cli web docs to make clean

This was causing problems when attempting to test that the sdist didn't
have extra files

* Fix bug constructing python names from __pycache__ names

* Create a clean repo to work from

* Exclude test/legacy and be more explicit on extensions

* Exclude the legacy directory from sdist
2019-08-20 23:53:35 -07:00
Jordan Borean
e747487720
ansible-galaxy - define multiple galaxy instances in ansible.cfg (#60553)
* ansible-galaxy: support multiple servers on install

* Added docs for the server configuration file

* Fix up doc string for requirements file format

* Fix bugs after testing

* Fix kwarg doc and added version

* Fix typo and doc improvement

* Fix base64 encoding and allow --server to override list
2019-08-21 07:49:05 +10:00
Kevin Breit
543401f83b Collections documentatation - Add information about semantic versioning (#60969) 2019-08-20 14:59:01 -04:00
Matt Martz
ba25522db4
Remove ddeprecated redis_kv lookup. Fixes #59984 (#60826) 2019-08-20 10:27:09 -05:00
Mark Chesney
11be31db71 Fix naming discrepancy in zip filter example (#60918)
Fix naming discrepancy in zip filter example
2019-08-20 09:53:15 -05:00
Felix Fontein
e58919bccd
gluster_heal_facts: rename to gluster_heal_info (#60919)
* Rename gluster_heal_facts -> gluster_heal_info

* Add changelog.
2019-08-20 15:43:41 +02:00
Felix Fontein
c66163b118
hpilo_facts: rename to hpilo_info (#60917)
* Rename hpilo_facts -> hpilo_info

* Fix porting guide.

* Add changelog.
2019-08-20 15:14:18 +02:00
Ganesh Nalawade
49736b6b27
Add support to configure network_cli terminal related options (#60086)
* Add support for configurable terminal plugin options

Fixes #59404

*  Add terminal options to support platform specific login menu
*  Add terminal options to support configurable options for stdout
   and stderr regex list

* Fix CI failures

* Fix CI issues

* Fix review comments and add integration test

* Fix sanity test failures

* Fix review comments

* Fix integration test case

* Fix integration test failure

* Add support to configure terminal related options

Fixes https://github.com/ansible/ansible/issues/59404

*  Add network_cli configurable options to support platform specific login menu
*  Add network_cli configurable options to support configurable options for stdout
   and stderr regex list

* Fix review comment

* Fix review comment
2019-08-19 18:56:20 +05:30
Rohit
d8f9904f43
vyos_lldp_global (#59627)
* vyos_lldp_global

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity checks

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* deprecated changes

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* comments incorporated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* test cases updated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* comments incorporated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* branch conflict resolved

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity check passes

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>
2019-08-19 17:31:09 +05:30
Felix Fontein
ceff0029cb
openssl_certificate: deprecate assertonly provider (#60623)
* Add deprecation marks.

* Add conversion example.

* Split long line.

* Add changelog and porting guide entry.

* Fix unrelated porting guide entry.

* Fix format.

* Fix doc mistakes found in review.

* Fix filter name.

* Compare CSR and cert subject via subject_ordered.
2019-08-18 05:09:49 +02:00
Jon Pugh
6a5cbcf8b8 Link to the GitHub Web UI for the example file. (#60611)
Change link in the Ansible Config docs to the example `ansible.cfg` file, from the raw download to the web user interface.
2019-08-16 15:09:43 -05:00
Jeff Geerling
9c61ef10d1 Fix typo and uses more common role syntax in usage examples (#60165)
* Fix typo and use import_role in examples
2019-08-16 09:34:45 -05:00
Jiri Tyr
da18e3b76c Updating intro_inventory.rst (#60676) 2019-08-16 09:23:58 -05:00
Patrick Marques
39d249155a Deprecates Digital Ocean sshkey_facts in favor of new module sshkey_info (#60546)
* Renames Digital Ocean sshkey_facts modules to sshkey_info

* Change digital_ocean_sshkey_facts status to deprected

* Update digital_ocean_sshkey _facts _info doc

* Allow digital_ocean_sshkey_info in Check Mode

* Update lib/ansible/modules/cloud/digital_ocean/_digital_ocean_sshkey_facts.py

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Fix _info added version
2019-08-15 23:45:05 +02:00
Simon Dodsley
491a47c7c5 Pure modules: rename _facts with ansible_facts result to _info (#60641) 2019-08-15 22:42:35 +02:00
Jiri Tyr
c4d841f848 Updating intro_inventory.rst (#60651) 2019-08-15 14:42:37 -05:00
Jiri Tyr
31d6d7ada5 Updating developing_inventory.rst (#60647) 2019-08-15 14:41:37 -05:00
Ganesh Nalawade
535ef2e5ec
Update porting guide deprecated modules for junos (#60468)
*  Add deprecating junos modules in porting guide
2019-08-15 09:49:50 +05:30
Aaron
d808b84621 Update intro_getting_started.rst to take into account inventory precedence when proposing '-u' to change the remote user. (#59858)
* Update intro_getting_started.rst
* adds more info about overriding SSH user to intro
2019-08-14 14:29:41 -05:00
Rohit
69bc24f607
lag interfaces resource module (#59175)
* lag interfaces resource module

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity check imports

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* sanity fixes

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* dict_diff usage issue fix

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* new task

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* overridden updated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* dict update

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* comments incorporated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* facts merged

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* rebased and merged

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* new failures added

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* obsolete file removed

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* test cases updated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* comments incorporated

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>

* dependency added

Signed-off-by: rohitthakur2590 <rohitthakur2590@outlook.com>
2019-08-14 17:31:49 +05:30
Trishna Guha
d5d88f9b11
Add nxos_interfaces resource module (#60421)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2019-08-14 13:38:22 +05:30
Toshio Kuratomi
3f784caed1 Table fixing (#60177)
* Change formatting of the network/user_guide tables

* Tables had hardcoded line breaks to workaround a bug in the
  read-the-docs theme.  Change those so that they now flow according to
  the browser size.

* Also switch away from grid tables to the simpler to create and read
  simple tables

* Changes to table stylesheet

* valign all content, not just the first column.  This becomes important
  with more than two columns
* Set the font-weight to the first <p> element inside of the first
  column.  This allows us to simplify the first column when everything
  there is the attribute name

* Change platform_index footnote from numbered to dagger symbol

The footnote notation was very odd to read.  Try using a symbol for the
footnote instead of a number to see if that will clarify it.  We can't
manually specify symbolled footnotes, though, so we have to emulate a
footnote with an internal link.  This loses the backref to each place
that the footnote was used but since that was the portion which was hard
to read, perhaps that's for the best.
2019-08-13 18:23:32 -05:00
Toshio Kuratomi
d9b3af523b Galaxy meta docs table (#60171)
* Use an rst table instead of a raw html table

* Rst is easier to read so we want to use it wherever possible
* Fix the jinja2 filters which create links so that they do not include
  extraneous whitespace in the URL

* Normalize description data before sending them to the templates
2019-08-13 15:00:13 -05:00
Christian
49dea22467 Update developing_plugins.rst (#60482)
##### SUMMARY
documentation example-yaml for lookup-plugin seems to have an indent-error


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2019-08-13 10:43:38 -05:00
Felix Fontein
fca8a5ef76 Move all module renames into new section. (#60483) 2019-08-13 10:05:31 -05:00
Jered Sutton
6915ea96f1 Clarify behavior of --skip-tags, --list-tasks, and --list-tags. (#60492) 2019-08-13 09:47:28 -05:00
Felix Fontein
2d98734ad5 Amazon modules: rename _facts with ansible_facts result to _info (#60178)
* aws_s3_bucket_facts -> aws_s3_bucket_info

* cloudformation_facts -> cloudformation_info

* cloudfront_facts -> cloudfront_info

* ecs_service_facts -> ecs_service_info

* efs_facts -> efs_info

* Add changelog and porting guide entry.

* lambda_facts -> lambda_info

* Improve examples.

* Add subsection on renamed modules.

* Add sentence on registering variables.

* Fix ReST.

* Instead of renaming lambda_facts, deprecate it and replace with new module.

* Rename internal variable.

* Re-add sanity ignores for lambda_facts.
2019-08-13 08:01:37 -04:00
James Cassell
8bca160363 add vfat to selinux special_context_filesystems (#59823)
vfat is the format of the /boot/efi partition on UEFI hosts and does
not support SELinux labels

add an environment variable for this config option
2019-08-12 14:45:27 -04:00
Jill R
1d6bce961c VMware: Add writing new tests subsection to vmware_guidelines (#60163)
* Add writing new tests subsection to vmware_guidelines

Specifically address use of the prepare_vmware_tests role
Point to common vars for use by test writers

Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
2019-08-12 11:13:21 +02:00
Otto Winter
e4dc17fa9f Fix small typo in pip install guide (#60389)
Noticed this small typo in the docs:
- `Ansble` -> `Ansible`
2019-08-12 10:21:00 +05:30
Alex Stephen
2e90efd4a7 Changing GCP Facts modules to Info Modules (#60172)
* file changes, porting guide, changelog fragment, renaming autoscaler, removing rst links
* Apply suggestions from code review

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-Authored-By: Felix Fontein <felix@fontein.de>
2019-08-09 15:13:08 -05:00
Matt Clay
5a50fb35df Add sanity test for obsolete files.
This will help prevent accidental merging of content to recently obsoleted directories when adding new files.

It may also help contributors who have modified obsolete files understand where their changes should now be made.
2019-08-09 11:22:59 -07:00
Jeff Geerling
1405e48157 Fix documentation for collection build code example (#60156) 2019-08-09 11:05:05 -05:00
Matt Clay
df59f06d6a
Additional ansible-test path fixes. (#60300)
* Add missing ansible-test injector symlink.
* More ansible-test path fixes.
* Expand bin-symlinks docs.
2019-08-08 23:51:03 -07:00
Matt Clay
39b3fc0926 Update ansible-test layout and payload handling. 2019-08-08 21:34:38 -07:00
Sandra McCann
ed21aba442 add link to content collector tool (#59881) 2019-08-08 14:17:26 -05:00
Toshio Kuratomi
b0ec91e69e Autointerpreter table (#60148)
* Some framework for docs

* Separate CSS file for our site-specific CSS.
* Override the read-the-docs theme for tables so that tables don't
  always horizontally scroll
* Add a |br| substitution that lets us line break inside of tables
* Add |_| non-breaking-space substitution which is also for formatting
  tables
* Configure rstcheck to ignore all substitutions which are being added
  by sphinx in the conf.py

* Fix table of auto interpreter options

The table was being hardcoded at a certain width to work around a
read-the-docs theme bug.  Fix the bug instead and format the table using
better sphinx practices.

* Remove unused substitutions

We had substitutions defined that were never used in our documentation.
Remove those.

Also add to the rstcheck whitelist three substitutions which are defined
by sphinx itself, version, release, and today.
2019-08-08 13:56:07 -05:00
Matt Clay
a93a0c8fd6
Relocate validate-modules for easier testing. (#60214)
* Relocate module validator code and tests.
* Fix validate-modules entry point and imports.
* Fix paths and test entry points.
* Fix up unit tests.
* Fix shebang and execute bit.
2019-08-07 09:34:11 -07:00
Matt Clay
18867847f4
Split up "code smell" sanity tests. (#60174)
* Relocate ansible-only sanity tests.

* Get "code smell" sanity tests from multiple dirs.

- `test/lib/ansible_test/_data/sanity/code-smell/` - General purpose tests used for both Ansible and Ansible Collections.
- `test/sanity/code-smell/` - Tests specific to Ansible, will not be used for Ansible Collections.
2019-08-06 17:17:57 -07:00
Matt Clay
d651bda123
Relocate ansible-test code. (#60147)
* Initial move of `test/runner/` content.

`test/runner/lib/` -> `test/lib/ansible_test/_internal/`
`test/runner/`     -> `test/lib/ansible_test/_internal/data/`

* Initial move of `test/sanity/` content.

`test/sanity/` -> `test/lib/ansible_test/_internal/data/sanity/` (except `test/sanity/ignore.txt`)

* Initial move of `test/units/pytest/` content.

`test/units/pytest/` -> `test/lib/ansible_test/_internal/data/pytest/`

* Follow-up move of `test/runner/unit/` content.

`test/lib/ansible_test/_internal/data/unit/` -> `test/lib/ansible_test/tests/unit/`

* Initial move of `ansible.cfg` content.

`test/units/ansible.cfg` -> `test/lib/ansible_test/_internal/data/units/ansible.cfg`
`test/env/ansible.cfg` -> `test/lib/ansible_test/_internal/data/env/ansible.cfg`

* Follow-up move of `data` directory.

`test/lib/ansible_test/_internal/data/` -> `test/lib/ansible_test/_data/`

* Update import statements.

* Add missing __init__.py for unit tests.

* Fix path references and miscellaneous issues.
2019-08-06 14:43:29 -07:00
Nilashish Chakraborty
2c432f8bc7
Add vyos_l3_interfaces resource module (#59929)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2019-08-06 19:30:58 +05:30
kfattig
dd7b9627ad Runas docs (#60082)
* Mention seclogon requirement in runas docs

* Mention seclogon requirement in Win become docs
2019-08-06 10:44:17 +10:00
Matt Clay
71e607dceb
Update docs references for ansible-test. (#60109)
* Remove outdated info from azure-requirements docs.
* Correct validate-modules usage.
2019-08-05 14:56:05 -07:00
Matt Clay
31c7a61f9d
Clean up old ansible-test references and code. (#60103)
* Remove obsolete ansible-test retry.py.
* Use ansible-test from bin/ intead of test/runner/.
2019-08-05 13:29:50 -07:00
Felix Fontein
aecdfd397e ecs_taskdefinition_facts: rename to ecs_taskdefinition_info (#60023)
* Rename ecs_taskdefinition_facts to ecs_taskdefinition_info.
2019-08-05 12:47:35 -07:00
Toshio Kuratomi
97d36881e2 Try to clarify the wording (#59956)
* Try to clarify the wording

People were confused by this paragraph.  They read it as Ansible won't
auto-detect the python interpreter until 2.12.  Tried to reword it so
that they'll see that Ansible will auto-detect it currently if
/usr/bin/python is not present and in the future will always autodetect.

* Format the other instances of /usr/bin/python using :command:
2019-08-02 12:50:02 -04:00
Felix Fontein
f3e20346cb
Google: gcpubsub_facts -> gcpubsub_info (#57668)
* Rename gcpubsub_facts -> gcpubsub_info.

* Update porting guide and add changelog fragment.
2019-08-02 17:27:28 +02:00
Matt Clay
2be2ae366e Remove obsolete docs on pep8 sanity test. 2019-08-01 22:34:09 -07:00
itercheng
eea46a0d1b Support Ericsson device management (#59277)
* Support Ericsson device management

* modify code

* modify error

* delete redundant file

* delete file

* modified error

* modify additional file name

* delete code

* add blank line

* delete redundant code

* add platform_eric_eccli.rst

* modify syntaxError

* modify document

* modify error

* modify maintaners

* modify document

* add end_string
2019-08-01 16:55:10 +05:30
Mario Lenz
3aa73cb6b8 VMware: Refactor vmware_cluster into several modules (#58468)
Refactor vmware_cluster into several modules (vmware_cluster, vmware_cluster_drs, vmware_cluster_ha and vmware_cluster_vsan) as discussed in #58023.

vmware_cluster lacks a lot of configuration options for DRS, HA and vSAN. Implementing them
all in vmware_cluster would make the module hard to maintain. Therefore, splitting it into several
modules and implementing the missing configuration options in them seems a good idea to me.

This is step one, refactoring vmware_cluster into several modules. Step two, implementing more
configuration options for DRS, HA and vSAN, will follow.
2019-08-01 10:35:29 +02:00
Nilashish Chakraborty
730fa78ca4
Add vyos_interfaces resource module (#58589)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
2019-07-31 23:06:53 +05:30
Sandra McCann
9aa3130cd1
clarify what a namespace is or is not (#59809) 2019-07-31 10:58:16 -04:00
sushma-alethea
f2cb44633a Modules to manage ICX devices (#58969)
* new module

* new terminal

* new terminal

* new cliconf

* cliconf

* icx cliconf

* icx_cliconf

* icx test units module

* icx units module

* icx banner unit test

* PR changes resolved

* changes resolved

* Changes Resolved

* check_running_config changes resolved

* added notes

* removed icx rst

* new commit

* new changes

* deleted icx rst

* icx .rst

* modified platform_index.rst

* modified platform_index.rst

* changes resolved

* PR comments resolved

* Update platform_index.rst

PR comment resolved
2019-07-31 20:01:41 +05:30
Peter Mounce
24d8e82655 Windows Setup doc; offer 10x perf improvement (#58259)
* Windows Setup; document 10x perf improvement
2019-07-30 15:53:17 -04:00
Steven B
05c586e3ef #54195 List supported platforms for RH customers (#59654)
* #54195 List supported platforms for RH customers
2019-07-30 09:09:42 -04:00
Ganesh Nalawade
127bd67f6e
Render elements in module doc and sanity test for sub-options (#59244)
* Render elements in module doc and sanity test for suboptions

*  Add support to render module elements value in ansible-doc output
   module html
*  Add validate-module sanity test of sunoptions.

* Add current validate module failures to ignore list

* Fix CI failure

* fix rebase conflict

* Fix CI issues

* Fix review comments

* Add validate-modules failure in ignore list
2019-07-30 12:07:21 +05:30
Sandra McCann
fe3459ef86 add module_utils example (#59661)
* add module_utils example to collections docs
2019-07-28 15:40:17 -05:00
Sandra McCann
30c1d9754d Style end edit changes to collections doc (#59658)
* copy-edit of file
2019-07-26 14:18:49 -05:00
Matt Clay
b4494fa547 Remove redundant "Sanity Tests »" from page title.
The docs now have multi-level breadcrumbs so including "Sanity Tests »" in the title on a sanity test page is redundant.
2019-07-26 09:07:42 -07:00
Matt Clay
5ed469f6b7 Fix sanity docs page titles.
The titles are used to generate the index of sanity tests, so they should match the name of the test.
2019-07-26 08:39:34 -07:00
Gonéri Le Bouder
964783fbd2 vmware_guest: speed up vmware_guest tests
- Use predictable VM name during the tests (test_vm1, test_vm2 and
  test_vm2). This to simplify the teardown of the newly created resource
  before the next test.
- Update the documentation to explain the new requirement
- Avoid VM creation with `with_items` when it's not mandatory. This to:
    - speed up the test execution, our hypervisors have limited resources
    - simplify the teardown
- Remove `create_d1_c1_f0_env.yml`, the test was just testing how Ansible
  pass environment variables.
- Correct the name for the `f0` variable (`f1`)
- Fix the DVS tests, the hosts can now reach the dvswitch1 vswitch
- Provision the VM with a poweroff status, this to improve the
  idempotency and sleep up the tests
- Avoid the use of `prepare_vmware_tests` to prepare virtual machines
  when we just need one machine
2019-07-26 14:07:01 +02:00
Matt Clay
db7e9aa051
Use consolidated ignore.txt in ansible-test. (#59618) 2019-07-25 23:29:23 -07:00
Jordan Borean
9551528ba0 Replace Mazer references with ansible-galaxy (#59487)
* Replace Mazer references with ansible-galaxy
2019-07-25 11:45:00 -04:00
Matt Martz
95f4282c42
Verify package data in setup.py installs all files (#59537)
* Add sanity test to ensure all non-py files are installed

* Fix mode and regex

* Fix role skel inventory package_data

* Add docs

* Update package_data for inventory files

* Address pylint concerns

* Another tweak to package_data

* Address review feedback

* Change index to 1

* add to ansible-only.txt
2019-07-24 13:58:13 -05:00
Yannis100
8d1b82a26e Typo in the Warning block eneabled -> enabled (#59524)
* Typo in the Warning block eneabled -> enabled
2019-07-24 11:59:13 -04:00
Yannis100
0a081e14d5 Fix inconsistency nxos->ios role (#59521)
Chapter "Ansible supported network roles"
2019-07-24 11:57:34 -04:00
Sandra McCann
cb1dd6d77b remove molecule mentions (#59441) 2019-07-23 13:12:13 -05:00
Trishna Guha
3bad4d6a50
Add nxos_lag_interfaces resource module (#59031)
* Add nxos_lag_interfaces resource module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* ix CI failure

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* module_utils nxos transport-provider fix

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* CI failure

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* nxos_lag_interfaces tests

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Integration test

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2019-07-23 11:11:37 +05:30
Jordan Borean
65049620ee
Generate galaxy.yml based on single source of truth (#59170)
* Generate galaxy.yml based on single source of truth

* Fix up tests and align file names

* Minor Makefile tweak

* Remove link in galaxy.yml file and make it a template file

* Moved collections docs to dev_guide

* change Makefile clean path

* Added readme to example meta file

* review fixes

* Use newer style for doc generation script

* Fix mistake in dev_guide index

* removed uneeded file, fixed links and added preview banner

* Moved banner for sanity test
2019-07-23 06:50:46 +10:00
Tomáš Pospíšek
28b9f71640 remove ambiguity: use "my_test" as module name (#59335)
Naming a module "something_module" is misleading (see below). Let's drop the "_module" part of the module name on the developing_modules_general page.
2019-07-22 14:58:12 -05:00
n3pjk
6531819172 snow: Fix token reference in basic authentication (#59315)
* Fix OAUTHClient logic
* Add Env variable support for snow modules

Fixes: #59299

Signed-off-by: Paul Knight <paul.knight@state.de.us>
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2019-07-22 19:31:04 +05:30
Jordan Borean
015119df8c
Windows - Add common util for web requests (#54759)
* Windows - Add common util for web requests

* Use different method of retrieving options from module arg spec

* Added proper version_added for module options

* Fix linting errors

* Fix proxy issues and updated cred docs

* Fix FTP usage with proxy settings

* Removed uneeded function added in bad rebase

* Fix up client certificate auth

* fix new sanity checks

* Edit http agent code and update porting guide
2019-07-22 08:42:24 +10:00
Jordan Borean
1f3a3fdd3e
win_firewall_rule - removed deprecated force option (#59358) 2019-07-22 08:24:57 +10:00
Sandra McCann
00699735e9 add eol banner (#59254) 2019-07-18 14:15:43 -05:00
pratikgadiya12
393e4a41d0 Added support to create and delete multiple databases in MySQL (#58602)
* Added support to create/delete mulitiple databases in MySQL

Fixes: #58370

* Added additional tests cases and fixed documentation changes

* Code refactoring and added tests for better test coverage

- Removed db_exists usage from most of the code. Used existence_list
 and non_existence_list instead

- Added additional tests to cover all scenarios w.r.t creation and deletion
 on multiple databases

- Added tests for dump operations

* Minor fix

* Minor fix - create check mode test

* Added dump tests for better dump tests coverage

* Removed minor database connection details

* fixed error

* Added test case for import operations

* Code refactoring and review fixes

- Added dump all test case

* Fixed review comments

* Minor review comment fixes

* Altered db_create return value

* Removed db_list and altered "does exist" to just "exist"

* Kept db and db_list in module.exit_json

* Refactored tests

- Added removal of dump2 file

* Moved import tests to state_dump_import file

* Removed import tests from multi_db_create_delete

* Updated porting guide, added RETURN block

* Minor identation fix

* Added validation to check if databases are dumped
2019-07-18 16:56:32 +02:00
Toshio Kuratomi
5392d8697d
Docs scripts cleanup (#59169)
* Fix dump_keywords to require attribute docs

* Change the documentation commands to make definition files positional

Since the definition files are mandatory, make them positional
parameters instead of options.
2019-07-17 12:01:07 -07:00
Brian Coca
48d4d6ec69
Stop ignoring merge hash behaviour in inventory (#58460)
* stop ignoring merge hash behaviour in inventory

fixes #58120

* added porting note

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
2019-07-17 11:16:56 -04:00
Toshio Kuratomi
019d078a5a
Move common build code from _build_helpers (#55986)
We have some common code used by several docs scripts.  Migrate that
into the build-only shared code repository.

* Move lib/ansible/utils/_build_helpers.py to the directory for common
  build code
* Migrate docs/bin/dump_config.py to a build-ansible subcommand
* Migrate dump_keywords to the build-ansible framework
  * Make the script more maintainable by using functions and good
    variable names
  * Port to Python3 idioms
  * Fix bug so that private attributes will be undocumented
* Move generate_man to a build-ansible subcommand
* Port plugin_formatter to a build-ansible subcommand
* Rework command_plugins so that docs scripts can target Python-3.4+ and
  releng-only subcommands can use more recent versions of Python.
  The architecture is now that command_plugins/* need to be importable
  on Python-3.4.  The init_parsers() method needs to run on Python-3.4.
  But the main() method can utilize features of more recent Python as
  long as it fits within those parameters.
* Update docs build requirements

Port the plugin_formatter to build-ansible framework
2019-07-16 12:19:01 -07:00
Rémy Léone
30206d3066 Add an example for the debugging module (#50197)
+label: docsite_pr
2019-07-15 12:00:36 -04:00
d-little
11d61cc01e Swap ordering to ensure Dynamic always first (#58998) 2019-07-12 15:52:06 -05:00
Alicia Cozine
0dd3fb82eb get rid of Sphinx 2.1.2 errors (#59001) 2019-07-12 16:19:08 -04:00
Martin Krizek
aea5b795c0 Make ansible_index_var accessible as a magic var (#59030) 2019-07-12 08:50:19 -04:00
Toshio Kuratomi
33d2728879 Rename python files in hacking/ directory to have .py suffix
ansible-test only passes files which have the .py suffix for sanity
tests on python files.  This change will allow sanity tests to run on
the Python files in hacking/

* Rename test-module to test-module.py
* Symlink test-module for backwards compat since end users may be using
  test-module
* Fix test-module sanity errors that are now triggered
* Rename ansible_profile to ansible-profile.py
* Rename build-ansible
2019-07-10 22:17:35 -07:00
Toshio Kuratomi
146a7f8ff6 Split the metaclass == type and from future boilerplate code.
The metaclass boilerplate is safe to apply en masse.  The future import
boilerplate needs code to be inspected to be sure that there aren't any
py2isms that need to be fixed.  Split these two checks so that we can
fix them independently

Be explicit about which files are grandfathered so we can fix them up one by one
2019-07-10 22:17:35 -07:00
Gonéri Le Bouder
13de8686e5 vmware: vmware_guidelines.rst
VMware specific documentation that explains:

- how to run the functional tests
- and the conventions.
- clarify the difference between govcsim and vcsim

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
2019-07-10 09:40:17 +02:00
Samy Coenen
0befccbeb9 Update intro_inventory.rst (#58732) 2019-07-09 15:56:21 -05:00
Jordan Borean
b6791e6ae3
ansible-galaxy: add collection sub command (#57106)
* ansible-galaxy: add collection init sub command

* Fix changelog and other sanity issues

* Slim down skeleton structure, fix encoding issue on template

* Fix doc generation code to include sub commands

* Added build step

* Tidy up the build action

* Fixed up doc changes and slight testing tweaks

* Re-organise tests to use pytest

* Added publish step and fixed up issues after working with Galaxy

* Unit test improvments

* Fix unit test on 3.5

* Add remaining build tests

* Test fixes, make the integration tests clearer to debug on failures

* Removed unicode name tests until I've got further clarification

* Added publish unit tests

* Change expected length value

* Added collection install steps, tests forthcoming

* Added unit tests for collection install entrypoint

* Added some more tests for collection install

* follow proper encoding rules and added more tests

* Add remaining tests

* tidied up tests and code based on review

* exclude pre-release versions from galaxy API
2019-07-10 05:47:25 +10:00
Sandra McCann
e5a1d85092 clarify FQCN needs for plugins (#58870)
* clarify FQCN requirement, fix example
2019-07-09 12:25:06 -05:00
Brian Coca
c2469648e4 Docs on general precedence (#50201)
* Add docs/docsite/rst/reference_appendices/general_precedence.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
2019-07-09 12:14:40 -05:00
Wojciech Sciesinski
f9a31e3e17 Provide the list of packages in a modern way (#58668) 2019-07-09 12:04:12 -05:00
Sandra McCann
3bfe32b9d9 fixed formatting and spelling issues (#58686) 2019-07-03 13:53:58 -05:00
Sviatoslav Sydorenko
ce79c8eb27 Fix typos in the Collections Tech Preview doc page (#58669) 2019-07-03 13:51:54 -04:00
Marek Anderson
3a919d4bec Doc - editorial for correct acronym introduction (#58519)
Introduce acronym GCP on first use. Introduce GCE acronym at all.
2019-07-01 10:37:13 -05:00
Felix Fontein
f0801879c7 Rename xenserver_guest_facts -> xenserver_guest_info (#57032)
* Rename xenserver_guest_facts -> xenserver_guest_info.

* Add changelog.

* Forgot one test.
2019-06-30 10:04:30 -04:00
Gonéri Le Bouder
2401154fc4 VMware: rename VMWare to VMware (#58535)
Follow the nomenclature convention decided in https://github.com/ansible/ansible/pull/56814
2019-06-30 19:30:42 +05:30
Sandra McCann
35b6345bdc Add a banner message to warn when not on latest documentation (#58526)
* add banner to versions that are not latest

* move div into script

* fix div

* move comment

* fix shippable errors
2019-06-28 15:06:49 -05:00
Nabeel Al-Saber
7afdf11456 Add Oracle scenario guide (#58443)
* Create and update docs/docsite/rst/scenario_guides/guide_oracle.rst
2019-06-28 09:03:42 -05:00
Sloane Hertel
ec1287ca7e
Fix notifying handlers by using an exact match (#55624)
* Fix notifying handlers by using an exact match rather than a string subset if listen is text rather than a list

* Enforce better type checking for listeners

* Share code for validating handler listeners

* Add test for handlers without names

* Add test for templating in handlers

* Add test for include_role

* Add a couple notes about 'listen' for handlers

* changelog

* Add a test for handlers without names

* Test templating in handlers

* changelog

* Add some tests for include_role

* Add a couple notes about 'listen' for handlers

* make more sense

* move local function into a class method
2019-06-27 17:29:20 -04:00
Klaus Frank
ee52b60d7d Add note about delegate_facts to run_once (#58241)
* Add note about delegate_facts to run_once
2019-06-27 17:19:22 -04:00
Alicia Cozine
44b6f2ff56 removes last :doc: links in other sections of the docs (#58432)
* removes last :doc: links in other sections of the docs

* fix references to playbooks intro page
2019-06-27 12:18:17 -04:00
Alicia Cozine
d4f0bc183e removes last :doc: links in user guide (#58433)
* removes last :doc: links in user guide
2019-06-26 17:07:27 -04:00