* 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.
(cherry picked from commit e9f8a34dce)
Co-authored-by: Matt Clay <matt@mystile.com>
* 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 .
(cherry picked from commit 054285c34c)
* Add changelog.
* docs: update to latest 3 versions (#64109)
(cherry picked from commit 409545825f)
* update too old version to 2.4 (#64167)
(cherry picked from commit c63ef6d911)
* update backport instructions to use stable-2.9 (#64168)
(cherry picked from commit f264e9cfca)
* [Doc-Release-2.9] update release and maintenance page for 2.9 (#64166)
* only 2.4 and earlier used the old changelog system
(cherry picked from commit 3f808d9ed6)
* clarify no subfolders and md only for collections /docs folder (#63808)
(cherry picked from commit 6a2902c8d5)
* Fixed example error in windows_winrm user guide (#63922)
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.
(cherry picked from commit c562e17659)
* Fix doc errors in AWS modules (#63851)
* Fix register/debug in aws_batch_compute_environment
* Fix aws_batch_job_queue doc errors
* Fix module naming: `batch_job_queue` > `aws_batch_job_queue`
* Fix missing register
* Update debug task to use modern YAML format
* Fix missing register + debug for lambda_policy
* Fix YAML syntax for elb_application_lb_info module
(cherry picked from commit e4f16368ed)
* Update documentation for package module (#63909)
It is not clear from the documentation that list can be used
(cherry picked from commit 7f2c367d78)
* [ec2_launch_template] Update description of state param (#63147)
Currently, it is not possible to delete specific versions of an ec2 launch template. The module docs incorrectly suggest that there is a `version` param to the module that can be used to do that. This patch aims to correct that error.
(cherry picked from commit 7ea7260753)
* template: Add a space in example block (#63930)
(cherry picked from commit f279715c29)
* revisions to docsite README (#63957)
(cherry picked from commit 5c962ef859)
* combine galaxy.com install roles details (#63486)
(cherry picked from commit ee8a088205)
* Correct a typo (#64020)
(cherry picked from commit 18f4f0549f)
* Update password.py (#63965)
Update the examples of the password lookup plugin to show how multiple options are joined together.
(cherry picked from commit 92daec5d0b)
* Fix indentation of example (#63789)
Remove no_log since module_defaults aren't displayed like set_fact was
(cherry picked from commit 1e52782d6b)
* add newline to render table correctly (#63769)
(cherry picked from commit 1aee11c860)
* clarified some points on environment keyword usage (#64065)
(cherry picked from commit 885ee62b53)
* Replaced old DSC links that given 404 (#63556)
Replace DSC links that returned "not found" with updated, working links.
(cherry picked from commit f638f29e44)
* Fix example in pip module documentation (#63462)
(cherry picked from commit d8b9f9fb4f)
* 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>
(cherry picked from commit 8a77f17dea)
* Typo usersername should be username (#63671)
(cherry picked from commit 2ef4ac1404)
* Update description for firstmatch option (#62896)
Fixes issue https://github.com/ansible/ansible/issues/62862. The edit makes the description for the `firstmatch` option clearer. The `firstmatch` option was introduced by PR https://github.com/ansible/ansible/pull/33825
(cherry picked from commit aeb0dde7cc)
* Update win_regmerge.py (#63633)
s/windows/Windows/ in title
(cherry picked from commit 4326165be5)
* Example incorrect: server_url is required argument (#63670)
The example "Delete GitLab Group" does not work - requires server_url parameter. This likely applies to all Examples, so this change proposes at least putting in the required parameter in the examples. In future we can remove the soon-to-be deprecated server_url parameter.
(cherry picked from commit b02467961a)
* doc: win_user: fix typo in the description of the groups modifyer (#63743)
(cherry picked from commit 6046386dba)
* Update AWS dev guide to recommend module_defaults and point to CI policy repo (#63589)
(cherry picked from commit 9cda5819b9)
* Add example for port range to win_firewall_rule_module (#63269)
(cherry picked from commit 2e81b813dd)
* added a link to install instruction of OpenSSH (#63548)
(cherry picked from commit cfe2beae46)
* Update sros_config.py (#63132)
(cherry picked from commit b3deab4319)
* add note about collection links (#63346)
(cherry picked from commit bdd0fac606)
* Nosh module documentation update (#63303)
* detail the 'status' dictionary
* did not add individual descriptions, see nosh documentation for those
* sample: False not being rendered unless 'False' is quoted
(cherry picked from commit df283788e5)
* 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
(cherry picked from commit ae265bc546)
* Enter should be Italics as it is a menu option (#63441)
(cherry picked from commit 7a8c909876)
* ini_file: remove incorrect documentation (#63394)
(cherry picked from commit ab249a469e)
* Changed with_items to loop in VMware example (#63022)
(cherry picked from commit 876a2d57be)
* ovirt update fetch_nested param doc (#63191)
(cherry picked from commit 0beab6bf69)
* Update 'delete' parameter description in synchronize module (#63450)
Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit da46800f1b)
* Update unarchive.py - Further clarify extra_opts (#58102)
Update the description in the options to help assist with what the module is looking for in the extra_opts. #31873 alone is not enough since if you are not familiar with the option given in the example it may not be obvious that both elements are part of the same option instead of being two different options.
Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
(cherry picked from commit e967060b9f)
* ovirt_vm add warning about next run configuration (#63458)
(cherry picked from commit 16e49fdd44)
* Fix doc - porting_guide_2.8 value example (#63493)
(cherry picked from commit e0f67b58ce)
* Fix warnings for ufw examples (#63505)
(cherry picked from commit e4eea0510c)
* Update stat.py (#63289)
Reword awkward documentation language.
(cherry picked from commit b46299ff86)
* Update win_disk_facts.py example (#63266)
Fix incorrect index for second disk (should be `disks[1]` not `disks[0]`)
(cherry picked from commit ce1c8c24f7)
* Fix broken link (#63185)
(cherry picked from commit 021d095625)
* Typo on line 161 (#63133)
fix module name for azure_rm_manageddisk in one example
(cherry picked from commit 81a614684a)
* docs: add Centos and Ubuntu to examples for playbook conditionals (#63085)
Co-Authored-By: Sandra McCann <samccann@redhat.com>
(cherry picked from commit 19587b35da)
* Spot instance code error (#63246)
Adds 'instance_initiated_shutdown_behavior: terminate' to spot instance example for greater efficiency.
(cherry picked from commit 5ed163ce3f)
* Pass a JSON file to the Lambda's payload (#63261)
* Add an example of passing a JSON file to the Lambda's payload
Events passed to Lambda are commonly in JSON format, the change provides an example of using JSON file as an alternative to the inline YAML payload in the other examples.
(cherry picked from commit 1d5206f53e)
* Update ec2.py (#63260)
Change the explanation of spot_wait_timeout
(cherry picked from commit 719170e5c1)
* fix aruba_config examples (#63136)
(cherry picked from commit 6ff5968781)
* [ec2_launch_template] Update examples (#63152)
- Update tasks names for existing examples
- Add a new example showing how to delete a launch template
(cherry picked from commit 32980f214a)
* Fixing typo mistake in testbed with section. Deploy template from content library is supported from 67U3
(cherry picked from commit c6c13b5626)
* Typo fix in mssql_db (#63184)
Changed from 'then' to 'than'
(cherry picked from commit b5cc0872e7)
* VMware: Update maintenance notes on vmware_cfg_backup (#62853)
Maintenance mode seems only to be required for load or restet, not for save_configuration.
(cherry picked from commit e977e0af74)
* Misc typo in nxos_config documentation (#62629)
* Changed 'exit' to 'exist'
* Removed unnecessary word 'first'
(cherry picked from commit 0554b50eed)
* postgresql: add elements for list params to the module's documentation (#63186)
(cherry picked from commit 8a37a2440e)
* mysql: add elements for list params to the modules' documentation (#63187)
(cherry picked from commit 30c2d21f17)
* Add spaces around {{ indicators. (#63125)
The example looked a little less readable by not having spaces after `{{` and before `}}`. This commit should make the examples match [ansible-lint rule 206](https://github.com/ansible/ansible-lint/blob/master/lib/ansiblelint/rules/VariableHasSpacesRule.py)
(cherry picked from commit b7a9d99cef)
* fix typo in collection/plugins/readme (#63162)
(cherry picked from commit da1a945088)
* Docs: User guide overhaul, part 1 (#63056)
(cherry picked from commit 941a9b68fc)
* Concise file module example description (#62932)
A file won't be created by the example, the execution would fail unless the file already exists as specified by the module options
(cherry picked from commit 87a6f8397e)
* Added suffix note to process_name_exact parameter (#62849)
(cherry picked from commit 992b81e8fc)
* Fix broken link to powershell resources (#62845)
The previous link (https://docs.microsoft.com/en-us/powershell/dsc/builtinresource ) is a 404 . MS has a new link https://docs.microsoft.com/en-us/powershell/dsc/resources/resources with the same content
(cherry picked from commit cae4255a16)
* Update playbooks_environment.rst (#62800)
(cherry picked from commit cea8a222a3)
* Update win_dsc.py (#62863)
(cherry picked from commit 798c5a55fa)
* Adjust documentation for yum clean to use best practices (#62898)
The yum module docs suggested using `shell: yum clean all`, which gives an `ansible-lint` error. Plus, you should use the `command` module unless you need more advanced features than just passing in an arbitrary command. Fixes that problem by using the `command` module in the example instead.
(cherry picked from commit 1e6fd6f54d)
* This should never have been "support:network" (#63068)
(cherry picked from commit 7ae46329f2)
* Add docs on hiding sensitive data in loops (#63096)
(cherry picked from commit 0311897722)
* Doc updates to openssl_certificate and ecs_certificate (#63006)
* Update lib/ansible/modules/crypto/entrust/ecs_certificate.py
Co-Authored-By: Felix Fontein <felix@fontein.de>
(cherry picked from commit e55f46f302)
* Update intro_installation.rst (#62994)
(cherry picked from commit f2214951c5)
* Update xml.py (#63128)
Update example to remove escape characters in front of special characters as it is not needed to add explicitly anymore with latest ansible version
(cherry picked from commit 82a6f9d198)
* add more anchors to collections docs (#62827)
(cherry picked from commit 7e01de96d7)
* add anchors to support galaxy links (#62808)
(cherry picked from commit 1b3bf33bdf)
* doc: fix typos (#62852)
(cherry picked from commit b33ae14949)
* Add some documentation about using plugins in collections (#62465)
- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching
(cherry picked from commit d41050b28b)
* Remove Latin phrases from the docs (#62419)
* add styleguide about avoiding use of latin words
(cherry picked from commit e7436e278f)
* ovirt: Fixing typo in ovirt_disk examples (#62962)
(cherry picked from commit 50dc41cca2)
* 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.
(cherry picked from commit 7ecfa4a471)
* 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://.
(cherry picked from commit c8315bfd60)
* fix minor typos (#62950)
(cherry picked from commit ad580a71c4)
* 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.
(cherry picked from commit 0d79013f51)
* add ios/iosxr deprecated modules (#62908)
(cherry picked from commit 6bbd9c9eca)
* Update pip module docs (#62359)
* Clarifying pip module requirements in reference to #47361
* Further clarifying message with link to ansible_python_interpreter
(cherry picked from commit d3ec5ca80f)
* chore/doc-module: sts_assume_role.py (#62475)
Update `Example` section with with the correct module usage.
(cherry picked from commit a4a216640f)
* Improve dconf documentation to include conversion problems (#62316)
(cherry picked from commit 864928365e)
* Add examples for various inventory setups to the documentation (#62323)
* Updates docs/docsite/rst/user_guide/intro_inventory.rst, closes#12480.
* 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>
(cherry picked from commit 7047b66d34)
* added networking porting guide info (#61999)
* Update docs/docsite/rst/porting_guides/porting_guide_2.9.rst
Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
(cherry picked from commit 6d35f9026f)
* [docs] split collections into user and dev guide sections (#62363)
(cherry picked from commit 7badeb6df0)
* fixed options (#62605)
(cherry picked from commit 170b4e63ff)
* ec2_vpc_subnet: Rename resource_tags > tags (#62663)
Most of the AWS module documentation refers to `tags` and not
`resource_tags`. This patch updates the documentation to match
other AWS module documentation. 😉
Signed-off-by: Major Hayden <major@redhat.com>
(cherry picked from commit cced1a3cd1)
* [Docs] Document the resource module builder (#62222)
(cherry picked from commit b17581a307)
* Fix link syntax and a typo in dev collections doc (#62650)
(cherry picked from commit 2969614c2c)
* hcloud_volume: clarify volume size units (#62771)
(cherry picked from commit 190b8fcd1c)
* ovirt_host update force doc (#62491)
(cherry picked from commit 3b2b418aad)
* update example document for zabbix_action module (#62667)
(cherry picked from commit 3299f29f7c)
Avoid "no backward incompatible interface" term which uses a double
negation and replaces it with easier "backward compatible interface"
contruct.
(cherry picked from commit 179eb623d7)
* openssh_keypair: make sure public key has same permissions as private key (#61658)
* Make sure public key has same permissions as private key.
* Add changelog.
* Text, not binary.
(cherry picked from commit c19cea9b03)
* openssh_keypair file permissions/ownership: add porting guide entry (#62176)
* Add porting guide entry for 2.9.
(cherry picked from commit 0e72cbd451)
Add information and examples on how to use additional properties from a doc fragment
Add info about layering properties
(cherry picked from commit 9b348e690c)
(cherry picked from commit 5deb01c84d)
(cherry picked from commit 041c52d629)
* docs: Update apt_key.py, add requirements of gpg (#61552)
(cherry picked from commit 5d7d4a93c8)
* Proposals aren't really used much, delete reference from docs (#61800)
(cherry picked from commit 41055b5dc8)
* Update gitlab_hooks docs (#61837)
(cherry picked from commit 223dab99ea)
* Unify ios_logging and eos_logging documentation with accepted options (#61777)
(cherry picked from commit cc9adf7f1a)
* don't set default:None in documentation when there is no default (#61111), otherwise "None" will be rendered as a string on docsite
(cherry picked from commit 1aca1f86b6)
* Update mso_schema_template_deploy.py (#61849), correct module name in examples
(cherry picked from commit 394a05108d)
* Update hashi_vault.py documentation with kv V2 example (#61221)
(cherry picked from commit 70f501d5c8)
* moved most ansible edits out of theme.css
* remove unnecessary edit to theme.css
* replace with upstream minified theme.css for 0.4.3
(cherry picked from commit de826b437d)
* 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>
(cherry picked from commit 375eb9723a)
Felix Fontein