Commit Graph

2742 Commits (609cba5017f94c91a6951ce28b7acda9c89c4532)

Author SHA1 Message Date
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
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) 3 years ago
Felix Fontein 81ad125aa6
Fix name of subkey. (#74939) 3 years ago
Yanis Guenane d45c2cec55 Localization: Import first set of translated files 3 years ago
Sviatoslav Sydorenko 346c7a765d
Use `sphinx_ansible_theme` Sphinx theme in docs (#74318) 3 years ago
Abhijeet Kasurde d9001f8fd0
Fix intro docs (#74843) 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