Mark Chappell
90898132e4
CloudRetry/AWSRetry : Disable catching of NotFound exceptions ( #67281 )
...
* CloudRetry/AWSRetry : Remove default catching of NotFound exceptions
* Add docs
* Changelog updates from review
* Update unit tests after removing 'NotFound' from default retries
5 years ago
Jordan Borean
ed863b377b
win_package: add missing porting guide entries ( #67374 )
5 years ago
tchernomax
53e043b5fe
combine filter: fine list handling (option b) ( #57894 )
5 years ago
Sandra McCann
a6bb3ae291
fix some broken links ( #67345 )
5 years ago
Bill Brubaker (wwbrubak)
561f8c1d60
Update macOS installation instructions ( #67058 )
...
On macOS Catalina ``pip install --user ansible`` results in warnings and errors. This updates the reference documents to reflect changes Catalina+ with a safe, easy install for Ansible, accessing pip as a module and installing ansible with --user.
Co-authored-by: Sam Doran <sdoran@redhat.com>
5 years ago
Roger D. Winans
888a059ee7
Can we simplify _How to test a PR_? ( #65383 )
...
Switch the instructions on testing PRs to use the `refs/pull/XXXX/head` refspec as described in [_Checking out pull requests locally_](https://help.github.com/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally#modifying-an-inactive-pull-request-locally ).
5 years ago
Piotr Stawarski
a0247d13d8
New magic var: `ansible_config_file` ( #66085 )
...
* Add `ansible_config_file` magic variable
* Add ansible_config_file to INTERNAL_VARS
* Add changelog fragment
* Update Special Variables docs
5 years ago
Jonas DOREL
29edcdcf5b
Add library in role directory structure ( #67030 )
...
* Add library directory to the list of directories in a role
5 years ago
Sriviswajth
070f946745
Update intro_patterns.rst ( #67151 )
...
Removed extra quotes from example.
5 years ago
Alex Humphreys
01a6e1c2c9
Mention role defaults file ( #67153 )
...
Add info on where role defaults are set; matches the entry for role variables.
5 years ago
Sandra McCann
7ef7c1b5d7
add note on write access to socket_path ( #67060 )
...
* Change socket_path error messages to not directly refer to socket_path
* Apply suggestions from code review
Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
5 years ago
Mario Lenz
808bf02588
Remove options from some vmware modules that are not used in the code ( #67282 )
5 years ago
Nilashish Chakraborty
88f0c85228
Remove deprecated attributes from nxos_igmp_interface ( #67186 )
...
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
5 years ago
Wojciech Sciesinski
49e7f9afe2
Link the testing documentation to the module documenting page ( #67248 )
5 years ago
JP Mens
585e79942c
Slash missing from /etc/ ( #67220 )
5 years ago
Sandra McCann
4dd2513371
add info on creating doc fragments in a collection ( #67171 )
...
* add info on creating doc fragments in a collection
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
Felix Fontein
f725dce936
Clean up FILE_COMMON_ARGUMENTS ( #66389 )
...
* Clean up FILE_COMMON_ARGUMENTS.
* postgresql_pg_hba doesn't declare the backup option.
* uri doesn't declare the remote_src option.
* Add documentation.
* maven_artifact seems to use directory_mode, which it doesn't declare.
* Update changelogs/fragments/66389-file-common-arguments.yml
Update docs/docsite/rst/porting_guides/porting_guide_2.10.rst
ci_complete
Co-Authored-By: Jill R <4121322+jillr@users.noreply.github.com>
5 years ago
Mitsuru Nakakawaji
c55ba658c6
add note for Azure Availbility Zone ( #66200 )
...
* add note for Azure Availbility Zone
* Change title
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
* Update docs/docsite/rst/scenario_guides/guide_azure.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
5 years ago
Jordan Borean
12e3adb23a
win_domain_controller - add a deprecation warning for the log_path option ( #67108 )
5 years ago
Jordan Borean
78470c43c2
Removed deprecated items in Windows modules ( #67105 )
5 years ago
Felix Fontein
23b2bb4f4d
docker_container: change behavior for one-port container ranges to be same as docker CLI ( #66382 )
...
* Adjust docker_container behavior for one-port container ranges to be similar to docker CLI.
* Add changelog.
* Add documented examples for ports:.
5 years ago
Ilias Trichopoulos
d6f2b4e788
Fix indentation ( #66991 )
5 years ago
Sander
87a5e433ef
update guide_azure.rst ( #66940 )
...
changed example for ping linux machines. Looks liked it was wrongly copy paste.
5 years ago
Simon Dodsley
b1a8bded3f
Remove deprecated parameter for 2.10 in purefb_fs ( #67026 )
5 years ago
Mark Chappell
919a9e33e8
Minor AWS argument checks (required_if / mutually_exclusive) fixups ( #66966 )
...
* aws_netapp_cvs_snapshots - minor required_if fixup (state must be set if state=present)
* ec2 - fix typo in mutually_exclusive definition
* rds_instance: fix typo in mutually_exclusive restore_to_time should be restore_time - currently throws a boto error
5 years ago
Mark Chappell
5d4d9d40af
ansible-test - Add 'get' to the list of bad choices for state ( #66921 )
...
* ansible-test - Add 'get' to the list of bad choices for state
* Changelog fragment
5 years ago
Sam Doran
c8568a5c94
Add documentation about vars used in roles at the play level ( #66907 )
5 years ago
Toshio Kuratomi
4273e84962
Upstream jinja has decided not to rename from jinja2. ( #66880 )
...
So we're going to keep our intersphinx labels as jinja2 to match what
upstream is doing
5 years ago
Abhijeet Kasurde
2728c2476e
docs: Fixed "Edit on GitHub" link for plugin, cli ( #66745 )
...
Fixed sphinx theme to navigate "Edit on Github" link to locate correct
plugin, cli source in GitHub repo.
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Felix Fontein
5fdc9a61f0
docker_container: pass volumes only for anonymous volumes ( #66600 )
...
* Simplify code.
* Only pass anonymous volumes.
* Add changelog and update porting guide.
* Add integration tests.
5 years ago
Dusan Matejka
57805b7def
zabbix_proxy interface option documentation and argspec fixes ( #66837 )
...
* zabbix_proxy interface option documentation and argspec fixes
* Update changelogs/fragments/66837-zabbix-proxy-interface.yml
Co-Authored-By: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
5 years ago
Mark Chappell
1156962cde
Forbid `state=(list|info)` in modules via ansible-test sanity check
...
PR #66898
This change introduces a new sanity check with code
`parameter-state-invalid-choice` in the `ansible-test sanity`
validator. It enforces modules not to support `list` or `info`
as their `state`.
Co-Authored-By: Sviatoslav Sydorenko <webknjaz@redhat.com>
Co-Authored-By: Felix Fontein <felix@fontein.de>
5 years ago
Eitan Adler
86663abf37
all: fix all the the duplicate words ( #66784 )
5 years ago
Mark Chappell
35652ca788
Add tests to make sure that the documented 'elements' matches that defined in argument_spec ( #66385 )
...
* Add tests to make sure that the documented 'elements' matches that defined in argument_spec
* Mass-add test/sanity/ignore.txt
5 years ago
Toshio Kuratomi
abc8b0ae73
This was changed to python 2.7 but should have remained python 2.6 ( #66836 )
...
* Modules are still python-2.6+ unless there's a compelling reason not
to be.
5 years ago
Mark Chappell
5ff899662d
Add sanity test to require elements entry when argument type=list ( #66386 )
...
* Require elements entry for lists
* Bulk add initial test/sanity/ignore.txt
5 years ago
Walter Sosa
2dc9841806
doc: Fix tiny typo in example: change --> changed ( #66835 )
...
##### SUMMARY
Fixed another tiny typo: change --> changed
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
5 years ago
Martin Krizek
4ca0c7f116
Fix case sensitivity for lookup() ( #66521 )
...
This brings consistency to lookup(), with_ and ansible-doc.
Fixes #66464
* Add a porting guide entry
5 years ago
Sandra McCann
68ab8c23be
Network prompts ( #66584 )
...
* add network prompt examples and module examples
* Update docs/docsite/rst/network/user_guide/network_working_with_command_output.rst
Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
5 years ago
Toshio Kuratomi
14cc63dc0f
Switch intersphinx label from jinja2 to jinja ( #66703 )
...
* Switch intersphinx label from jinja2 to jinja
Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
5 years ago
Jill R
ac881b0026
Add section to aws devel guidelines about module_defaults ( #66699 )
5 years ago
Abhijeet Kasurde
fc6476bd72
VMware: Handle multiple tags with different category ( #66465 )
...
vmware_tag_info used to return dict of tag information which caused
data loss when there are multiple tags with same name and different category ids.
This fix will add additional fact "tag_info" which will deprecated existing fact
"tag_facts".
The "tag_info" is a list which handles multiple tags with same name.
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Toshio Kuratomi
0da13469d3
Add a script to update the intersphinx inventory ( #66646 )
...
* Add a script to update the intersphinx inventory files
* We're about to add intersphinx inventories for separate ansible docs
so we need an easy way to update them. Also, we should be updating
these cache files for other upstreams occassionally as well. With a
script, we can add updating them to a release process.
* Now that we don't know what the version of the cache is, change the
filenames to not contain versions.
* Update the intersphinx cache files with the latest upstream versions
Results of running:
hacking/build-ansible.py update-intersphinx-cache -o docs/docsite -c docs/docsite/rst/conf.py
* Add a comment to the configuration file which says how to structure the intersphinx mapping and why.
* Update docs/docsite/rst/conf.py
Co-Authored-By: Sandra McCann <samccann@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
5 years ago
Alicia Cozine
cb8ce7159d
Docs: clarify that roles do not inherit collections set in a playbook ( #66667 )
...
Co-authored-by: Matt Davis <nitzmahone@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
5 years ago
Alicia Cozine
0b503f6057
Docs: User Guide overhaul, part 3 ( #66371 )
5 years ago
Sam Doran
20eb1dca99
Update Galaxy docs to use "token" rather than "API key" ( #66644 )
...
We have called an API token many things. I changed the command line argument to
"--token", so now I'm unifying the documentation. I looked at both Galaxy and
Automation Hub and Galaxy is the only place that still uses the term "API Key",
which it could be argued should change.
5 years ago
Logan Mzz
986c9cf6a1
Docs: Fix collection adjacent folder tree ( #66490 )
...
##### SUMMARY
Previously folder tree example for collection adjacent to the current playbook were displaying a subfolder below the playbook instead of being a sibling.
5 years ago
Marko Kohtala
c423b1f213
dev_guide: Correct path to ansible-test requirements files ( #66626 )
...
The requirements path was old due to file relocation in
commit d651bda123
.
5 years ago
Walter Sosa
875ac4b7a5
Fix a tiny typo ( #66589 )
...
Fixes a very small typo: as --> a in playbook_debuggers.rst
5 years ago
Sandra McCann
599cc0bdfa
restructure headings and copy-edit shell completion ( #66479 )
...
* restructure headings and fix shell completion, apply suggestions from code review
Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
5 years ago
hiyokotaisa
3bcb664497
Fixes #65590 add pywinrm version explanation ( #65591 )
...
* add pywinrm version explanation
* Update windows_winrm.rst
Changed pywinrm explanation to note style
* Add period
Co-authored-by: Jordan Borean <jborean93@gmail.com>
5 years ago
Jordan Borean
6f04f87a13
Deprecate Windows 2008, and 2008 R2 ( #66257 )
...
* Deprecate Windows 2008, and 2008 R2
* Remove shippable nodes
* Update windows_faq.rst
Be less specific about 2008/R2 timeframes
* Update setup.ps1
tweak warning text
Co-authored-by: Matt Davis <nitzmahone@users.noreply.github.com>
5 years ago
Sandra McCann
4fedc10035
added guidelines for seo; ( #66431 )
5 years ago
Xavier PV
9dd548ebb7
Update developing_python_3.rst ( #66249 )
...
##### SUMMARY
fix link § redirection
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
5 years ago
林博仁(Buo-ren Lin)
011e0176c2
Clarify the advantage include* statement brought regarding looping ( #66022 )
...
Signed-off-by: 林博仁(Buo-ren, Lin) <Buo.Ren.Lin@gmail.com>
5 years ago
Bill Dodd
5f966ef664
Update deprecation version and porting guide for resource_id option ( #66060 )
...
* update deprecation version and porting guide for resource_id option
* add changelog fragment
5 years ago
Sandra McCann
1a0724fdd4
Trim down to one Ansible search option ( #66284 )
...
* move swiftype search to upper left of docsite, fix spacing and length issues for search icon and searchbox
5 years ago
Sandra McCann
9922014441
add details on network gather facts improvements ( #66220 )
...
* add details on network gather facts improvements, implement feedback
5 years ago
Sandra McCann
2ad6055efd
Document network resource modules ( #66226 )
...
* add network resource module details to docs
(cherry picked from commit 3e35d2d63ce17fb694e645785ad855f01420f7d8)
* network resource module page, with example output
5 years ago
Sandra McCann
136b3be722
added unit test details for resource modules ( #65891 )
...
* added unit test details for resource modules
5 years ago
Jordan Borean
595ab62ab8
Ansible.Basic - Added deprecated_aliases ( #66323 )
5 years ago
kaorihinata
3ca4580cb4
Allow no_log=False to silence the no_log warnings for module parameters ( #64733 )
...
As AnsibleModule._log_invocation is currently implemented, any parameter
with a name that matches PASSWORD_MATCH triggers the no_log warning as a
precaution against parameters that may contain sensitive data, but have not
been marked as sensitive by the module author.
This patch would allow module authors to explicitly mark the aforementioned
parameters as not sensitive thereby bypassing an erroneous warning message,
while still catching parameters which have not been marked at all by the
author.
Adds tests for various no_log states including True, False, and None (as
extracted by AnsibleModule._log_invocation) when applied to an argument with
a name that matches PASSWORD_MATCH.
Fixes : #49465 #64656
5 years ago
Sandra McCann
0ca79a4234
Clarify how to use the Galaxy token ( #65961 )
...
* DOCS: clarify how to use the Galaxy token, with info for installs and api-key
5 years ago
Abhijeet Kasurde
469f104ec2
loop: simplify dict2items example in docs ( #66235 )
...
* Added a simple example to explain "dict2items" filters for better understading.
Fixes : #65505
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Anthony Bourguignon
d3e9ef3c35
add a path_join filter which joins path components ( #62713 )
5 years ago
Sandra McCann
80dff8743a
fixed some broken links ( #66182 )
5 years ago
Lars Kellogg-Stedman
f85d9d7028
Correct rst syntax in playbooks_filters.rst ( #66198 )
...
The `regex_replace` documentation included an example that was meant
to be preformatted text but due to an indentation error was rendering
incorrectly.
5 years ago
Mark Chappell
458268f4cb
AWS Guidelines: Make 'security_token' optional so that they can be run outside of CI ( #66107 )
5 years ago
Pilou
7ee3103a86
clc_aa_policy: deprecate unused 'wait' parameter ( #64367 )
5 years ago
Ganesh Nalawade
1cfab26fab
Fix netconf plugin related to collections ( #65718 )
...
* Fix netconf plugin related to collections
Fixes #65655 (partly)
* Make netconf plugins configurable so that the
information of ncclient device handler
for give platform resides in the platform
specific netconf plugin.
* If the device handler value in ncclient is
different from the ansible_network_os value
the right value of `ncclient_device_handler`
should be set in the plugin documentation.
* Fix review comments
* Fix CI issue
* Fix review comment
5 years ago
Bill Dodd
973e36c6b6
Fix version param in deprecate() call and update porting guide ( #65894 )
...
* fix version= param in deprecate() call and update porting guide
* add changelog fragment
5 years ago
Sandra McCann
80f5503ed0
Use requirements.txt to install prereqs for docs build ( #65709 )
...
* Use requirements.txt to install prereqs for docs build
* implement feedback
5 years ago
Wojciech Sciesinski
aacc2d1a18
Update indentation used in the code examples, unify empty lines ( #65874 )
5 years ago
Alicia Cozine
40fb46f1e8
fixes import paths for ansible unit testing ( #65775 )
...
* fixes import paths for ansible unit testing
* Update docs/docsite/rst/dev_guide/testing_units_modules.rst
Co-Authored-By: Sandra McCann <samccann@redhat.com>
5 years ago
Evgeni Golov
057e137998
clarify `returned` value of `RETURN` nlock ( #65724 )
5 years ago
yiskylee
1f0b5b09cd
Explanation for "check_mode: no" is confusing ( #65777 )
...
When an ansible module, e.g., command, does not support check mode, you can use "check_mode: no" in that task to execute the task in normal mode, even when "--check" flag is used. The current document basically says, use "check_mode: no" to run in check mode, which is confusing and inaccurate.
5 years ago
Steve Leonard
af1c788ba7
Fix list formatting in Getting Started docs page ( #65713 )
5 years ago
Mossroy
c3c1708dea
Fix variable name in an example ( #65760 )
...
Makes the variable name consistent between the example code (`myname`) and the text below (mentioning a variable called `name`) in the docs.
5 years ago
Sandra McCann
9c30325704
fixed some link nits ( #65772 )
5 years ago
Alicia Cozine
860cacc54f
Docs: User guide overhaul, part 2 ( #65474 )
5 years ago
anshulbehl
b349ec8fcf
Adding network plugin changes for netconf and network_cli ( #65708 )
...
* Adding network plugin changes for netconf and network_cli
5 years ago
Sandra McCann
5eceebcaf3
Clarify how to install roles and collections from same requirements file ( #65707 )
5 years ago
Chris Budzilowicz
5ebce4672b
VMware: add note to vmware_guest faq ( #65569 )
...
* add note to vmware_guest faq about the vmware API being read-only unless you're a paid subscriber
5 years ago
Wojciech Sciesinski
95aef88a45
Update indentation used in the code examples, unify empty lines ( #65346 )
5 years ago
lotaris-xx
c185c46501
Update guide_azure.rst ( #65519 )
...
Adds subscription_id to the list of user/password credentials.
5 years ago
Evgeni Golov
3af1732bd8
fix rendering of GOOD/BAD code for regex_replace examples ( #65654 )
...
adds double colon (::) so the examples render as code
5 years ago
Jasper Lievisse Adriaanse
53cd0bdd29
docs: Prefer python3 on OpenBSD ( #65447 )
5 years ago
Mark Chappell
d8943d495e
AWS NLB: Deprecate current default behaviour of 'absent' ( #65468 )
...
* Deprecate elb_network_lb default of *delete*.
* Add changelog fragment
* Porting guide entry
5 years ago
Jordan Borean
fcdebe41e9
win_find - Refactor for better performance and alignment to find ( #65536 )
...
* win_find - refactor to make more performance and use newer style
* win_find - refactor for performance improvements and alignment to find
* More path alignment to find
* Fix yamllint error
5 years ago
Felix Fontein
4be8b2134f
Sanity checks: make sure that `required` in argument spec coincides with documentation ( #65437 )
...
* Add sanity test for required parameters, update ignore.txt, and add changelog.
5 years ago
Sandra McCann
41472ee387
Describe different ways to set connection timeout options ( #65126 )
...
* add timeout option examples, link to new section, implement feedback
5 years ago
Sam Doran
21bbf49396
Mention Python builtin methods in filter docs ( #65425 )
5 years ago
林博仁(Buo-ren Lin)
8ebc57c186
Mention that Python keywords are invalid Ansible variable names ( #65094 )
...
* Mention that Python keywords are invalid Ansible variable names
Using a Python keyword as a variable name triggers the error `Invalid variable name in 'register' specified: 'return'`.
5 years ago
Niklas Liechti
39ebd244e3
Update playbooks_filters.rst ( #64769 )
5 years ago
Andrew Schultz
756ac826fe
Improve ignore_unreachable documentation ( #64938 )
5 years ago
Sandra McCann
7084dd727a
clarify httpapi with an example ( #65083 )
5 years ago
Sandra McCann
b2fc12a29f
clean up network toc ( #65264 )
5 years ago
Kenyon Ralph
a797802d27
playbooks_filters_ipaddr.rst: fix syntax, indentation ( #65208 )
5 years ago
Sandra McCann
af64e9ce6a
add Automation Hub stub page ( #65261 )
...
* add Automation Hub stub page
* implement feedback
5 years ago
Sam Doran
0471ed3731
Add docs clarifying behavior of retry files ( #65153 )
5 years ago