Commit Graph

2320 Commits (36ed3321fd29ff578885e9c800288adda316dcb6)

Author SHA1 Message Date
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 ffc1f33f2a Docs: make different heading levels more obviously different in html output (#66253) 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
Toshio Kuratomi 365820f871 Add a banner which will display on the testing site. (#64763)
* Add a banner which will display on the testing site.

Thanks to shane for the javascript code

* change to more noticable color

Co-authored-by: Sandra McCann <samccann@redhat.com>
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
evitalis c5c1ad4fb8 Make docs testing_formatter script more portable (#65112)
* Make script more portable
sha1sum is a Linux only command. Test for the command and if not found
use sha1 instead for portability. Avoid patches on BSD and Mac systems.
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
Sandra McCann 96cbbdd59f update version metadata to get faceted swiftype search running (#65574)
* update version metadata to get faceted swiftype search running
5 years ago
Toshio Kuratomi 9973121f44 Fix ansible-galaxy man page generation (#65478)
The Action list was misformatted, leading to an error message in the man
page.

https://bugzilla.redhat.com/show_bug.cgi?id=1717110
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
Sloane Hertel c1f280ba6e
Inventory CLI - Ignore settings for when vars plugins should run (#65073)
* Inventory CLI - Ignore settings for when vars plugins should run and just always run them

* Add note to porting guide

* Fix loading vars plugins

* changelog

* Remove a staging test for ansible-inventory since it ignores that setting
5 years ago
gaoruifeng f9f7a0c60e fix syntax issue (#65166)
- can disabled  
+ can be disabled
5 years ago
Trevor Pounds 8daa42bb3d Support non-KV and KV v1/v2 secret engines (#64288)
* Support generic and KV v1/v2 secret engines.

Fixes #41132
Fixes #50598
Fixes #54462
Fixes #64150

* Update KV v2 compatibility notes/usage docs.

* Add tests for KV v1/v2 and generic secrets engines.

* Add changelog fragment.

* Add KV v2 behavior changes to porting guide.

* Fix pylint blacklisted name warnings.
5 years ago
Felix Fontein f4d45ffdff
docker_container: change network_host default behavior for Ansible 2.14 (#64635)
* Update network_mode docs.

* Announce default change for 2.14.

* Add changelog fragment.
5 years ago
Chris Budzilowicz 0ab21fd1ec add note re required forward slash on url (#65203) 5 years ago
Mark Chappell 6e652ae6df Improve consistency of IAM_{role,user,group} behaviour (#64258)
* iam_user: use AnsibleAWSModule.client to fetch connection rather than C&P code

* iam_role: Add deprecation warning so we can switch purge_polices default behaviour from true to false

* iam_user/role/group: Rename 'managed_policy' and 'purge_policy'

Rename from singluar to plural (we accept a *list* of policies), and add aliases for the old values.

* Cleanup documentation

* Changelog
5 years ago
Felix Fontein 784e507671 module sanity checks: improve alias handling (#59060)
* add_file_common_args is only of interest on top-level.
* Handle undocumented arguments in one place.
* Update ignore.txt
* Add changelog
5 years ago
Egor Zaitsev f3575c5025 docs: add solution to timeout errors to docs (#65140) 5 years ago
Alicia Cozine b0c8e7926f link from quickstart page to Network Getting Started (#65150) 5 years ago
Mark Chappell f1311d3e98 Rewrite iam_policy using boto3 (#63924)
* reworked iam_policy

* Deprecate policy_document option

* deprecate defaulting skip_duplicates to true

* No longer explicitly catch ParamValidationError.

ParamValidationErrror is already caught by ClientError

* Work with complex policy objects rather than json documents

comparisons can better cope with the special cases (eg True vs "True" )

* Enable check_mode tests and fix related 'changed' bug

* changelog

* doc cleanup based on review
5 years ago
Baptiste Mille-Mathias e65be0beee Put all files and Path filters under a specific section (#64913)
Many of the filters in the "other useful filters" list manipulate filenames and paths; add a heading and put them together.
5 years ago
Felix Fontein b6f0f14dd3 Document diff. (#64888) 5 years ago
Xu Yuandong 09aebf33e4 Add doc to ce for user guide. (#63982) 5 years ago
Sloane Hertel a4b36b2e6a Update cache plugin documentation (#63635)
* Update cache plugin documentation since all cache plugins shipped with Ansible can be used for caching inventory since 2.8

* Update docs/docsite/rst/plugins/cache.rst

Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>

Co-Authored-By: John R Barker <john@johnrbarker.com>
5 years ago
Sandra McCann 2749090bc6 fix collection broken links (#65010) 5 years ago
Baptiste Mille-Mathias 1d0a832692 Fix link to Roles (#64992) 5 years ago
Baptiste Mille-Mathias f198036d7f Remove duplicated and broken link to Roles (#64991) 5 years ago
Alicia Cozine 1df62f129a Collections versions (#64912) 5 years ago
Maciej Delmanowski 45527716fd Add module ldap_attrs; deprecate ldap_attr (#62701)
* Add ldap_attrs module

* Fix codesyle error

* Apply deprecation rules

* Add support for X-ORDERED extension in ldap_attrs

The 'X-ORDERED' LDAP extension allows definition of ordered LDAP object
attributes. This extension is used in OpenLDAP "cn=config" database to
support ordered configuration options.

Specification: https://tools.ietf.org/html/draft-chu-ldap-xordered-00

* Update ldap_attr deprecation notice

* Documentation improvements based on suggestions

* Remove redundant dots from documentation

* Correct 'insertations' to 'insertions'

* Remove insecure 'params' option

* Fix sanity ignore errors

* Improve module documentation

* Change example value from string to list

* Fix support for "" values
5 years ago
Mario Lenz 034df49c56 VMware: New module vmware_host_dns (#64458)
* Restore module vmware_dns_config
* Remove domainname and change_hostname_to
* Changed version_added from 2.10 to '2.10'
* Add setup_attach_host: true to test case
* Add 'vcsim is not defined' block to integration tests
* Change 'result' to 'dns_config_result'
* Bugfix: Changing some static configurations while keeping others can crash the module
* Implement changing DNS config from DHCP to static on a cluster
* Update documentation for vmware_host_dns
* vmware_host_dns integration tests: Always revert to original DNS configuration, even if a test fails
* Deprecate vmware_dns_config
5 years ago
Sandra McCann a01376a493 update configuring ansible-galaxy client (#64796)
* update configuring ansible-galaxy client, deduplicate, clarify tokens, AH procedures, etc.
5 years ago
Jordan Borean 762fcf78b9
win_pester - Align dir scanning with Pester's defaults (#64880)
* win_pester - Align dir scanning with Pester's defaults

Co-authored-by: Coby Caldwell <cobycaldwell@gmail.com>

* Fix sanity issues
5 years ago
Matt Clay 4f51b7d323 Remove ansible-test --tox delegation option.
Use the --venv option instead.

This option was only available when running from source to test the ansible/ansible repository.

This will have no effect on testing collections or running from an installed version of Ansible.

Also update docs to reference the --venv option instead of the --tox option.
5 years ago
SriVignessh Pss 161e0be89b Fix access variable name programmatically faq docs (#64041)
* Add an example of replacing dashes with underscores in interface names for IPv4
5 years ago
Robert de Bock f17a55a181 Add advice how to prevent jinja2 warning (#60594)
* Add advice how to prevent jinja2 warning

##### SUMMARY
This addition helps users to demonstrate how to prevent `[WARNING]: when statements should not include jinja2 templating delimiters`.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* Update playbooks_tests.rst

* Update playbooks_tests.rst

Refer to the advised FAQ about when to use `{{ }}`.
5 years ago
Abhijeet Kasurde eac7fa1860
gitlab_user: Remove optional parameters while state is absent (#64832)
While deleting gitlab user, several parameters such as email, name,
password are not required. This fix removes this requirement from the
module.

Fixes: #61921

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
5 years ago
Jordan Borean f8f7662850
Add the ability to ignore files and collection build (#64688) 5 years ago
Vincent Bernat bf19060683 ipaddr: add an option to return peer of a point-to-point link (#59144)
* ipaddr: add an option to return peer of a point-to-point link

Signed-off-by: Vincent Bernat <vincent@bernat.ch>

* ipaddr: extend "peer" to also work with /30
5 years ago
John Mahowald bb72b8f1d9 Syntax fix guide_gce.rst (#64779)
Fix syntax for create a GCP instance example playbook. Fix task indentation.
5 years ago
Vera 844b5d4673 docs: fix gcs example to work with ansible 2+ (#64778)
switched directive sudo to become
5 years ago
James Cassell a7f90df0e9 Document match/search tests (#64775)
* clarify `search` vs `match` tests

* string test docs: fix rst formatting
5 years ago
Sandra McCann 94e98d5369 remove toshio as release manager (boohoo) (#64685) 5 years ago
Brian Coca c1493e5267 really clarify environment (#62531)
Co-Authored-By: John R Barker <john@johnrbarker.com>
5 years ago
Petr Ruzicka a5dc11cdd1 Changed with_items -> loop (#62995) 5 years ago