Commit graph

580 commits

Author SHA1 Message Date
Abhijeet Kasurde
8d499bbc83
Update Kubernetes collection name in docs () 2021-04-27 19:00:03 +05:30
dhx-mike-palandra
c2985c491b
Update complex_data_manipulation.rst () 2021-04-27 14:04:48 +05:30
Alex Willmer
c295de661c
Correct splitext() description, and example ()
`splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.`
2021-04-22 15:40:58 -05:00
ml
c9c84594d8
Docs: Fix k8s_config_resource_name YAML example ()
The `name` key should be beneath `metadata`:
2021-04-20 13:37:44 -04:00
Abhijeet Kasurde
9ed0e37e53
Add a link to Jinja 2 templates ()
Added a link to Jinja 2 templates in playbooks_templating documentation page.
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-04-20 12:14:08 -05:00
yuri
5f391a72ee
Update playbooks_filters.rst ()
##### SUMMARY
Make the `random` filter description more clear.
2021-04-20 11:59:16 -04:00
Baptiste Mille-Mathias
99a2b5f300
Provide results to examples () 2021-04-20 11:52:54 -04:00
Brian Coca
7b39ee361d
corrected epmhasis line ()
need to be careful when adding lines as you create a different offset
2021-04-20 09:38:06 -05:00
Brian Coca
270f109bb3
fix see_also formatting () 2021-04-13 11:51:39 -04:00
Matthew Cengia
c7473828c7
Docs: Remove duplicate word ()
The word "to" was erroneously used twice consecutively.

Signed-off-by: Matthew Cengia <mattcen@mattcen.com>
2021-04-11 05:50:36 -05:00
Alicia Cozine
05662fd2ab
Docs: clarify role docs - vars vs params, dependencies () 2021-04-06 11:24:28 -04:00
Baptiste Mille-Mathias
6b33864a2c
Clarify tags on tasks are applied with OR and not AND ()
Co-authored-by: flowerysong <junk+github@flowerysong.com>
2021-03-30 11:05:54 -04:00
Felix Fontein
af7f3fc266
Revert "Add duplicated set filter and documentation ()" ()
This reverts commit 99a6627c60.

* ci_complete
2021-03-27 20:28:28 -05:00
Baptiste Mille-Mathias
99a6627c60
Add duplicated set filter and documentation ()
Co-authored-by: Kerry <kerry@flatline-studios.com>
2021-03-27 00:18:55 +01:00
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. ()
+label: docsite_pr
2021-03-25 16:05:50 -04:00
saruter
73c08df2db
Docs: Add filter "urlencode" with example ()
* Add example for URLENCODE filter
2021-03-25 15:20:41 -04:00
David Greaves
4881ca1dcb
Introduce the concept of playbooks early on ()
* Introduce the concept of playbooks early on
Co-authored-by: Sandra McCann <samccann@redhat.com>
2021-03-25 11:55:01 -04:00
Brian Coca
ccd9a992cf
complex data example using value and default from list of dicts () 2021-03-18 12:31:33 -07:00
Alicia Cozine
b57444af14
Rebased pr73824 ()
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-03-17 16:07:38 -04:00
Jens Heinrich
27eaab310b
Add direct link to using multiple inventory sources ()
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>
2021-03-11 14:36:00 -05:00
David Shrewsbury
78d3810fdf
Auto cleanup of async cache file ()
* Auto cleanup of async cache file

* Add changelog
2021-03-04 11:06:27 -08:00
Brian Williams
1f2f292290
Fix invalid yaml in collections_using.rst ()
Fix invalid quoting.
2021-03-02 10:10:08 -05:00
Brian Coca
91b42d62fa
another useful example () 2021-02-25 16:11:16 -06:00
Viktor Ekholm
b28abdfbdb
Fixed typo in vault documentation ()
Example variable was named `my_encrytped_var`. Renamed it to `my_encrypted_var`.
2021-02-22 19:03:23 -06:00
David Shrewsbury
c8ee186e11
Remove warning about role validation with deps ()
* Remove warning about role validation with deps

* add changelog

* update cl
2021-02-18 17:16:03 -06:00
Willams de Lima
fa05af8321
Fixing ad-hoc commands () 2021-02-18 16:48:22 -06:00
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