Commit Graph

1706 Commits (bf108ee7bfc0270715fe26d143bc5885eb398fb5)

Author SHA1 Message Date
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.
5 years ago
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>
5 years ago
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
5 years ago
Jordan Borean 1f3a3fdd3e
win_firewall_rule - removed deprecated force option (#59358) 5 years ago
Sandra McCann 00699735e9 add eol banner (#59254) 5 years ago
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
5 years ago
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.
5 years ago
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>
5 years ago
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
5 years ago
Rémy Léone 30206d3066 Add an example for the debugging module (#50197)
+label: docsite_pr
5 years ago
d-little 11d61cc01e Swap ordering to ensure Dynamic always first (#58998) 5 years ago
Alicia Cozine 0dd3fb82eb get rid of Sphinx 2.1.2 errors (#59001) 5 years ago
Martin Krizek aea5b795c0 Make ansible_index_var accessible as a magic var (#59030) 5 years ago
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
5 years ago
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
5 years ago
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>
5 years ago
Samy Coenen 0befccbeb9 Update intro_inventory.rst (#58732) 5 years ago
Sandra McCann e5a1d85092 clarify FQCN needs for plugins (#58870)
* clarify FQCN requirement, fix example
5 years ago
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>
5 years ago
Wojciech Sciesinski f9a31e3e17 Provide the list of packages in a modern way (#58668) 5 years ago
Sandra McCann 3bfe32b9d9 fixed formatting and spelling issues (#58686) 5 years ago
Sviatoslav Sydorenko ce79c8eb27 Fix typos in the Collections Tech Preview doc page (#58669) 5 years ago
Marek Anderson 3a919d4bec Doc - editorial for correct acronym introduction (#58519)
Introduce acronym GCP on first use. Introduce GCE acronym at all.
6 years ago
Felix Fontein f0801879c7 Rename xenserver_guest_facts -> xenserver_guest_info (#57032)
* Rename xenserver_guest_facts -> xenserver_guest_info.

* Add changelog.

* Forgot one test.
6 years ago
Gonéri Le Bouder 2401154fc4 VMware: rename VMWare to VMware (#58535)
Follow the nomenclature convention decided in https://github.com/ansible/ansible/pull/56814
6 years ago
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
6 years ago
Nabeel Al-Saber 7afdf11456 Add Oracle scenario guide (#58443)
* Create and update docs/docsite/rst/scenario_guides/guide_oracle.rst
6 years ago
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
6 years ago
Klaus Frank ee52b60d7d Add note about delegate_facts to run_once (#58241)
* Add note about delegate_facts to run_once
6 years ago
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
6 years ago
Alicia Cozine d4f0bc183e removes last :doc: links in user guide (#58433)
* removes last :doc: links in user guide
6 years ago
Alicia Cozine 3fc0694ffc removes last :doc: links in the dev guide (#58417) 6 years ago
Sandra McCann 5569135efd create scenario guide template file (#58212)
* create scenario guide template file

* Apply suggestions from code review

Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
6 years ago
ndclt 4376e88849 Coherence between example and text (use of to_native) (#58279) 6 years ago
Sayed Anisul Hoque 57596edcca Updated the playbooks_tags guide (#58011)
* Updated the playbooks_tags guide
6 years ago
markafarrell 43872d6b88 Fix netconf guess_network_os to use ssh_config if supplied. (#55199)
* feature: use network_os=auto to trigger network os guessing

* doc: add debug messages

* fix linting

* fix test_netconf_init default network_os is auto

* add documentation

* fix rst errors

* use init lexer

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update lib/ansible/plugins/connection/netconf.py

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

* Update lib/ansible/plugins/connection/netconf.py

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

* Update lib/ansible/plugins/connection/netconf.py

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

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

* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst

Co-Authored-By: Sandra McCann <samccann@redhat.com>
6 years ago
Sandra McCann f3720c90e0 [WIP] Add dropdown version selection to docsite (#55655)
* docs: Add way to select version for documentation
6 years ago
Lucian Maly 446027341a Update playbooks_strategies.rst (#57784)
* Update playbooks_strategies.rst

##### SUMMARY
This page is very confusing and may suggest, that there is still a `serial` strategy (like it used to), but now it is just a directive of `linear` strategy. Multiple people reported this to me and it needs change.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

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

Co-Authored-By: Sam Doran <sdoran@redhat.com>

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

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* Updates strategies page more broadly

* incorporate samdoran feedback

* fixes broken link

* new page title, focus on user intent

* more sdoran feedback

* adds details on setting the number of forks
6 years ago
Sandra McCann 7765bd41e6 add platform docs to network dev guide (#57960)
* add info on how to create platform docs to network dev guide
6 years ago
Alicia Cozine 158f97bfb2 updates docs reqs to specify Pygments version, remove tornado (#58007) 6 years ago
Sayed Anisul Hoque b768a0780c Update playbooks_vault.rst (#58005)
Corrected the internal reference link to point to the FAQ entry.

+label: docsite_pr
6 years ago
Felix Fontein 505c99265c docsite: remove lexers which have been fixed in Pygments 2.4.0 (#57508)
* Remove lexers which have been fixed in Pygments 2.4.0.
* Add Pygments >= 2.4.0 to test runner.
* Fix pages that triggered lexer errors.

Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
6 years ago
Sayed Anisul Hoque 2bdc4e5b4a Documentation error in the Test if a list contains a value section (#57923)
* Update docs/docsite/rst/user_guide/playbooks_tests.rst - 'contains' test works with 'select/reject' and 'selectattr/rejectattr' but not 'map'
6 years ago
Alicia Cozine 8dfa376e1c removes link from 404 content, explains options (#57971) 6 years ago
Ken Celenza 1a63f8642e Update local module options (#57553)
* Docs: Point out that local plugins can be loaded based on ansible.cfg settings
6 years ago
Alicia Cozine e834cd7d41 updates reqs for building docs locally (#57967) 6 years ago
Alicia Cozine 5658b2ee3e
Adds custom 404 with cowsay image (#57422)
* Adds custom 404 with image, updates CI reqs, sets version latest for TOC links on 404 page
6 years ago
asouini a096fa5c12 filter bare variable with |bool (deprecation warn) (#57691)
* filter bare variable with |bool (deprecation warn)

https://github.com/ansible/ansible/pull/57691#issuecomment-502134480
6 years ago
Brian Coca 49983fdaf7 doc draft for collections (#57853)
* doc draft for collections

* fixes

* Update docs/docsite/rst/collections_tech_preview.rst

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

* Update docs/docsite/rst/collections_tech_preview.rst

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

* Apply suggestions from doc review

* Update docs/docsite/rst/collections_tech_preview.rst

* Update docs/docsite/rst/collections_tech_preview.rst
6 years ago
Pierre-Louis Bonicoli c289006e05 validate-modules: new module: fail if 'type' isn't documented
Don't require 'type' when:
- parameter name starts with an underscore
6 years ago
Sayed Anisul Hoque 78f87f2451 Updated "Speeding up Vault Operations" section (#57701)
* Updated "Speeding up Vault Operations" section


Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
6 years ago
Sayed Anisul Hoque b9c893ec6f Updated the section under "Aborting the play" in the Error Handling In Playbooks page (#57705)
* Updated the section under "Aborting the play"

Updated "Aborting the play" section in the Error Handling In Playbooks page. Removed the reference to marking all hosts as failed.

+label: docsite_pr

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

Co-Authored-By: Sandra McCann <samccann@redhat.com>
6 years ago
Sandra McCann 5243cba0b2 describe how to link to modules or plugins (#57806) 6 years ago
ggeorgg 3efb57f64e Typo (#57795) 6 years ago
Arnaud RENARD 1a5fd720a4 Ansible galaxy role download should not have to perform aditionnal check against tar archive file extension #56616. (#56617)
Ansible galaxy role download checked for `.tar.gz`, but `tarfile.is_tarfile(...)` can identify and open any valid tarfile. This change uses transparent stream compression to make `.tar.gz` and `.tar.bz2` formats valid with python 2.6.x/2.7.x (as well as `.tar.xz` with python 3.x).
6 years ago
Strahinja Kustudic 6131de29d4 Improve regex_replace filter docs (#57450)
* Add a few examples of how to correctly use `regex_replace` filter
because it behaves differently on different Python versions when using
regex qualifiers that can match an empty string (e.g. '*', '?', etc).
6 years ago
Sandra McCann c06f890f55 add docs for vlan_parser filter (#57498) 6 years ago
Felix Fontein 13f73adef5
AWS: _facts -> _info (part 4) (#57651)
* Rename ec2_vpc_dhcp_option_facts -> ec2_vpc_dhcp_option_info.

* Rename ec2_vpc_endpoint_facts -> ec2_vpc_endpoint_info.

* Rename ec2_vpc_igw_facts -> ec2_vpc_igw_info.

* Rename ec2_vpc_nacl_facts -> ec2_vpc_nacl_info.

* Rename ec2_vpc_nat_gateway_facts -> ec2_vpc_nat_gateway_info.

* Rename ec2_vpc_net_facts -> ec2_vpc_net_info.

* Rename ec2_vpc_peering_facts -> ec2_vpc_peering_info.

* Rename ec2_vpc_route_table_facts -> ec2_vpc_route_table_info.

* Rename ec2_vpc_subnet_facts -> ec2_vpc_subnet_info.

* Rename ec2_vpc_vgw_facts -> ec2_vpc_vgw_info.

* Rename ec2_vpc_vpn_facts -> ec2_vpc_vpn_info.

* Update module defaults, add changelog and porting guide.

* Update BOTMETA.
6 years ago
Felix Fontein 804d5eaf8e
AWS: _facts -> _info (part 3) (#57635)
* Rename ec2_ami_facts -> ec2_ami_info.

* Rename ec2_asg_facts -> ec2_asg_info.

* Rename ec2_customer_gateway_facts -> ec2_customer_gateway_info.

* Rename ec2_eip_facts -> ec2_eip_info.

* Rename ec2_elb_facts -> ec2_elb_info.

* Rename ec2_eni_facts -> ec2_eni_info.

* Rename ec2_group_facts -> ec2_group_info.

* Rename ec2_instance_facts -> ec2_instance_info.

* Rename ec2_lc_facts -> ec2_lc_info.

* Rename ec2_placement_group_facts -> ec2_placement_group_info.

* Rename ec2_snapshot_facts -> ec2_snapshot_info.

* Rename ec2_vol_facts -> ec2_vol_info.

* Update module defaults, add changelog and porting guide.

* Forgot one occurence of ec2_instance_facts.

* Update BOTMETA.

* Break too long line.
6 years ago
Felix Fontein fc4bbff6e1
AWS: _facts -> _info (part 2) (#57626)
* Rename cloudwatchlogs_log_group_facts -> cloudwatchlogs_log_group_info.

* Rename elasticache_facts -> elasticache_info.

* redshift_facts -> redshift_info.

* Rename route53_facts -> route53_info.

* Rename rds_instance_facts -> rds_instance_info.

* Rename rds_snapshot_facts -> rds_snapshot_info.

* Rename iam_mfa_device_facts -> iam_mfa_device_info.

* Rename iam_role_facts -> iam_role_info.

* Rename iam_server_certificate_facts -> iam_server_certificate_info.

* Rename elb_application_lb_facts -> elb_application_lb_info.

* Renaming elb_classic_lb_facts -> elb_classic_lb_info.

* elb_target_facts -> elb_target_info.

* Rename elb_target_group_facts -> elb_target_group_info.

* Update porting guide.

* Add changelog.

* Fix module defaults (both for this PR and #57613).

* Two fixes.
6 years ago
Felix Fontein 51229eb99c
AWS modules: _facts -> _info (#57613)
* Rename aws_acm_facts -> aws_acm_info.

* Rename aws_az_facts -> aws_az_info.

* Rename aws_caller_facts -> aws_caller_info.

* Rename aws_kms_facts -> aws_kms_info.

* Rename aws_region_facts -> aws_region_info.

* Rename aws_sgw_facts -> aws_sgw_info.

* Rename aws_waf_facts -> aws_waf_info.

* Adjust docs.

* Add changelog and update porting guide.
6 years ago
Felix Fontein 039eb892ba
Second batch for _facts -> _info rename (#57020)
* Second batch of _facts -> _info.

* Forgot one reference.
6 years ago
Felix Fontein ef2d70a806
Rename ali_instance_facts -> ali_instance_info (#57036)
* Rename ali_instance_facts -> ali_instance_info.

* Add changelog.
6 years ago
Zim Kalinowski 93a85b6c86 Additional rename fixes (#57527)
* adding symbolic link

* missing renames

* reverted version_added
6 years ago
Sandra McCann 152202ceb0 add info about hwaddr conversion formats (#57491) 6 years ago
pratikgadiya12 72297db686 Renames Digital Ocean cloud _facts modules to _info (#57315)
Fixes: #57276
6 years ago
smile37773 c6097a268c rename modules azure_rm_..._facts to azure_rm_..._info (#57395) 6 years ago
Sandra McCann 3136007032 update docsite breadcrumbs from sphinx_rtd_theme (#57316)
* improve breadcrumbs
* get edit on github working again
6 years ago
Sandra McCann 96693600f9 2.9 roadmap dates (#57420)
* add dates to 2.9 roadmap, remove alpha phase
6 years ago
Sviatoslav Sydorenko dfaa72297c Fix an RST link to the changelog config in docs 6 years ago
Abhijeet Kasurde ee8a607cca ipaddr: Handle network address in ipmath (#57149)
* Updated testcase, documentation

Fixes: #54457

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Felix Fontein 7b40b569b2
Rename memset_*_facts to memset_*_info (#57030)
* Rename memset_*_facts to memset_*_info

* Add changelog.
6 years ago
Abhijeet Kasurde 5162d21ea3 VMware: vSphere Automation SDK installation docs (#57280)
* VMware: adds instructions for installing vSphere Automation SDK to the dynamic inventory scenario
6 years ago
Ilya Reshetnikov bf0e846a39 Update playbooks_filters.rst (#57200)
* Update playbooks_filters.rst to show JSON in the "JSON Query Filter" example data structure
6 years ago
Thad Guidry 78b003858d Mention other ways to handle private key files (#57238)
Often when I am helping others learn Ansible, they are using nodes spun up on Amazon/Google/etc.  where private key files (pem) are needed.  Mentioning just a bit more on how to handle those private key files on the intro_getting_started page will help more folks get started faster.
I even reviewed the changes with my learning team and they all agreed this helped clarify immediately for them how to really get started with Ansible from a practical perspective.
6 years ago
Bill Nottingham c493593b4b Adjust assorted terminology and wording around product offerings. (#57242)
* Adjust assorted terminology and wording around product offerings.

* Update docs/docsite/rst/dev_guide/style_guide/trademarks.rst
* Update docs/docsite/rst/user_guide/modules_support.rst
* Update docs/docsite/rst/reference_appendices/tower.rst
6 years ago
Sviatoslav Sydorenko 49ec681a73 Fix ansible_async_dir in the migration doc 6 years ago
Felix Fontein c47e9d22b4
Rename one_image_facts -> one_image_info (#57035)
* Rename one_image_facts -> one_image_info.

* Add changelog.

* Forgot symlink.
6 years ago
Sviatoslav Sydorenko 5183f84016 📝 Mention the minumum cherry-picker version in doc (#57139) 6 years ago
Remon van de Kamp dea9644d21 Use correct variable for run_once regardless of batch example (#57077)
Changes example to `when: inventory_hostname == ansible_play_hosts_all[0]` to really run run_once regardless of serial.
6 years ago
Takashi Sugimura e17434c19f Correct repository name to install (#56991) 6 years ago
Felix Fontein 61b48778a7
Rename _facts -> _info (#57028) 6 years ago
Felix Fontein 7a0af34ba9
First batch _facts -> _info rename. (#56822) 6 years ago
Jonathan Bride db6407d6bf Correct typo in playbooks_intro.rst (#56919)
Typo in code block line: ansible-lint veryify-apache.yml should be
ansible-lint verify-apache.yml
6 years ago
Anatoly Kamchatnov 9a563f8947 Windows FAQ: fix reference (#56909) 6 years ago
Sam Doran 50b1a66649 Update instructions for running module directly (#56883)
The internals of AnsiballZ changed silghtly
6 years ago
Sandra McCann f9b43a0f68 Copyright fix for 2018 (#56860)
* update copyright in footer

* remove extraneous copyright from cli commands
6 years ago
Sandra McCann 3129fc0b17 Update RHEL repo for Ansible 2.8 (#56859) 6 years ago
Abhijeet Kasurde 26d38dd642 VMware: Add folder param in vmware_datastore_cluster
* Make datacenter as alias and optional
* Add folder param to place datastore cluster in specific folder
* Updated examples
* Updated tests

Fixes: #48010

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Abhijeet Kasurde 459776eb82
VMware: Add folder option for vmware_dvswitch (#56707)
* Added folder param
* Mark datacenter as optional parameter
* Updated docs
* Updated tests

Fixes: #54986

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
CsilLAB 6900378766 [WIP] Tip to see the content of a single encrypted var (#37887)
* Tip to see the content of a single var encrypted with Ansible Vault
6 years ago
Felix Fontein 53ec9c8019 Clarify that GPLv3+ module_utils need core team approval (#56740)
* Clarify that GPLv3+ module_utils need core team approval.

* Update docs/docsite/rst/dev_guide/shared_snippets/licensing.txt

Co-Authored-By: Sam Doran <sdoran@redhat.com>

* More 'module_util' -> 'file in module_utils'.
6 years ago
Sandra McCann 388f5d0b2b Add links to quickstart guides (#56722)
* shell of quickstart

* link to existing quickstart guides
6 years ago
Seth Hochberg 66bfa27685 Replace deprecated ansible-container references (#56427)
Link to ansible-bender instead of the deprecated ansible-container.

Co-Authored-By: Felix Fontein <felix@fontein.de>
6 years ago
Felix Fontein abca3f1956 Clarify documentation on _info vs. _facts modules (#56611)
* Clarify documentation on _info vs. _facts modules.

* Expand with examples for facts and non-facts.
6 years ago
Kevin Breit 4742897635 Move backport guide to 2.8 (#56578)
The backport guide should refer to Ansible 2.8 instead of 2.7 as the target branch, since 2.8 is out.
6 years ago
s-hamann 730456b402 Add seed parameter to random_mac filter (#51841) 6 years ago
Alicia Cozine f88b660717
adds 2.9 roadmap, reversed local TOC order (#56371) 6 years ago
Alicia Cozine 118cf3ece6
Cloud dev docs to rst (#56485)
* Moves developer docs for AWS, ovirt, and openstack modules out of lib/ansible/, integrates them with dev_guide, with abadger's fix to make python snippets pass rstcheck
6 years ago
Sandra McCann 635931051b [Doc-Release-2.8] fixed broken module links in 2.8 porting guide (#56494)
* fixed broken module links
6 years ago
Sandra McCann 4bf134756b changed version to 2.8 (#56487) 6 years ago
Sandra McCann f097dca60d update release table for 2.8 (#56486) 6 years ago
thomas.boussekey d55823b013 Update of Ansible 2.8 roadmap (add RC2 & RC3) (#56436)
##### SUMMARY

* Remove **if needed** for RC2 & RC3
* Set correct release date for RC3
6 years ago
Matt Clay f9b56a5b56 Add sanity test to check for unwanted files. 6 years ago
Pilou b3ab83bc70 [doc] fix example: always trigger the handler (#56384)
by default, debug task result isn't changed - add 'changed_when: yes' to trigger handler
6 years ago
Sandra McCann 88be323bcd Fix 2.8 changlog url and reverse order porting guides TOC (#56373)
* fixed url for 2.8 changelog, fixed spelling issues, reversed TOC order
6 years ago
Felix Fontein 6948e04276
Add myself to committer list. (#56363) 6 years ago
Isaac 85fa65e5f0 docs: Update scopes value example (#56362)
Existing example in GCE guide returns "invalid scope" error; value needs "https://" prefix
6 years ago
Sam Doran c1ebc8d9c2 Update default roles_path documentation (#56320) 6 years ago
Alicia Cozine 3c8d8b1509 should have gone into 52373 (#56306) 6 years ago
Reginald Davis dd0b0ae47b Lack of "--update" flag in older Ubuntu distros (#56283)
When installing Ansible on older Ubuntu distributions be aware of the lack of ``-u`` or ``--update`` flag.

+label: docsite_pr
6 years ago
Dag Wieers eac7f1fb58 dev_guide: Various small updates (#53273)
* Document the clarifications that I usually remark when doing reviews
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst

Co-Authored-By: dagwieers <dag@wieers.com>
6 years ago
stroebitzer dae5564e2b Fix var naming (#55796)
* Fix var naming in GCE guide
6 years ago
Brian Coca 8ff27c4e0c more info on how vaults work (#56183)
also add warning about what it covers.
6 years ago
Jim Rollenhagen 86e98c5213 Note that by default the regex test is identical to match, but can do much more (#50205)
* Note that the regex test behaves like 'match', with default settings
6 years ago
Matthew Davis 7d5ada7161 add doc example of multiline failed_when with OR (#56007)
* add doc example of multiline failed_when with OR

* add variety to multiple OR failed_when doc example
6 years ago
Toshio Kuratomi edafa71f42 Developer documentation update involving module invocation (#55747)
* Update docs for the 2.7 change to AnsiballZ which invokes modules with one
  less Python interpreter

* Add a section on how module results are returned and on trust between modules, action plugins, and the executor.

* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst

Co-Authored-By: abadger <a.badger@gmail.com>
6 years ago
Mark Zhitomirski b14f477bee docsite: correct path, list requirements for testing module docs, etc. (#52008)
* dev_guide: correct path, list requirements, etc.; module HTML docs are in '_build/html/module' subdir
6 years ago
Brian Coca 5d4c73e197 unite poll defaults (#55470)
* unite poll defaults and update docs
6 years ago
Klaas Demter 76dba7aa4f Add faq note about ssh ServerAliveInterval (#55568) 6 years ago
Alicia Cozine 8542459b95
Docs: edits & expands module_utils & search path info in dev guide (#55931)
* Update docs/docsite/rst/dev_guide/developing_module_utilities.rst
6 years ago
Alicia Cozine 5439eb8bd8
Clarifies how Ansible processes multiple `failed_when` conditions (#55941)
Docs: Clarify that multiple failed_when conditions join with AND not OR to counter third-party pages online incorrectly stating that it uses `OR`. ([example](https://groups.google.com/d/msg/ansible-project/cIaQTmY3ZLE/c5w8rlmdHWIJ)).
6 years ago
Sandra McCann 47a440774f Speed up the Sphinx documentation build (#55593)
* speeds up the docs build by changing the navigation collapse setting
6 years ago
stroebitzer 943f7334c5 Fix var naming (#55795)
Make vars match tasks in Google Compute guide.
6 years ago
Alicia Cozine 9d5b5d7ddd
correct description of modules vs plugins (#55784) 6 years ago
Alicia Cozine bb5059f2c7
Add security group info and example to AWS guide (#55783)
* expand documentation on how to use lookup plugin aws_service_ip_ranges with ec2_group module

* fix rst syntax error
6 years ago
tacatac dbc64ae64c Clarify poll value behaviour in playbook async doc (#54929)
Clarify the documentation for `async` and `poll`; describe the behavior when `poll` = 0 and when it does not.

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

* Update the default poll value in async doc

Co-Authored-By: tacatac <taca@kadisius.eu>
6 years ago
hiyokotaisa 7b86208fcd Add Microsoft Document URL for WinRM Memory Hotfix (#55680)
* Add microsoft document for memory hotfix

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

Co-Authored-By: hiyokotaisa <thel.vadam2485@gmail.com>
6 years ago
Lars Kellogg-Stedman a5cb47d697 Improve consistency of loop documentation (#55674)
There were a series of sections with subheadings in the loop
documentation, but the most recent additions did not follow the same
pattern.
6 years ago
tacatac 79198cad7a Clarify the Vault guide and add Vault ID examples (#55111)
updates docs/docsite/rst/user_guide/vault.rst
* Add reference to single variable vault encryption
* rST ref to jump to the section
* Clarify the two targets of vault encryption, with notes about advantages and drawbacks of each
* Add the default form for --vault-id
* Add Vault ID examples for normal operations

Co-Authored-By: tacatac <taca@kadisius.eu>
6 years ago
Matt Martz db6cc60352
Migrate command line parsing to argparse (#50610)
* Start of migration to argparse

* various fixes and improvements

* Linting fixes

* Test fixes

* Fix vault_password_files

* Add PrependAction for argparse

* A bunch of additional tweak/fixes

* Fix ansible-config tests

* Fix man page generation

* linting fix

* More adhoc pattern fixes

* Add changelog fragment

* Add support for argcomplete

* Enable argcomplete global completion

* Rename PrependAction to PrependListAction to better describe what it does

* Add documentation for installing and configuring argcomplete

* Address rebase issues

* Fix display encoding for vault

* Fix line length

* Address rebase issues

* Handle rebase issues

* Use mutually exclusive group instead of handling manually

* Fix rebase issues

* Address rebase issue

* Update version added for argcomplete support

* -e must be given a value

* ci_complete
6 years ago
Xaroth a9f24e097f Add ansible_parent_role_names magic variable (#46687)
-Add: Test cases for ansible_parent_role_names and ansible_parent_role_paths
-Add: ansible_parent_role_names/paths variables for when a role is being included by another role.
6 years ago
Sandra McCann cca365061c
add how to create HttpApi plugins for network modules (#54340)
* initial port over from gdoc

* crosslink httpapi pages

* Add some examples?

* Add quick example of using Connection

* Fix indentation of python code blocks

* moved to a full developer guide for networks

* Try to clarify some examples

* Fix typos

How did I even do that?
6 years ago
spellis 6ea3eca8ff Update windows_setup.rst (#55535)
Wrong protocol and port in command.

+label: docsite_pr
6 years ago
Gregor Dschung 158452661a Correct link to Thomas' GitHub account (#55587)
Thomas renamed his account from tstringer to trstringer
6 years ago
Faisal Shaikh 0330ea616e Removed misleading padding from highlighted results of a search query (#55464) 6 years ago
Alex Stephen e298de0986 GCP deprecations (#53355)
* gcdns_record deprecation

* gcdns_zone deprecation

* gcp_forwarding_rule deprecation

* gcp_url_map deprecation

* gcspanner deprecation

* gcp_healthcheck deprecation

* porting guide

* test failures

* forgot to rename

* deprecating

* porting guide changes

* unit test fixes

* changing ignores
6 years ago
Jordan Borean 8542f16fa9
SCP filename validation docs (#55399)
* SCP filename validation docs

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* Update docs/docsite/rst/reference_appendices/faq.rst

Co-Authored-By: jborean93 <jborean93@gmail.com>

* edits to scp FAQ entry

* zeut alors I have missed one

* incorporate jborean feedback

* adds link to bug report
6 years ago
Alicia Cozine d7f6493084 adds better links to tips and pitfalls page (#55458) 6 years ago
Matt Martz 9f83139dcb
Don't register tests as filters (#55332)
* Don't register tests as filters. Fixes #55319

* Remove tests for deprecated functionality

* Remove no-tests-as-filters sanity tests

* Remove docs too

* Revert "Remove docs too"

This reverts commit 7daf457a74.

* Make no-tests-as-filters doc an orphan
6 years ago
Michelle Perz 960df24272 include windows server 2019 in supported hosts (#55367)
<!--- Your description here -->

+label: docsite_pr
6 years ago
James McClune da1f86a40f docs/docsite: minor fixes in docs/docsite/README.md (#55356)
Added inline markup to important references. Fixed minor spelling error.

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
6 years ago
Kevin Breit 521e62aa38 Update set_module_args in unit test docs (#55244)
* Update docs/docsite/rst/dev_guide/testing_units_modules.rst
`set_unit_args()` should be imported and used in the unit test documentation. 

Co-Authored-By: kbreit <kevin.breit@kevinbreit.net>
6 years ago
Alex Stephen 91a664a93e Gce migration docs (#51838)
* migration docs for gce, with example playbook

* Update docs/docsite/rst/scenario_guides/guide_gce.rst

Co-Authored-By: rambleraptor <alexstephen@google.com>
6 years ago
Kevin Breit a005dcfbbd Add example for full path on unit tests (#55243)
Docs: adds an example when a full path is needed for unit tests, with module_utils, etc.
6 years ago
Jiri Tyr 7efb952825 Adding missing comma (#55254) 6 years ago
Abhijeet Kasurde 3003954415 Update unit testing docs (#55272)
* Updated links
* Updated indentation
* Fixed typos

Fixes: #55242

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
6 years ago
Toshio Kuratomi b4f41fd9e2
Document replacements (#55226)
* Document replacements

Document suggested replacement moduels for kubernetes, oc, and ec2_ami_find
modules in the porting guide

* remember the _module suffix
6 years ago
Toshio Kuratomi a1c8fc37e8 Remove modules which have ended their deprecation cycle
* Remove code but leave the metadata so that they can be listed as
  removed in documentation.
* Remove removed modules from validate-modules ignore
* Remove unittests for the removed nodules
* Remove links to removed modules and add list of removed moduels to the
  2.9 porting guide
6 years ago
Toshio Kuratomi e5a31e81b6 Add a script to generate a new porting guide
* porting-guide.py is allowed to be Python-3.6+ as it will only be run
  by release engineers
6 years ago