Commit graph

554 commits

Author SHA1 Message Date
Lydie
4059b37ab1
Conscious language added to user guide, development guide, and Ansible community guide, ()
* Added conscious language note to index pages of guides
2021-02-12 15:32:44 -06:00
David Shrewsbury
f0ec10dbc3
Role arg spec validation implementation ()
* 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
2021-02-12 16:00:17 -05:00
Brian Coca
1cb753225c
added perf note to inc/imp diffs () 2021-02-11 13:10:02 -05:00
Matt Martz
d3441bc313
Add new split filter ()
* Add version added
2021-02-09 10:37:15 -05:00
Sloane Hertel
bd18be6c0c
Fix ansible-galaxy collection subdir searching and update documentation ()
* 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>
2021-02-04 13:42:45 -05:00
Abhijeet Kasurde
7f6fcc3407
json_query: Update documentation () 2021-01-22 15:41:24 -05:00
luto
51e00c5e86
Fix documentation for slaac filter ()
##### 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
2021-01-20 13:10:24 -05:00
Brian Coca
13ea312cc8
added pb fqcn docs ()
* added pb fqcn docs
2021-01-20 11:34:33 -05:00
Martijn Suijlen
aa21804165
Added TLS security protocol for Powershell downloads ()
##### 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
2021-01-14 14:23:19 -08:00
Adam Miller
e9a1ff296e
Fix block example line emphasis ()
Signed-off-by: Adam Miller <admiller@redhat.com>
2021-01-14 14:40:31 -05:00
Gregor Riepl
403a3b90b5
Fix list to dict example ()
##### 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
2021-01-14 14:15:55 -05:00
Sascha Marcel Schmidt
61f0d6b919
add note regarding datetime docs ()
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>
2021-01-08 09:47:23 -06:00
Tim Herty
995e76c6e3
Update windows_winrm.rst ()
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
2021-01-07 14:55:32 -05:00
Jean-Pierre Matsumoto
3074ede8a3
ExecutionPolicy default value is RemoteSigned ()
* 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>
2021-01-04 15:41:54 -05:00
Dmitry
79ab1247b8
Fixed vault id in variable encryption example () 2020-12-18 12:16:38 -05:00
Sam Doooran
103decccac
Add complex example of fileglob with loop ()
* Add complex example of fileglob with loop

* Explain Python unpacking notation

* Add missing paren
2020-12-18 12:08:47 -05:00
Matt Martz
97765f4ebd
Role duplicates docs updates ()
* Change example to use role params to represent the documented outcome. Fixes 

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

* link to term
2020-12-18 11:55:54 -05:00
Sam Doooran
8fdb5ace01
Update WSL docs to mention sleep workaround ()
Co-authored-by: Joseph Chambers <joe.chambers@lexisnexis.com>
2020-12-18 11:49:56 -05:00
flowerysong
8450858651
Remove inaccurate Vault documentation ()
This is not functionality that exists.
2020-12-15 09:06:10 -06:00
Alicia Cozine
e5ccd18be4
Wording changes to docs () 2020-12-08 16:46:34 -05:00
devon-mar
e97f333532
Add missing endfor to vlan_parser example () 2020-12-08 16:25:56 +01:00
Abhijeet Kasurde
38f21557ba
json_query: Add examples for starts_with and contains ()
* 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>
2020-12-03 14:52:00 -05:00
Andrew Klychkov
2aa3531b1b
Docsite: update complex_data_manipulation and playbooks_advanced_syntax rst files to use FQCNs () 2020-12-02 10:29:49 -06:00
Simon Heimberg
79fb065d16
document that handler can not run include_role and import_role ()
Warn the users until issue  is fixed.
2020-12-01 10:15:46 -06:00
gfyoung
fa481e3316
Fix missing dashes in playbooks intro doc () 2020-11-30 16:19:40 -05:00
Pablo Martinez
454ac6420e
Update playbooks_filters_ipaddr.rst ()
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.
2020-11-30 11:58:11 -06:00
gdiamond
74196577a3
added sample output for echo example () 2020-11-30 09:59:27 -05:00
gdiamond
35022e13a8
Update intro_getting_started.rst ()
Move the command output to immediately follow the example.
2020-11-20 14:35:19 -06:00
Brian Coca
452bc3af04
example of exponential backup () 2020-11-13 16:00:21 -05:00
Andrew Klychkov
dbe43e071e
Docsite: update user_guide/playbooks_module_defaults ()
* Docsite: update user_guide/playbooks_module_defaults, add name: lines and use FQCN consistently
2020-11-04 09:58:47 -06:00
Josh
1a5d2938c6
Update playbooks_filters_ipaddr.rst ()
Fix small code formatting issue - remove extra `:` before code-block.
2020-11-04 09:14:17 -06:00
Kohei Takahashi
2e4038f4d2
Fixed a typo in user_guide/playbooks_conditinals ()
+label: docsite_pr
2020-11-02 10:04:57 -05:00
Daniel Tavernier
dd19c9f737
Update playbooks_tags.rst ()
##### SUMMARY
Corrected the "Adding tags to blocks" example syntax. 


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-10-27 15:50:49 -04:00
Jaime Hablutzel
afba5c2852
Miscellaneous fixes in user_guide/intro_inventory.rst docs ()
* 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
2020-10-20 10:35:15 -05:00
Ronald Eddy Jr
d18901dd4a
Update HTTP -> HTTPS ()
Co-authored-by: Ronald Eddy Jr <ron@Ronalds-MacBook-Pro.local>
2020-10-19 15:57:20 -04:00
Justin Otherguy
8465f285cc
Update playbooks_strategies.rst ()
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
2020-10-14 12:26:16 -05:00
Ken Celenza
b18e462bbb
Consistent Taxonomy ()
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.
2020-10-14 12:16:30 -05:00
Sandra McCann
7c1dd1c7fb
add link to jinja docs from templating section () 2020-10-12 13:52:24 -05:00
Andrew Klychkov
30a651bca3
Docsite: update user_guide/playbooks_async () 2020-10-09 10:50:58 -05:00
Jens Heinrich
835752cc53
Update playbooks_vars_facts.rst ()
Remove misleading typo, add a note on the mode of local facts

Co-authored-by: JensHeinrich <github.com/JensHeinrich>
2020-10-09 10:44:27 -05:00
Evan Van Dam
3db08adbb1
Add optional attribute arg for min and max filters ()
* Pass **kwargs to min and max filters

* Use the jinja2 filters if available

* Add unit tests

* Add examples to docs passing attribute
2020-10-05 10:40:37 -04:00
Erik Zettel
2b79cd2c0f
Fix typos () 2020-10-02 10:32:03 -04:00
Andrew Klychkov
3efc8b6de8
Docsite: update user_guide/playbooks_prompts () 2020-10-01 16:34:23 -04:00
Andrew Klychkov
c12fce3aa9
Docsite: update user_guide/playbooks_checkmode () 2020-10-01 16:33:24 -04:00
Andrew Klychkov
77840f886e
Docsite: update user_guide/playbooks_debugger () 2020-10-01 16:32:03 -04:00
Abhijit Menon-Sen
64d9ccb965
Reword strangely patronising introduction to loops () 2020-09-30 16:05:46 -04:00
Jorge Vallecillo
94522b7c10
Fix typos () 2020-09-28 14:33:24 -04:00
Andrew Klychkov
74be7de361
Docsite: improve user_guide/playbooks_vars_facts ()
* Docsite: improve user_guide/playbooks_vars_facts
2020-09-28 14:32:01 -04:00
Andrew Klychkov
8ae3998ecf
Docsite: update user_guide/vault () 2020-09-28 14:29:34 -04:00
Andrew Klychkov
0645436acd
Docsite: update user_guide/playbooks_filters () 2020-09-28 14:26:57 -04:00