Commit Graph

3349 Commits (02e98810a9fa895b8215e864f11e537cbd125bae)

Author SHA1 Message Date
Sandra McCann 61bd779335
add core roadmaps to ansible docs (#76818)
* add core roadmaps to ansible docs
* make older roadmaps also show up
3 years ago
Sandra McCann 5a69023941
remove ansibot from collection docs (#76817)
* remove ansibot from collection docs
* Update docs/docsite/rst/community/collection_development_process.rst
Co-authored-by: Felix Fontein <felix@fontein.de>
3 years ago
Sandra McCann cfe4bdc1b9
Create separate core vs collection contributor guides (#76764)
* updated core guides
* ansible package docs guides
* add core guide to Ansible docs
* Update docs/docsite/rst/community/maintainers.rst
3 years ago
David Moreau Simard e33e7233d0
docs: Update porting guide for ansible 5.2.0 (#76746) 3 years ago
Sandra McCann 665e3dc629
remove outdated note on limitations of R() in module docs (#76736) 3 years ago
Mario Lenz 01ba6d4a45
Fix C&P error (#76673) 3 years ago
Felix Fontein c53e6d94e9
Use antsibull 0.40.1 for docsite build (#76675) 3 years ago
Or Bin a1d0e60703
Fixed documentation: "[a] ini file" -> "an ini file" (#76627) 3 years ago
darran-c fdf12542b2
Fix typo in task name (#76642) 3 years ago
Or Bin aa4f23dc97
Fixed documentation: "do not needed -> do not need" (#76617) 3 years ago
David Moreau Simard e2d1dbbdc5
Docs: update porting guide for ansible 5.1.0 (#76595) 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 4c738b08b4
Add docs on Windows module util requirements (#76583) 3 years ago
Matt Martz 8a4090f749
Do not format the choice as a definition list for non-mapping values (#76568) 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
Abhijeet Kasurde 601d66c7e5
k8s: Migrated scenario guides to collection (#75249)
Kubernetes scenario guides are moved to
``kubernetes.core`` collection.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Jacob McGill ee777567bc
Update intro_inventory.rst (#76340) 3 years ago
Kian Meng, Ang e5967c02f5
Fix typos in docs (#76526) 3 years ago
David Moreau Simard 6ee58056da
docs: Update porting guide for ansible 4.10.0 (#76559) 3 years ago
Sloane Hertel 146a4bcd0d
Fix docs for installing from a git repo (#76350) 3 years ago
Dan Kolepp 9dac51f25a
Update special_variables.rst (#76360) 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
Edward Hilgendorf d0de3d3dc2
change keyword return to results (#76515)
value is getting associated to python keyword return
3 years ago
Sandra McCann 0cec4d1cfc
remove aws from the azure note (#76518) 3 years ago
Sandra McCann 0df60f3b61
per marketing request - add note for AAP on Azure availability (#76512) 3 years ago
Sandra McCann bccfb83e00
add intersphinx mapping for Ansible 5 (#76470)
* add intersphinx mapping for Ansible 5

* add the other files
3 years ago
Andrew Klychkov 60d094db73
Docsite/dev_guide: add note about ansible-test utility installation ways (#76128)
* Docsite/dev_guide: add note about ansible-test utility installation
* Add link to Testing Ansible page
3 years ago
Martin Krizek 3fe42e106c
Remove finalize from globals (#76439) 3 years ago
Sviatoslav Sydorenko 82ff7efa94
Fix how/what+look/like grammar in dev process doc (#76410) 3 years ago
Sloane Hertel 5b2334983c
Fix more 'playbook'/'play' conflation (#76387) 3 years ago
David Moreau Simard bf1e1d286d
docs: Update porting guide for Ansible 5.0.1 (#76444) 3 years ago
David Moreau Simard 1d1597ffd9
Docs: Update porting guide for Ansible 5.0.0 (#76404) 3 years ago
Sandra McCann 862a2a3599
set latest Ansible version to 5 (#76304) 3 years ago
Sandra McCann a1205d52ce
update release and maintenance for Ansible 5 (#76301) 3 years ago
David Moreau Simard b9b69c1135
Docs: Update porting guide for ansible 4.9.0 (#76363) 3 years ago
David Moreau Simard 0afc0b8506
Add a link to the Ansible 5.x changelog (#76352)
The 5.x changelog is available, add a link to it.
3 years ago
nemobis 0360728b7f
Fix typo in docs for "globbing" (#76324)
Constent with the rest of the documentation including fileglob.
3 years ago
Sandra McCann c379e61b8b
Update docs build requirements to most recent versions of dependencies (#76283)
* align requirements files to more recent versions

* bump up to latest antsibull

* update sphinx in rstcheck requirements

* update to dependency versions that sphinx 4.2 pulls in

* use same no-cap spelling
3 years ago
Matt Martz 04698b0c41
Add porting guide entry for fetch_url change in behavior (#76314) 3 years ago
Matt Clay bb63c97c16
ansible-test - Update import test and sanity requirements. (#76308)
* Add script to freeze sanity requirements.
* Declare sanity test requirements and freeze
* Use pinned requirements for import.plugin test.
* Expand scope of import test for ansible-core.
* Add ignores for galaxy import errors.
* Update test-constraints sanity test.
3 years ago
David Moreau Simard d0ec236d4a
Update porting guide for Ansible 5.0.0b2 (#76303) 3 years ago
azrdev fd4460c1e4
docs/best_practices: all contained vault passwords required when using inventory (#75976) 3 years ago
Felix Fontein a734da5e82
Restore documentation on M() and R() (#76284)
* Undo most of bf9944266c, add note on where R() does not work.
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
3 years ago
Felix Fontein fe77bc9e3c
Validate some markup in documentation in validate-modules (#76262)
* Validate some markup in documentation.

* Add changelog fragment.

* Use urlparse instead of URL regex.

* Document new error code.

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
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
David Moreau Simard 55dc75b8c8
Update porting guide for Ansible 5.0.0b1 (#76263) 3 years ago
Sandra McCann 22eb4a9ce0
Remove edit on github from collection pages (#76259)
* remove main index page from Edit on Github
* remove all collection index pages from Edit on Github
3 years ago
Mark Chappell f6ec773e6e
Update porting guide Python 2.7+ wording. (#76258) 3 years ago
Sandra McCann b16d5ff7a7
set 2.12 to latest (#76191)
* set 2.12 to latest
* add 2.10 back
3 years ago
Sandra McCann d0c1e5a46d
Update release/maint page for 2.12 release (#76205)
* make changelogs more visible and fix a broken link

* add 2.12 changelogs

* add eol column
3 years ago
Felix Fontein a861cb5607
ansible-core 2.12 dropped support for galaxy.yaml. (#76179) 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
Sebastian Wiesinger 1b43298316
Update dev guide for vars plugins in collections (#75861) 3 years ago
Sandra McCann 636b317a4f
update backport instructions for 2.12 (#76209) 3 years ago
David Moreau Simard 2fd26ea35a
docs: Update porting guide for Ansible 5.0.0a3 (#76201) 3 years ago
David Moreau Simard 2de7c59930
docs: Update porting guide for Ansible 4.8.0 (#76197) 3 years ago
Sandra McCann fdc3348859
Docs: Add skeleton roadmap for Ansible 6 (#76130)
* add skeleton roadmaps
* fix spacing
* correct link
* remove skeleton
3 years ago
Paul e84d660140
Update playbooks_tests.rst (#76047) 3 years ago
mscherer 2955ff57a7
Fix module name (#76058) 3 years ago
Matthew Donoughe d17f9a523d
Docs: fedora32 is no longer supported (for integration tests) (#76159) 3 years ago
Aine Riordan e0e6464873
Docs: Fix text for contributing to collection link (#76174) 3 years ago
Richard Megginson 360a3d2431
Clarify that "requires_ansible" means Ansible Core (#76100)
Clarify that the `requires_ansible` field in meta/runtime.yml refers to the version of Ansible Core (ansible-core), not any package called "ansible" e.g. https://pypi.org/project/ansible/
3 years ago
Jonas I. Liechti 0b0acef423
bug fix: using non-FQDN in plugin choices fails plugin name verification (#75991)
* enable both non-FQDN and FQDN plugin name
* add info about matching requirement of plugin name in config and plugin source file
3 years ago
Sean Cavanaugh 3a9e42cfde
Docs: Change API endpoint for hub to console.redhat.com in user guide (#76080)
The cloud.redhat.com has changed to console.redhat.com
3 years ago
Matt Martz 19c8790251
2.13 schedule (#75843) 3 years ago
Brian Scholer 4abc669c24
Update module documentation about ref links (#76088)
* Update module documentation about ref links
3 years ago
Martin Krizek 26707a3c6b
Heisen jinja2_native (#75587)
* Use NativeEnvironment for all templating

ci_complete

* Keep Templar.copy_with_new_env for backwards compat

* Mention that AnsibleUndefined.__repr__ changed in the porting guide

* Templar.copy_with_new_env backwards compat

* ci_complete
3 years ago
Nedko Hristov 6b8ed23926
Update `argcomplete` install via apt command (#76139)
To install `argcomplete` on Ubuntu 21.10 we need to update the install line to use Python3
3 years ago
Matt Martz 9b4f9e9fd3
Drop python2.6 support in module execution (#76106) 3 years ago
Sandra McCann 835fe71828
Docs: fix link to 2.12 changelog (#76091) 3 years ago
David Moreau Simard 43d09710c8
Update porting guide for Ansible 5.0.0a2 (#76083) 3 years ago
Sean Cavanaugh 817e1045bb
Update network_resources.rst (#76040)
* Update network_resources.rst

I am not sure a fully qualified URL should be here... but teach me great documentation gods

* Change platform index external link to internal ref

Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
3 years ago
Deric Crago 9a0fe18915
allow override of PYTHON variable (#76023) 3 years ago
Matt Clay fae0cf4c51 Remove unofficial packaging.
Unofficial packaging should be maintained externally since
it is not tested in CI or used in the official release process.

Maintainers of unofficial packages are better equipped with the necessary
expertise and testing resources to support alternative packaging.
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
Deepansh 64506c7d15
Docs: Change note for rackspace cloud guide (#75898)
* Fix rackspace cloud guide docs
* Fix syntax error
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
David Moreau Simard 93a6299cd3
docs: Update porting guide for Ansible 4.7.0 (#76034) 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
Paul Capron afbef70bad
documenting_modules_network.rst: Add missing space (#75972) 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
Sandra McCann 8e77943a97
remove fest banner (#75901)
* remove fest banner

* fix nit
3 years ago
Tamas Szabo 801db758d3
code-block wrapping for playbooks_best_practices.rst #75937 (#75939) 3 years ago
Alicia Cozine 9a4346bae3
Docs: Moves the AWS Scenario Guide out of the main docs (#74704)
* removes AWS scenario  guide, moving to collection

* first attept to replace TOC entries

* not sure what I did, but saving it

* updates TOCs to reflect new location of aws guide

* reinstates original page as a stub

* adds links to new location for AWS guide, updates header

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
3 years ago
Toshio Kuratomi 0c8b62b527
Update the porting guide for a new ansible version (#75893) 3 years ago
Ankur H. Singh 000ae00cfd
Docs: Clarify adding newlines in YAML folded block scalar (#75875)
* Removed translatable words from code blocks

##### SUMMARY
Removed translatable words from codeblocks as per #59449

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* Maintaining intend as well as clearity

* Preserving "save_as" as the key

* showing equivalence and keeping same context
3 years ago
Samuel Gaist 19fce0527a
docs - Use code-block to format code examples in Developer Guide (#75849)
Fixes #75663
3 years ago
RamblingPSTech 8988f8ab5d
Corrected mytask.yml file name (#75860) 3 years ago
Toshio Kuratomi 20904c2fb6
Move ansible-5.1 to 2021-12-21 (#75865)
We moved the target date for ansible-5.0 one week back so there's now
time to do 5.1 before the holidays start.
3 years ago
Samuel Gaist 4aede377d2
docs - Use code-block to format code examples in Community Guide (#75847)
Fixes #75675
3 years ago
Samuel Gaist 4d398ca3a4
docs - Use code-block to format examples in Network Guide (#75850)
Fixes #75676
3 years ago
Matt Davis bb59d9afe9
bump devel to 2.13 (#75833) 3 years ago
Sandra McCann 927ffe26b7
Docs: add install link for windows (#75811) 3 years ago
Matt Martz a9bd8b6cff
No Ansible Engine (#75812) 3 years ago
Felix Fontein 8643db5ac3
Bump antsibull version to get support for attributes and CLI options (#75787)
* Bump antsibull version to get support for attributes and CLI options.

* Include fix for attributes.

* Include fix for rst_epilog collision and for #75799.
3 years ago
Amin Vakil 2934c4f710
ansible is now ansible-core in AUR too (#75145) 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
Jonas I. Liechti e021a65403
using FQCN also for ansible.builtin collection (#75644) 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
Brian Scholer f4cdea9645
docs - add some info on plugin option source precedence (#75754)
* docs - add some info on plugin option source precedence

##### SUMMARY
Add some clarity on precedence, especially from sources of the same type.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr

* update RST formatting

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

Apply review suggestions

Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>

Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
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
Matt Martz 65b5472ad1
Update roadmap to indicate branching happens at feature freeze (#75777) 3 years ago
Toshio Kuratomi a5e7ed0cc5
Update ansible porting guide for 4.6.0 release. (#75752) 3 years ago
Thomas Sjögren 57359d0174
use passlib default if `password_hash` option isn't set (#75043)
* add changelog fragment
* password_hash|length == 120
* mention the new default bcrypt format in the porting guide
3 years ago
Matt Martz 724800cd3f
Python 3.8 Controller Minimum (#74013) 3 years ago
Matt Clay 4ea8d9a782
ansible-test - split controller/target testing (#75605) 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
Rick Elrod 61f5c22551
Remove (only) user-facing use of ANSIBLE_ASYNC_DIR (#74249)
Change:
- Remove only user-facing use of ANSIBLE_ASYNC_DIR.
- Remove two comments saying to change things that, apparently, we
  aren't going to change...

Test Plan:
- ci_complete

Tickets:
- Fixes #74139
- Fixes #74138
- Refs #74226

Signed-off-by: Rick Elrod <rick@elrod.me>
3 years ago
Chris Hambridge 1353678f23
Enable ansible-galaxy to specify client id override with Keycloak Token (#75601)
* Enable ansible-galaxy to specify client id override with Keycloak Token

* Specify ability to provide override of client_id

* Test client_id can be configured for individual servers

* Add issue link to changelog

* Document client_id as a config option and add an example

Co-authored-by: s-hertel <19572925+s-hertel@users.noreply.github.com>
3 years ago
Matt Clay 54a795896a
Integration test and sanity index generation fixes. (#75731)
* Fix test usage of `which python`.

Also use `command -v` instead of `which` where needed.

* Fix testing_formatter.sh file checking.

The index is longer expected to exist when generating it.
The generation script is run with `set -eux`.
3 years ago
Sloane Hertel f0d43cfffc
Document validate_certs option for Galaxy server configuration (#75728)
Added in #75710
3 years ago
Aine Riordan 2346f93961
Docs: Fix section header notation in Style Guide (#75720) 3 years ago
Aine Riordan 17122edfc5
Docs: Fix section header notation in Developer Guide (#75721) 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
Jon Pugh b1527dcf63
Small typo in vars plugin example. (#75702) 3 years ago
Matt Martz 208014422d
Fix markdown links that were errantly formatted as rst (#75697) 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
Matt Clay de01db08d0
pip - Use pip from the current Python interpreter. (#75634)
* pip - Use pip from the current Python interpreter.

If `executable` and `virtualenv` were not specified, and
the `pip` Python module is available for the current interpreter,
use that `pip` module instead of searching for a `pip` command.

* Add comment about needing `__main__` to run `pip`.

* Fix unit test.

* Add porting guide entry.

* Update changelog to match porting guide description.

ci_complete
3 years ago
Brian Coca 90518d8bb5
added vault/unvault docs (#75140) 3 years ago
Brian Coca 8af54a0355
Added info about playbooks for collection (#75535)
*
3 years ago
Alicia Cozine 2c67954f9b
Docs: adds warning about utf-8 in templates (#75504) 3 years ago
Toshio Kuratomi 0ef9b9ee49
Update the porting guide for a new ansible version (#75610) 3 years ago
Greg Sutcliffe 388760eef6
Docs: Add more Matrix documentation (#75588)
* Refs #75478 - On the communicating page, add Matrix links to first 4 chat spaces, improve introduction, update working groups with Matrix and IRC locations, add a link to the community FAQ, add localised community translations, and remove Lightbulb room, the GitHub project has been archived

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
3 years ago
Sloane Hertel e5f6c2d141
Fix rekey_on_member when key is undefined (#75131)
* Fix rekey_on_member when key is undefined and add a test case

* Add documentation about error handling in filter and test plugin sections
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
Alicia Cozine e35e8ed2ec
makes Fest link from docs trackable (#75594)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
3 years ago
Suhas Bharadwaj 747789787b
added a caveat to say check individual module documentation for compatibility (#75582) 3 years ago
Toshio Kuratomi d83acc1c4c
Slip ansible 5 release [alternative] (#75529)
* Fix link to core roadmap

* Slip ansible 5 release to account for ansible-core slip.
3 years ago
Deric Crago bb2e45873c
updated 'Installing Ansible on Debian' details (#75567) 3 years ago
Toshio Kuratomi a661e44f6e
Update the porting guide for a new ansible version (#75457) 3 years ago
Abhijeet Kasurde 1dc495405f
Added missing colon in note (#75465)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Matt Clay 99a79e1969
ansible-test - Move code from _data to _util. (#75495)
* Update paths to match relocated files.
* Update ansible-test symlink paths.
* Update path classification.
* Update MANIFEST.in
* Update sanity test context paths.
* Update sanity ignores.
* Update shebang sanity test.
* Update configure-remoting-ps1 sanity test.
* Update BOTMETA.yml to reflect new paths.
* Update paths in collection loader comments.
* Update Makefile for ansible-test.
* Update docs.
* Add changelog fragment.
3 years ago
Sandra McCann 394860560a
remove core docs build warnings (#75496) 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 d652b19e11
Docs: clarify dir names for local plugins (#75157)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
3 years ago
Alicia Cozine 3c3e30a610
Docs: Add Matrix as a chat option (#75406) 3 years ago
Sandra McCann dc6878007b
Add AnsibleFest banner (#75476)
* add AnsibleFest banner

* fix nit
3 years ago
Jonas DOREL 39605cdcce
docs: missing colon for a note (#75453) 3 years ago
Felix Fontein 0055a328b3
Also allow .yml. (#75439) 3 years ago
Jake Jackson 377becd609
add diversity working group to list of working groups (#75228) 3 years ago
Andrew Klychkov 61b81bcd10
Docsite: improve reporting_bugs_and_features.rst (#75234)
* Docsite: improve reporting_bugs_and_features.rst

* Add clarification
3 years ago
Ikko Ashimine c127843698
Fix typo in porting_guide_4.rst (#75442)
paramater -> parameter
3 years ago
Alicia Cozine d9d98740f2
new antsibull supports breadcrumbs toggle (#75424)
* new antsibull supports breadcrumbs toggle

* let antsibull versoin float free

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
3 years ago
Ikko Ashimine 1b95b1e7a4
Fix typo in developing_plugins_network.rst (#75382)
extention -> extension
3 years ago
Sam Doran fa7482c63a
Change interpreter discovery defaults to silently prefer Python 3 (#75049)
Push /usr/bin/python to almost the bottom of the barrel. This makes the strategy to prefer
specific versions of the "mystery meat" version.

* Change INTERPRETER_PYTHON default to 'auto'
    Change description to match change in behavior.
    Change deprecation message to a warning.

* Update docs
* Add porting guide entry
* Update unit tests
* Update integration test
* Allow INTERPRETER_PYTHON_FALLBACK to be configure using a variable
* Prefer platform-python above other Python 2 interpreters
* Add Python 3.10 to the list of interpreters
3 years ago
Brian Scholer 7d2b80371d
fix quick typo (#75373)
fix a small typo introduced in #75343
3 years ago
Sergey 549d258c30
Update guide_aws.rst (#75375)
Update Links in AWS Guide.
3 years ago
Martin Krizek 6607051b75
docs: clarify regex_search return value (#75343) 3 years ago
Matt Martz e2b0592f64
Update 2.12 roadmap for schedule change (#75350) 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
Alicia Cozine 0e9d1ab1cc
incorporate minimalism feedback on distributing collections page (#75266) 3 years ago
Ashwini Mhatre d016499dcd
Update network user guide to point to ansible.utils.cli_parse module and add docs for validate plugin (#75104)
* Update network user guide to point to ansible.utils.cli_parse module as ansible.netcommon.cli_parse is deprecated from ansible.netcommon 2.0.0 release
3 years ago
Toshio Kuratomi 2a759cbe20
Update the porting guide for a new ansible version (#75292) 3 years ago
David Moreau Simard 8372f34b67
docs: Update description and URL for the ara repository (#75283)
The repository has moved from /openstack/ to /ansible-community/ some
time ago.
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
Akira Yokochi 9af0d91676
fix option name for parsed (#75229) 3 years ago
Andrew Klychkov f8bb182589
developing_collections_testing: Fix formatting (#75233) 3 years ago
Toshio Kuratomi dc25197c15 Allow passing extra arguments to the build-ansible.py commands
This is useful for testing and debugging.  You can use the extra
arguments to specify a local directory for the collection list, for
instance.
3 years ago
Christian Adell 3ba2243ba3
Replace self.module by my_module (#75196)
While implementing basic Ansible module testing I realised that the `self.module` used in some places is not actually a thing, and I changed to `my_module` to make it work as I understand it was expected.
3 years ago
Lydie 1e00099753
Removed Galaxy banner (#75163) 3 years ago
Abhijeet Kasurde 21ba2967de
Misc typo fixes (#75188)
Changed `Previouslly` to `Previously`.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
3 years ago
Toshio Kuratomi 23a84902cb
Update the porting guide for a new ansible version (#75143) 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
Sviatoslav Sydorenko d75d9443fc
Bump sphinx_ansible_theme to v0.7.0+ (#75059)
This version relies on an external lib implementing lexers and styles.
That lib pulls in proper Pygments version so this patch also drops it
from direct requirements.
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
Dirk Schäfer 29592aa3d4
Update YAMLSyntax.rst (#75113)
fix yaml-syntax example
3 years ago
Alicia Cozine 5d3d9ad8be
docs: adds Ansible 5 roadmap (#75075) 3 years ago
Sandra McCann ea0ba7bf30
update terminology based on recent IBM Style Guide word list (#75089) 3 years ago
Sandra McCann f05bcf5693
update intersphinx links for Ansible 4 (#75099) 3 years ago
Felix Fontein 47c50c38bb
Use antsibull-docs devel for devel docs (#74988)
* Require antsibull 0.34.0.
* Remove Makefile comment about the devel docs building only the core
(formerly base) docs; the behavior was updated in ccbfdec334
Currently 'make coredocs' builds core-only docs; 'make webdocs' builds the full docs even on the devel
branch

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
3 years ago
Felix Fontein 2c0f050b4f
Use antsibull sphinx extension (#73170)
* Use antsibull sphinx extension.

* Require antsibull 0.34.0.
3 years ago
Alicia Cozine 58f26388be
Update docs requirements list (#74956)
* removes upper bound on sphinx version
* updates versions of docs build dependencies, adds known good requirements file
* adds instructions for using known_good_reqs file
3 years ago
Chandler Swift 3a8fc2d2be
Syntax fixes for docs (#75086) 3 years ago
Gonzalo Arreche 0f7f4e7b61
Add comma on role creation docs (#75064)
Adding a comma to make the sentence simpler to read.
3 years ago
Andreas Olsson aedc82da98
Clarify Vault password client naming requirements (#75060) 3 years ago
Alicia Cozine a7be495b7b
Update plugin docs (#75050)
* edit existing plugin pages, headings, and links
3 years ago
Nathaniel Case ad203a7dbd
Add page describing terminal plugins to docsite (#75066) 3 years ago
Sviatoslav Sydorenko ec408a69f1 🔥 Drop unused `core.css` file
This is a forgotten leftover from #74318 that should've been removed
earlier.
3 years ago
Sam Doran 4e608c02fb
Add changelog and porting guide for _remote_checksum() deprecation (#75035)
I forgot to add it with the PR that made the changes.
3 years ago
Brian Coca 5a5a1882d4
Added FAQ entry for complex validation needs (#74707)
* Added FAQ entry for complex validation needs

* updated validate docs

* fix

* longline

* Apply suggestions from code review

Co-authored-by: Sandra McCann <samccann@redhat.com>
3 years ago
Brian Coca 08fc43f3ea
document keywords (#74046)
* document kewyords

  also minoir tweak to local action/connection

* made corrections
3 years ago
Brian Coca 6fd61bb19f
add option def/handling to lookup (#74495) 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
David Shrewsbury 2387ce311f
remove reference to container ML (#75014) 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
Felix Fontein 7f6edd78f9
Move Docker scenario guide to community.docker. (#74736)
The scenario guide has already been added to community.docker in
ansible-collections/community.docker#140
3 years ago
David Shrewsbury 97acb0f470
role argspec - tag role argspec validation task with 'always' (#74994)
* update tag docs
3 years ago
Toshio Kuratomi 576e0f6404
Update the porting guide for ansible 4.1.0 (#74965) 4 years ago
Felix Fontein 81ad125aa6
Fix name of subkey. (#74939) 4 years ago
Yanis Guenane d45c2cec55 Localization: Import first set of translated files 4 years ago
Sviatoslav Sydorenko 346c7a765d
Use `sphinx_ansible_theme` Sphinx theme in docs (#74318) 4 years ago
Abhijeet Kasurde d9001f8fd0
Fix intro docs (#74843) 4 years ago
Felix Fontein acf09e56a2
Update inventory script references from c.g to ansible-community/contrib-scripts. (#74905) 4 years ago
twalsh-uod 3d8feed2cf
Update playbooks_filters.rst (#74911)
Fix typo: 'sting' -> 'string'
4 years ago
Alicia Cozine 33924d7e8d
gives each banner a unique div ID (#74907)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Alicia Cozine 605b1a1c5c
documents community 'extra docs' option in collections (#74886)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
4 years ago
Alicia Cozine 62fc4ad8da
adds banner for GalaxyNG survey (#74889) 4 years ago
Abhijeet Kasurde 8d39332c3d
plugins: specify plugin types for get_option (#74799) 4 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.
4 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.
4 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>
4 years ago
Boris Korzun 99a983c92c
config: small typo fix (#74845) 4 years ago
Rick Elrod 2ad10ffe43 hostname: Make strategies consistent, drop py2.4
Change:
- Make strategies behave consistently and return the empty string
  instead of "UNKNOWN" (or "temporarystub") for the "before" value if
  the permanent hostname file does not exist or could not be read.
- Switch to `with open()` instead of annoying exception handling code
  (which was wrong and leaked file handles in several places). This
  drops Python 2.4 support for this module.
- Updated porting guide since users could be relying on these former,
  inconsistent values.

Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
Jill R 16e1172292
Update docs for cloud maintained collections (#74373)
- AWS has moved to Zuul CI
- Kubernetes collection has been renamed
- OpenShift/OKD collection was missing
- ansible.windows is on Zuul and Azure Pipelines
- ansible.posix is on Zuul

Signed-off-by: Jill Rouleau <jill.rouleau@bespokess.com>
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Abhijeet Kasurde a61821b626
misc typos (#74724) 4 years ago
Sandra McCann ef0055a806
add anchors (#74825)
LGTM @samccann
4 years ago
Sean Cavanaugh 88d67b00f8
Update developing_collections_distributing.rst (#74820)
It is not clear that you can publish without configuring an ansible.cfg.  The `--token` can be displayed with the `ansible-galaxy collection publish -h`
4 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>
4 years ago
Sam Doran 12f4b0db04
Fix typo in porting guide (#74812) 4 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.
4 years ago
Sean Cavanaugh 20ef733ee0
Update network_resources.rst (#74810) 4 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>
4 years ago
Chander G 888fea69e5
Fix small typo in playbook_filters doc (#74762)
Move versionadded to next line to render correctly.
4 years ago
Sandra McCann cd8e3a2208
update conf.py (#74751) 4 years ago
Sandra McCann 138dfa4549
add release note and mark 3 unmaintained (#74749) 4 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
4 years ago
Felix Fontein 4bf420706b
Improve and extend changelog logs (#74106)
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago