Commit Graph

2577 Commits (5c4bbed2de4d881a1c9077510cdf1cc228302c59)

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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
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
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 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
Toshio Kuratomi fbe5f9fd7d
Update the porting guide for a new ansible version (#74752) 4 years ago
Vincent Rubiolo 5266e1e1ab
Fix broken Jinja website links (for tests) (#74746)
The various links to the Jinja website were broken, this commit fixes them.
4 years ago
Vincent Rubiolo 8d7a5d9cb3
Fix broken Jinja website links (#74745)
The URLs to the Jinja website have moved, seemingly because of the renaming from `master` to `main` (hence from `master` to `latest` in the doc). This commit fixes that.
4 years ago
Brian Coca 5333e4138c
note about adhoc delegate_to hosts (#74687)
* Update docs/docsite/rst/user_guide/playbooks_delegation.rst
4 years ago
Abhijeet Kasurde 2f87b8760d
docs: Add a note about ansible_date_time (#74636)
* For long-running playbooks, discourage users from using
`ansible_date_time`. Use `pipe` or `now` as an alternative.

* Review comments

Fixes: #22561

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Lydie bf9944266c
Issue 73792: Removed mentions of R() and M() (#74708)
* 73792: Removed mentions of R and M
4 years ago
Abhijeet Kasurde 39df263f1a
intro: Add a note about current user (#74638)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
m0nt3cr1st0 25de07946c
Fix typo on roles documentation (#74696)
##### SUMMARY
Small fix on the roles directory structure documentation

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Kelly Brazil 91212b2008
Add JC filter plugin example (#74563)
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Jill R fa15d35cb1
Update AWS guides with new SDK and Python requirements (#74585)
The 2.0 collection releases will introduce new Python requirements
and a new SDK support policy
4 years ago
Mark Mercado 1906d75907
Adding DigitalOcean cloud support to ansible-test (#74222) 4 years ago
Alicia Cozine 829c9c3d46 updates jinja filters links with new pattern for Jinja 3.x documentation 4 years ago
Toshio Kuratomi 8f2c0e0574
Update the porting guide for ansible-3.4.0 (#74664) 4 years ago
Abhijeet Kasurde 79e12ba98e
docs: Add a note about `crypt` (#74640)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
David Shrewsbury 8fb54885bf
Role argspec: allow new argument spec file (#74582)
* support separate role argspec file in ansible-doc

* support separate role argspec file in ansible-core

* support both .yml and .yaml extensions on argspec file in ansible-doc

* fix filename building bug and rename some argspec files to test variations

* use yaml extensions from constants

* add superfluous meta/main.yml files to tests

* Update lib/ansible/cli/doc.py

Co-authored-by: Sam Doran <sdoran@redhat.com>

* update docs

* ci_complete

* add changelog and allow for main.yml variations

* add collection role testing

Co-authored-by: Sam Doran <sdoran@redhat.com>
4 years ago
Andrew Klychkov 5463cbb841
Docs: communication.rst - add ansible-community to the IRC channel list (#74570) 4 years ago
Felix Fontein a6cc508822
Update the module lifecycle document to also cover plugins and collections (#74413)
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Joseph Jacobs dcb807dea7
Update cli_parsing.rst (#74555)
Bad indent in an example
4 years ago
Matt Clay 8bd599d048 Change Shippable refs in docs to Azure Pipelines. 4 years ago