Commit Graph

740 Commits (81813b7f23f6c33d9bec52f04d0d061bd5f1755e)

Author SHA1 Message Date
Sloane Hertel c3999d89f4
Clarify docs for using tests as filters (#77155) 3 years ago
Sandra McCann 22ba18d7b0
add links to remote_user docs (#77140)
* add links to remote_user docs
* shorten link name
3 years ago
Matt Clay 3f0d5bc351 Fix LooseVersion and StrictVersion refs in docs. 3 years ago
Brian Coca 84b85a5b5a
more explicit moustache docs (#77051) 3 years ago
fbourqui 1480503326
Update complex_data_manipulation example uptime in days/h/m/s (#77019) 3 years ago
Preston Carman f82b1ba67c
Update indentation for example in playbooks_handlers.rst (#75348) 3 years ago
Sandra McCann 32f7490a2c
Add note to serial docs (#77006)
* add note to serial docs
* add keyword directly
Fixes #76820
(cherry picked from commit de20f1bae8)
3 years ago
zasca 8939f4d2f7
add tasks (#75489) 3 years ago
Sloane Hertel 43e55db208
ansible-galaxy - add signature verification of the MANIFEST.json (#76681)
* ansible-galaxy collection install|verify:

  - Support verifying the origin of the MANIFEST.json when the Galaxy server has provided signatures.
  - Allow supplemental signatures to use during verification on the CLI/requirements file.

* ansible-galaxy collection install:

  - Support disabling signature verification. This silences the warning provided by ansible-galaxy if the Galaxy server provided signatures it cannot use because no keyring is configured.
  - Store Galaxy server metadata alongside installed collections for provenance. This is used by 'ansible-galaxy collection verify --offline'.

* Add unit tests for method that gets signatures from a Galaxy server

* Add integration tests for user-provided signature sources

- Test CLI option combinations
- Test installing collections with valid/invalid signature sources
- Test disabling GPG verification when installing collections
- Test verifying collections with valid/invalid signature sources

* Make signature verification advisory-by-default if signatures are provided by the Galaxy server

- Make the default keyring None
- Warn if the keyring is None but the Galaxy server provided signatures
- Error if the keyring is None but the user supplied signatures
- Error if the keyring is not None but is invalid

* changelog

* add ansible-galaxy user documentation for new options

Co-authored-by: Matt Martz <matt@sivel.net>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Martin Krizek <martin.krizek@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Andy Mott <amott@redhat.com>
Co-authored-by: John R Barker <john@johnrbarker.com>
3 years ago
IronTooch 65987e86a9
Added package reference for Debian to resolve error (#76876) 3 years ago
Vladimir Botka 5448661aec
Update 'Ansible and BSD' section 'Setting the Python interpreter'. (#76825) 3 years ago
ChunPanYung 0ca19a5b73
Update windows_winrm.rst (#76835)
Co-authored-by: Jordan Borean <jborean93@gmail.com>
3 years ago
Stephen Lawrence 2bd074b486
doc: fix Jinja2 doc link templating playbook (#76889)
Signed-off-by: Stephen Lawrence <stephen.lawrence@renesas.com>
3 years ago
Sandra McCann a5283d67ee
add quoted examples (#76858) 3 years ago
Syed Ali Haider 6bca0a5dc2
docs: add fqcn to module examples (#73546)
Co-authored-by: Felix Fontein <felix@fontein.de>
3 years ago
darran-c fdf12542b2
Fix typo in task name (#76642) 3 years ago
Alicia Cozine 67e5649a26
Adds documentation about when/why to use roles (#76560)
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
3 years ago
Jordan Borean 7dd22b8b4b
Update Windows host requirements (#76582) 3 years ago
Simon Monai 5db1d11c19
Replace "Encrypt" with "Hash" for prompt documentation (#76584)
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
3 years ago
Jon "The Nice Guy" Spriggs 47e2a26959
Update playbook_tests with type testing (#72732) 3 years ago
Jacob McGill ee777567bc
Update intro_inventory.rst (#76340) 3 years ago
Benoît Geeraerts 8a562ea14a
Resolves #76449 Misplaced added version info (#76539)
`.. versionadded::` are coming right after the section tittle, and was misplaced here
3 years ago
Sloane Hertel 5b2334983c
Fix more 'playbook'/'play' conflation (#76387) 3 years ago
azrdev fd4460c1e4
docs/best_practices: all contained vault passwords required when using inventory (#75976) 3 years ago
Aine Riordan 90de24da7b
Docs: Link to valid data types for role parameters (#76276) 3 years ago
Daniel Goldman be2bd2f1af
Documentation for other types in collection `requirements.yml` (#75872) 3 years ago
Vicente Jimenez Aguilar a1236a582c
Stop using "checksumming" instead of "encrypting" in the docs (#76168)
* Hashing is not encrypting

All encryption systems have a formal inverse function to decrypt
A hash is a one way function without inverse by definition

* Update docs/docsite/rst/user_guide/playbooks_filters.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>
3 years ago
Paul e84d660140
Update playbooks_tests.rst (#76047) 3 years ago
Brian Coca ff792d252e
Docs: dash - character invalid in playbook names in collections(#75891)
* collection playbooks, note no -
fixes #75890
3 years ago
fermin 9eeaf1c5b5
Docs - add code-block:: wrapping for playbooks filter doc (#75953)
* Add code-block
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Chris Hepner 67c12fc4eb
Docs - Fix "kubernetes.core" typos in code snippets (#75930)
Replace "kuberernetes.core" with "kubernetes.core" in filter examples.
3 years ago
Abhijeet Kasurde 1ea74f4dd6
Misc typo fix (#76008)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Miroslav Brabenec fa4a92f221
Docs: Add code-block:: to examples in ipaddr filters doc(#75951)
* Add code-block elements to playbooks_filters_ipaddr
* Add punctuation to lead-in sentences for code blocks
3 years ago
marie 2a3aa66fbd
docs - wrap examples in code-block:: in sample setup (#75964)
* docs: Use code-block to format code in sample setup
Fixes #75905
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Tim Pogue 4444692436
Docs: add code-block:: to playbook variables doc in user guide(#75985)
* update code-block formatting changes.
3 years ago
Midhun R Nair 6bf65f6246
Docs - Added code-block:: wrappers in playbook tests doc (#75952) 3 years ago
Matěj G 6319a0f415
docs - Wrap examples in code-block:: in loops guide (#75916)
* docs - Use code-block to format examples in loops guide
Resolves #75900
3 years ago
Matěj G d6dbc1a26f
docs - Change :: to code-block:: in error handling guide (#75978)
Fixes #75908
3 years ago
Alfred Tso 4d8a724071
docs - Replace :: with code-block:: in playbooks_conditionals doc (#75965)
Fixes #75906
3 years ago
NarayanAdithya d26ff4e376
Docs: changed :: to code-block:: in 9 files (#75994)
* Fixed 9 files in user guide
3 years ago
Joshua Ford 221c7373db
docs - Add code-block to code examples in playbooks_strategies.rst (#75960)
Fixes ansible#75911.
3 years ago
Joshua Ford fd346565d3
docs - wrap examples in code-blocks in playbooks_vars_facts.rst (#75961)
Fixes ansible#75912.
3 years ago
Holger Dörner 37eefb47c5
Docs: Add code-blocks to examples in Windows-WinRM guide (#75974)
Co-authored-by: Holger Dörner <h.doerner@bitexpert.de>
3 years ago
Holger Dörner 84ec976378
Docs: Add code-blocks to Playbooks-Delegation in user guide(#75973)
Co-authored-by: Holger Dörner <h.doerner@bitexpert.de>
3 years ago
Tamas Szabo d0edf69fe0
docs: code-block wrapping for playbooks_debugger.rst (#75968)
* code-block wrapping for playbooks_debugger.rst #75919
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Sanjula Madurapperuma cd540544fd
Docs: add code block elements in user_guide/playbooks_async.rst (#75947)
* Fix for code block
3 years ago
Angel Mendez fffa9412f4
Docs: add code blocks elements for user_guide/vault.rst (#75963)
* feat:(docs) add code blocks elements for user_guide/vault.rst
Addresses issue #75921
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Tamas Szabo 71811407c5
Docs: code-block wrapping for playbooks_checkmode.rst #75925 (#75931)
* code-block wrapping for playbooks_checkmode.rst #75925
* Fixes typo in previously introduced code-block
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Tamas Szabo 22a540e109
Docs: Code-block wrapping for playbooks_startnstep.rst #75934 (#75943)
* Code-block wrapping for playbooks_startnstep.rst #75934
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
nicpayne713 5c4bbed2de
Docs: Add code-blocks to user guide doc (#75928)
* Add code-block elements to 5 examples

* Add :
3 years ago
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