Commit Graph

740 Commits (81813b7f23f6c33d9bec52f04d0d061bd5f1755e)

Author SHA1 Message Date
Tamas Szabo 81eec4a05a
Docs: code-block wrapping for playbooks_module_defaults.rst #75936 (#75942) 3 years ago
Nathan Tsai a2ff765e06
Docs: add code-blocks to User Guide modules_intro (#75932) 3 years ago
Mahesh a4a7a34893
Docs: Add code-blocks to user_guide/intro_patterns.rst (#75941) 3 years ago
nicpayne713 4381336fbb
Docs: issue 75922 add code-blocks to user_guide/playbooks_environment.rst (#75929)
Add code-blocks in the 6 outlined examples from the Issue
3 years ago
Pinky b03afeec6c
Adding code-block elements in user_guide/playbooks_prompts.rst (#75935) 3 years ago
Tim Pogue d0b88eecd8
Code block format user guide/windows setup.rst #75914 (#75956)
* set changes for code boxes.

* post changes to attempt to fix seealso links.

* attempting to fix seealso tag

* fix un-indention for sanity check.
3 years ago
Lucas Culley 89bc7ebfe6
code-block wrapping for playbooks_advanced_syntax.rst (#75981)
* code-block wrapping for playbooks_advanced_syntax.rst

* fixed spacing
3 years ago
Tamas Szabo 801db758d3
code-block wrapping for playbooks_best_practices.rst #75937 (#75939) 3 years ago
RamblingPSTech 8988f8ab5d
Corrected mytask.yml file name (#75860) 3 years ago
Sandra McCann 927ffe26b7
Docs: add install link for windows (#75811) 3 years ago
Abhijeet Kasurde 6981237130
ad-hoc: add documentation about pattern (#73303)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Brian Coca 0cb7a4d260
clarify order (#75338) 3 years ago
Brian Coca e5a52c1e9d
added section about parallelism to delegation (#74158) 3 years ago
Brian Coca d3ebbef075
correct dedupe scope (#75422) 3 years ago
Matt Martz 5183a2e585
Add note about `loop_control.extended` memory impact (#75759)
* Add note about `loop_control.extended` memory impact

* moar correct
3 years ago
Daniel Goldman 989eeb243f
Add an `undef` global Jinja function (#75435)
* add tests for fail filter

also tests that fail does not block inspectability

* add fail filter

fallback message is a bit clunky,
since you can't invoke a filter without specifying an input.
That is, "{{ fail }}" doesn't work,
so you have to do "{{ None | fail }}"

* document 'fail' filter

* add changelog fragment

* fail filter uses default message on Undefined or emptystring

makes it slightly easier to use the default message:
```diff
- "{{ None | fail }}"
+ "{{ '' | fail }}"
```

and the user sees a slightly more relevant message
if the message itself is undefined:

```diff
- The error was: {{ failmsg | fail }}: 'failmsg' is undefined
+ The error was: {{ failmsg | fail }}: Mandatory variable has not been overridden
```

* rebuild as the builtin `Undefined`

* harmonise `hint` parameter for make_undefined with jinja

* use code block for documentation item

[ref](https://github.com/ansible/ansible/pull/75435#discussion_r707661035)

* rename to `undef` to expose less Python into the Jinja

[ref](https://github.com/ansible/ansible/pull/75435#pullrequestreview-757799031)

* explicitly instantiate undefined value now that it's possible

see I knew we would break something with reflection

* preserve test coverage of undefined variable

Co-authored-by: Matt Davis <nitzmahone@users.noreply.github.com>
3 years ago
Aine Riordan 3d081b6ca5
Docs: Edit list of locations to search for roles (#75703)
* Docs: Add playbook base dir to roles search

* Docs: Add link to default roles path
3 years ago
Aine Riordan 01f0c38aa5
Docs: Update cross reference tag syntax in User Guide (#75693) 3 years ago
Erik Zettel c2fa71c4e8
Fix various typos in documentation (#75662)
* docs/docsite/rst/dev_guide/developing_modules_general_aci.rst: fix typos

* docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst: fix typos

* docs/docsite/rst/dev_guide/testing_units_modules.rst: fix typos

* docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.0.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.10.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.4.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_3.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_4.rst: fix typos

* docs/docsite/rst/reference_appendices/glossary.rst: fix typos

* docs/docsite/rst/reference_appendices/release_and_maintenance.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/collect_information.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/vm_tool_information.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos

* docs/docsite/rst/user_guide/playbooks_debugger.rst: fix typos

* docs/docsite/rst/user_guide/playbooks_filters.rst: fix typos

* docs/docsite/rst/user_guide/windows_performance.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos
3 years ago
Brian Coca 90518d8bb5
added vault/unvault docs (#75140) 3 years ago
Alicia Cozine 2c67954f9b
Docs: adds warning about utf-8 in templates (#75504) 3 years ago
Sloane Hertel db3e8f2c1c
import_role - support templating _from_files with --extra-vars (#75269)
* Support templating _from_files with --extra-vars for imported roles

* Add tests for templating the filenames for import_role, import_playbook, and import_tasks

* Add documentation

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
3 years ago
Abhijeet Kasurde 1dc495405f
Added missing colon in note (#75465)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Rich Rauenzahn 351f122e24
Update playbooks_tags.rst (#75472)
##### SUMMARY
When I used this example it complains with:

ERROR! The tasks/main.yml file for role 'myrole' must contain a list of tasks

The error appears to be in 'ansible/roles/myrole/tasks/main.yml': line 2, column 1, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

---
tasks:
^ here

Removing "tasks:" fixes it.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
3 years ago
Alicia Cozine 3c3e30a610
Docs: Add Matrix as a chat option (#75406) 3 years ago
Jonas DOREL 39605cdcce
docs: missing colon for a note (#75453) 3 years ago
Brian Scholer 7d2b80371d
fix quick typo (#75373)
fix a small typo introduced in #75343
3 years ago
Martin Krizek 6607051b75
docs: clarify regex_search return value (#75343) 3 years ago
Alicia Cozine 13c28664ae
Docs: talk about AWX or the Platform, not Tower (#74952)
* updates Tower page to talk about RHAAP

* updates scenario guide Tower references

* updates Tower references to use AWX and/or RHAAP

* more scenario guides fixes

* fix CI failures

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

* removes tower link

* for 2.8, still mention Tower along with AWX and RHAAP

* aws guides should be updated in the collection, where they now exist

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
3 years ago
Sloane Hertel 3b861abce1
add action_groups support to collections (#74039)
* Canonicalize module_defaults actions and action_groups pre-fork and cache them on the play

* Call get_action_args_with_defaults with the resolved FQCN plugin and don't pass the redirect list

* Add validation for action_group metadata and a toggle to disable the warnings

* Handle groups recursively referring to each other

* Remove special-casing for non-fqcn actions in module_defaults groups

* Error for actions and groups in module_defaults that can't be resolved

* Error for fully templated module_defaults

* Add integration tests for action_groups

* Changelog
3 years ago
Todd Walton d9eb846534
Update vault script (#75074)
Update link to the `vault-keyring-client.py` file, which moved out of core.
3 years ago
Andreas Olsson 2eb9921b19
Prefer https:// links in the docs site (#75121)
This is a follow-up of previous years' 1a11cec and c8315bf. It deals
with links which at that point presumably either were not present or
did not support https://
3 years ago
Sandra McCann ea0ba7bf30
update terminology based on recent IBM Style Guide word list (#75089) 3 years ago
Andreas Olsson aedc82da98
Clarify Vault password client naming requirements (#75060) 3 years ago
Paul Smet 2e2a5829a2
Update FreeBSD Python version in intro_bsd.rst (#74938)
* Use the python pkg instead of a specific version
The python pkg contains a symlink to the default python interpreter.
3 years ago
Alan Hinchliff 3fa6e6d038
example hosts should match play (#74959) 3 years ago
bluikko b0f62062d3
Async task change handling (#75020)
Async task changes should be handled in the async_status task.
3 years ago
Andrew Klychkov 5df82415b5
collections_using.rst: add note that manual upgrade is required when installing collections from Galaxy (#75024) 3 years ago
David Shrewsbury 97acb0f470
role argspec - tag role argspec validation task with 'always' (#74994)
* update tag docs
3 years ago
Felix Fontein 81ad125aa6
Fix name of subkey. (#74939) 3 years ago
Felix Fontein acf09e56a2
Update inventory script references from c.g to ansible-community/contrib-scripts. (#74905) 3 years ago
twalsh-uod 3d8feed2cf
Update playbooks_filters.rst (#74911)
Fix typo: 'sting' -> 'string'
3 years ago
pefmeister 41f42d6bf6
Update intro_bsd.rst (#74768)
OpenBSD 6.9 is out and the default version of Python is 3.8, with no more 3.7.
3 years ago
file not found 81c770e44a
Update intro_getting_started.rst (#74786)
Changed confusing wording.  People new to ansible, like myself, have a hard time grocking what is a playbook and what is a task.   I changed the name of the playbook to make it clearer.
3 years ago
Toshio Kuratomi 80e7e1a17c
Due to the takeover of freenode we're moving to a different irc network. (#74775)
* Due to the takeover of freenode we're moving to a different irc network.

* Our channels updated to point at the same channel name on libera.chat
* Some links went to webchat.freenode.net.  At this time, libera.chat
  doesn't point you to an official webchat client so I changed these to
  https://libera.chat. (kiwi irc does work with libera.chat so that
  could be another option).
* In general, I used the name irc.libera.net for link names and
  https://libera.chat for link targets.  This is because the irc service
  is hosted on irc.libera.chat but the project web server is hosted on
  libera.chat.  (This appears to also be true for freenode but we were
  using http://irc.freenode.net which doesn't seem to work.  Oops).
* Removed http://irc.freenode.net from the linkcheck exceptions.
  linkcheck was actually correct to flag that as invalid (should have
  been http://frenode.net instead).

* Looks like hte important people in #yaml are now in libera.chat

* Link to where contributors should get help

Add a link target and then link to where contributors should get support
for developing groups of modules.

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

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: John R Barker <john@johnrbarker.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
3 years ago
Abhijeet Kasurde 870f943365
docs: Update Python 2 doc links (#74633)
* docs: Update Python 2 doc links

Update links from Python 2 to Python 3

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* use docs.python.com/3/ everywhere, except onethat should remain 2.6

* refer to python 3 in module docs and comments

* format two python docs links as list

* updates links in unwanted.py test file

* per matt clay, this should link to python 2

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
3 years ago
Abhijeet Kasurde 1bd7dcf339
encrypt: add new paramter 'ident' (#74595)
Add a new parameter `ident` for specifying version of BCrypt
algorithm. This parameter is only valid for `blowfish` hash type.
3 years ago
Abhijeet Kasurde 015331518d
windows: Add openssh installation link (#74765)
* Added a link to openssh installation on Windows

Fixes: #73490

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Chander G 888fea69e5
Fix small typo in playbook_filters doc (#74762)
Move versionadded to next line to render correctly.
3 years ago
Sam Doran c0cb353ce1
Remove PyCrypto (#74699)
* Remove PyCrypto from setup.py and packaging script
* Remove mention of pycrpto from installation docs
* Remove PyCrypto from vault
* Remove pycryto constraint and unit test requirement
* Remove PyCrypto tests from unit tests
* Add docs and fix warning message
* Remove section about cryptography library in Ansible Vault docs
3 years ago
Vincent Rubiolo 5266e1e1ab
Fix broken Jinja website links (for tests) (#74746)
The various links to the Jinja website were broken, this commit fixes them.
3 years ago
Vincent Rubiolo 8d7a5d9cb3
Fix broken Jinja website links (#74745)
The URLs to the Jinja website have moved, seemingly because of the renaming from `master` to `main` (hence from `master` to `latest` in the doc). This commit fixes that.
3 years ago
Brian Coca 5333e4138c
note about adhoc delegate_to hosts (#74687)
* Update docs/docsite/rst/user_guide/playbooks_delegation.rst
3 years ago
Abhijeet Kasurde 2f87b8760d
docs: Add a note about ansible_date_time (#74636)
* For long-running playbooks, discourage users from using
`ansible_date_time`. Use `pipe` or `now` as an alternative.

* Review comments

Fixes: #22561

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
3 years ago
Abhijeet Kasurde 39df263f1a
intro: Add a note about current user (#74638)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
m0nt3cr1st0 25de07946c
Fix typo on roles documentation (#74696)
##### SUMMARY
Small fix on the roles directory structure documentation

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
3 years ago
Alicia Cozine 829c9c3d46 updates jinja filters links with new pattern for Jinja 3.x documentation 3 years ago
Abhijeet Kasurde 79e12ba98e
docs: Add a note about `crypt` (#74640)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
David Shrewsbury 8fb54885bf
Role argspec: allow new argument spec file (#74582)
* support separate role argspec file in ansible-doc

* support separate role argspec file in ansible-core

* support both .yml and .yaml extensions on argspec file in ansible-doc

* fix filename building bug and rename some argspec files to test variations

* use yaml extensions from constants

* add superfluous meta/main.yml files to tests

* Update lib/ansible/cli/doc.py

Co-authored-by: Sam Doran <sdoran@redhat.com>

* update docs

* ci_complete

* add changelog and allow for main.yml variations

* add collection role testing

Co-authored-by: Sam Doran <sdoran@redhat.com>
3 years ago
Christian Fetzer f194108a26
docs: Improve documentation for regex_search,replace,findall (#74368)
Improve the documentation for regex_search by adding a few more
realistic examples such as showing how to extract only parts of a
string by using regex groups.

Extend regex_findall and regex_replace by an example that includes
the multiline and ignorecase parameters.
3 years ago
Abhijeet Kasurde 8d499bbc83
Update Kubernetes collection name in docs (#74440) 3 years ago
dhx-mike-palandra c2985c491b
Update complex_data_manipulation.rst (#72509) 3 years ago
Alex Willmer c295de661c
Correct splitext() description, and example (#74377)
`splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.`
3 years ago
ml c9c84594d8
Docs: Fix k8s_config_resource_name YAML example (#74129)
The `name` key should be beneath `metadata`:
3 years ago
Abhijeet Kasurde 9ed0e37e53
Add a link to Jinja 2 templates (#74348)
Added a link to Jinja 2 templates in playbooks_templating documentation page.
Fixes: #74313

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
yuri 5f391a72ee
Update playbooks_filters.rst (#74242)
##### SUMMARY
Make the `random` filter description more clear.
3 years ago
Baptiste Mille-Mathias 99a2b5f300
Provide results to examples (#73984) 3 years ago
Brian Coca 7b39ee361d
corrected epmhasis line (#74254)
need to be careful when adding lines as you create a different offset
3 years ago
Brian Coca 270f109bb3
fix see_also formatting (#74252) 4 years ago
Matthew Cengia c7473828c7
Docs: Remove duplicate word (#74223)
The word "to" was erroneously used twice consecutively.

Signed-off-by: Matthew Cengia <mattcen@mattcen.com>
4 years ago
Alicia Cozine 05662fd2ab
Docs: clarify role docs - vars vs params, dependencies (#74104) 4 years ago
Baptiste Mille-Mathias 6b33864a2c
Clarify tags on tasks are applied with OR and not AND (#74038)
Co-authored-by: flowerysong <junk+github@flowerysong.com>
4 years ago
Felix Fontein af7f3fc266
Revert "Add duplicated set filter and documentation (#72729)" (#74053)
This reverts commit 99a6627c60.

* ci_complete
4 years ago
Baptiste Mille-Mathias 99a6627c60
Add duplicated set filter and documentation (#72729)
Co-authored-by: Kerry <kerry@flatline-studios.com>
4 years ago
sgpinkus 2abb2d3f17
Update playbooks_variables.rst. To say you can define variables within a playbook is somewhat misleading. Variables are defined within plays and are only visible within the play they are defined in *not* the entire playbook. There is no way to define vars to have strictly playbook scope. (#73986)
+label: docsite_pr
4 years ago
saruter 73c08df2db
Docs: Add filter "urlencode" with example (#74034)
* Add example for URLENCODE filter
4 years ago
David Greaves 4881ca1dcb
Introduce the concept of playbooks early on (#74018)
* Introduce the concept of playbooks early on
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Brian Coca ccd9a992cf
complex data example using value and default from list of dicts (#73937) 4 years ago
Alicia Cozine b57444af14
Rebased pr73824 (#73934)
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Jens Heinrich 27eaab310b
Add direct link to using multiple inventory sources (#73680)
This helps users to find the right ressources more easily and prevents them from clicking the first matching link only to be redirected to a subsection on the samepage from there

Co-authored-by: Jens Heinrich <github.com/JensHeinrich>
4 years ago
David Shrewsbury 78d3810fdf
Auto cleanup of async cache file (#73760)
* Auto cleanup of async cache file

* Add changelog
4 years ago
Brian Williams 1f2f292290
Fix invalid yaml in collections_using.rst (#73727)
Fix invalid quoting.
4 years ago
Brian Coca 91b42d62fa
another useful example (#73728) 4 years ago
Viktor Ekholm b28abdfbdb
Fixed typo in vault documentation (#73666)
Example variable was named `my_encrytped_var`. Renamed it to `my_encrypted_var`.
4 years ago
David Shrewsbury c8ee186e11
Remove warning about role validation with deps (#73653)
* Remove warning about role validation with deps

* add changelog

* update cl
4 years ago
Willams de Lima fa05af8321
Fixing ad-hoc commands #73636 (#73646) 4 years ago
Lydie 4059b37ab1
Conscious language added to user guide, development guide, and Ansible community guide, (#73574)
* Added conscious language note to index pages of guides
4 years ago
David Shrewsbury f0ec10dbc3
Role arg spec validation implementation (#73152)
* Initial import of modified version of alikins' code
* Add unit testing for new Role methods
* Fix validate_arg_spec module for sanity test. Add test_include_role_fails.yml integration test from orig PR.
* Add testing of suboptions
* Use new ArgumentSpecValidator class instead of AnsibleModule
* fix for roles with no tasks, use FQ name of new plugin
* Add role dep warning
4 years ago
Brian Coca 1cb753225c
added perf note to inc/imp diffs (#73371) 4 years ago
Matt Martz d3441bc313
Add new split filter (#73532)
* Add version added
4 years ago
Sloane Hertel bd18be6c0c
Fix ansible-galaxy collection subdir searching and update documentation (#73406)
* Ensure there is a single source of collection metadata
* Allow collection subdirs to be detected by a galaxy.yml or MANIFEST.json
* Add documentation about installing and downloading collection directories
* Add an example for downloading a git repository
* Update documented valid metadata sources for installing git repositories

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Abhijeet Kasurde 7f6fcc3407
json_query: Update documentation (#73302) 4 years ago
luto 51e00c5e86
Fix documentation for slaac filter (#73294)
##### SUMMARY

One of the parameters to the slaac filter was unquoted causing a crash:

```
template error while templating string: expected token 'end of print statement', got ':'. String: {{ fdcf:1894:23b5:d38c:0000:0000:0000:0000 | slaac('c2:31:b3:83:bf:2b') }}
```

This adds the missing quotes.

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Brian Coca 13ea312cc8
added pb fqcn docs (#72602)
* added pb fqcn docs
4 years ago
Martijn Suijlen aa21804165
Added TLS security protocol for Powershell downloads (#73226)
##### SUMMARY
Added `[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12` to the Powershell scripts that use a file download. If not specified the script won't be allowed to download data from the mentioned URL's.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Adam Miller e9a1ff296e
Fix block example line emphasis (#73238)
Signed-off-by: Adam Miller <admiller@redhat.com>
4 years ago
Gregor Riepl 403a3b90b5
Fix list to dict example (#73213)
##### SUMMARY
<!--- Your description here -->
single_list must be transformed to a list of pairs before feeding it into dict()

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Sascha Marcel Schmidt 61f0d6b919
add note regarding datetime docs (#72976)
Adds a note pointing to the datetime documentation as to_datetime does not use the time library but instead uses datetime.
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Tim Herty 995e76c6e3
Update windows_winrm.rst (#73101)
The standard Port for ansible winrm is set to 5986/HTTPS. 
To be able to use Kerberos, you need to set ansible_port: 5985/HTTP otherwiese you get error message or timeout.
HTTPS is not needed for environments with Kerberos, since kerberos has server identification built in to the protocoll.
FYI: HTTP traffic will by default also be encrypted when using kerberos
4 years ago
Jean-Pierre Matsumoto 3074ede8a3
ExecutionPolicy default value is RemoteSigned (#72993)
* ExecutionPolicy default value is RemoteSigned

##### SUMMARY
In Windows setup steps, settings `ExecutionPolicy` is restored to value `Restricted`. But actually default value for Windows server is not `Restricted` but `RemoteSigned` ([source](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.1#default)).

I have got issue with `win_dsc` because `ExecutionPolicy` was `Restricted`.

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* Add changelog fragment

* Apply suggestions from code review

Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Dmitry 79ab1247b8
Fixed vault id in variable encryption example (#72626) 4 years ago
Sam Doooran 103decccac
Add complex example of fileglob with loop (#72396)
* Add complex example of fileglob with loop

* Explain Python unpacking notation

* Add missing paren
4 years ago
Matt Martz 97765f4ebd
Role duplicates docs updates (#72666)
* Change example to use role params to represent the documented outcome. Fixes #68922

* Add notes about how vars vs role params affect variable scoping, and how lazy evaluation and role-deduplicating is affected. Fixes #72650

* link to term
4 years ago
Sam Doooran 8fdb5ace01
Update WSL docs to mention sleep workaround (#72839)
Co-authored-by: Joseph Chambers <joe.chambers@lexisnexis.com>
4 years ago
flowerysong 8450858651
Remove inaccurate Vault documentation (#72938)
This is not functionality that exists.
4 years ago
Alicia Cozine e5ccd18be4
Wording changes to docs (#70082) 4 years ago
devon-mar e97f333532
Add missing endfor to vlan_parser example (#72872) 4 years ago
Abhijeet Kasurde 38f21557ba
json_query: Add examples for starts_with and contains (#72821)
* Add a note about - data structure returned from register variables
needs to be parsed using ``to_json | from_json`` in order to
get correct result.
* Add examples for starts_with and contains

Fixes: https://github.com/ansible-collections/community.general/issues/320

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Andrew Klychkov 2aa3531b1b
Docsite: update complex_data_manipulation and playbooks_advanced_syntax rst files to use FQCNs (#72539) 4 years ago
Simon Heimberg 79fb065d16
document that handler can not run include_role and import_role (#72744)
Warn the users until issue #20493 is fixed.
4 years ago
gfyoung fa481e3316
Fix missing dashes in playbooks intro doc (#72746) 4 years ago
Pablo Martinez 454ac6420e
Update playbooks_filters_ipaddr.rst (#72705)
Fix the order of the arguments for ansible.netcommon.reduce_on_network. Pass the network as the argument and the list of IP addresses as the filter input.
4 years ago
gdiamond 74196577a3
added sample output for echo example (#72718) 4 years ago
gdiamond 35022e13a8
Update intro_getting_started.rst (#72689)
Move the command output to immediately follow the example.
4 years ago
Brian Coca 452bc3af04
example of exponential backup (#72617) 4 years ago
Andrew Klychkov dbe43e071e
Docsite: update user_guide/playbooks_module_defaults (#72051)
* Docsite: update user_guide/playbooks_module_defaults, add name: lines and use FQCN consistently
4 years ago
Josh 1a5d2938c6
Update playbooks_filters_ipaddr.rst (#72464)
Fix small code formatting issue - remove extra `:` before code-block.
4 years ago
Kohei Takahashi 2e4038f4d2
Fixed a typo in user_guide/playbooks_conditinals (#72427)
+label: docsite_pr
4 years ago
Daniel Tavernier dd19c9f737
Update playbooks_tags.rst (#72351)
##### SUMMARY
Corrected the "Adding tags to blocks" example syntax. 


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Jaime Hablutzel afba5c2852
Miscellaneous fixes in user_guide/intro_inventory.rst docs (#72202)
* Fixing missing hosts entry under the group dict.

* Added missing 'vars:' key

* Reordering arguments for consistency with the format displayed by "ansible-playbook --help"

* Fixing contradictory text
4 years ago
Ronald Eddy Jr d18901dd4a
Update HTTP -> HTTPS (#72244)
Co-authored-by: Ronald Eddy Jr <ron@Ronalds-MacBook-Pro.local>
4 years ago
Justin Otherguy 8465f285cc
Update playbooks_strategies.rst (#72176)
beside the fact that naming the variable to specify the number of machines executed in *parallel* is named *serial* - the number of hosts chosen in this example is not optimal, either: 2x2 = 4; so - 3 hosts in 2 batches should clear things up a little
4 years ago
Ken Celenza b18e462bbb
Consistent Taxonomy (#72215)
Historically "these" have been called directives, attributes, and keywords. We've now settled on `keyword` (https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html). Update all documentation to reflect this term.
4 years ago
Sandra McCann 7c1dd1c7fb
add link to jinja docs from templating section (#72205) 4 years ago
Andrew Klychkov 30a651bca3
Docsite: update user_guide/playbooks_async (#72115) 4 years ago
Jens Heinrich 835752cc53
Update playbooks_vars_facts.rst (#72150)
Remove misleading typo, add a note on the mode of local facts

Co-authored-by: JensHeinrich <github.com/JensHeinrich>
4 years ago
Evan Van Dam 3db08adbb1
Add optional attribute arg for min and max filters (#50909)
* Pass **kwargs to min and max filters

* Use the jinja2 filters if available

* Add unit tests

* Add examples to docs passing attribute
4 years ago
Erik Zettel 2b79cd2c0f
Fix typos (#72072) 4 years ago
Andrew Klychkov 3efc8b6de8
Docsite: update user_guide/playbooks_prompts (#72049) 4 years ago
Andrew Klychkov c12fce3aa9
Docsite: update user_guide/playbooks_checkmode (#72052) 4 years ago
Andrew Klychkov 77840f886e
Docsite: update user_guide/playbooks_debugger (#72053) 4 years ago
Abhijit Menon-Sen 64d9ccb965
Reword strangely patronising introduction to loops (#72019) 4 years ago
Jorge Vallecillo 94522b7c10
Fix typos (#71970) 4 years ago
Andrew Klychkov 74be7de361
Docsite: improve user_guide/playbooks_vars_facts (#71973)
* Docsite: improve user_guide/playbooks_vars_facts
4 years ago
Andrew Klychkov 8ae3998ecf
Docsite: update user_guide/vault (#71975) 4 years ago
Andrew Klychkov 0645436acd
Docsite: update user_guide/playbooks_filters (#71980) 4 years ago
Alicia Cozine eed606e0e9
adds name lines to handler re-use examples (#71946)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Andrew Klychkov c19af92be6
Docsite: improve user_guide/playbooks_variables (#71938)
* Docsite: improve user_guide/playbooks_variables
4 years ago
Andrew Klychkov 2fed63a930
Docsite: improve inventory-related pages (#71907)
* Update docs/docsite/rst/plugins/inventory.rst
4 years ago
Badhreesh a47eafa581
Update playbooks_reuse_roles.rst (#71880)
Change "vars_files" to "vars, files" under the Roles heading
4 years ago
Andrew Klychkov 25bfda8417
Docsite: improve user_guide/intro_inventory (#71859) 4 years ago
Andrew Klychkov c3841b8440
Docsite: improve user_guide/playbooks_tags (#71858) 4 years ago
Andrew Klychkov 7a0a2f188b
Docsite: improve user_guide/playbooks_reuse_roles (#71857)
* Docsite: improve user_guide/playbooks_reuse_roles

* fix
4 years ago
Baptiste Mille-Mathias 401be27053
Add example values and results for theory filters (#71908)
Add example values and results for theory filters
4 years ago
Andrew Klychkov ed6fb2e3f6
Docsite: improve user_guide/intro_adhoc (#71909) 4 years ago
Sandra McCann d6063b7457
clarify FQCN use for playbooks (#71816)
* clarify FQCN use

* Apply suggestions from code review

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
brnl 5b27b307b9
Update intro_getting_started.rst (#71851)
Fixed the formatting on the remote user name override list.
4 years ago
Sandra McCann bcfead8e0f change duplicated label 4 years ago
Andrew Klychkov 3db4be2c3b
Docsite: improve user_guide/playbooks_reuse (#71834) 4 years ago
Andrew Klychkov 05a45f63ff
Docsite: misc fixes of playbooks_delegation (#71753) 4 years ago