Commit Graph

2949 Commits (47c50c38bb68f65f916270a87c088bfb3dd3db48)

Author SHA1 Message Date
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
Alicia Cozine 8c34eaa69f Jinja intersphinx should point at 3.0; other updates 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
Sandra McCann 7195367635
update docs copyright (#74643) 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
Sloane Hertel aea0c4dd1b
Fix inventory cache prefix typos (#74523)
* Fix section for inventory cache prefix

* Redirect general config inventory cache options to inventory plugin documentation

* Update the template to fix the docs-build error

* removes 'default' entries for config settings with default: ''

* single backticks => italics, double backticks => code

* use 'Default: ~' to match other entries that have no default setting

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Alicia Cozine b765d3799b
update backporting instructions to reflect new latest stable branch, some edits (#74512)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Matt Clay a30c55f68a Remove deprecated `common.removed` module_util.
Tests have been updated to reflect its removal as well.
4 years ago
Toshio Kuratomi 112b175f17
Update the porting guide for a new ansible version (#74490) 4 years ago
Christian Fetzer f194108a26
docs: Improve documentation for regex_search,replace,findall (#74368)
Improve the documentation for regex_search by adding a few more
realistic examples such as showing how to extract only parts of a
string by using regex groups.

Extend regex_findall and regex_replace by an example that includes
the multiline and ignorecase parameters.
4 years ago
Mark Chappell c387b318a6
AWS: update reference to auto-retrying ResourceNotFound (#72314)
AWS Dev Guidelines: update reference to auto-retrying ResourceNotFound

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
Bill Nottingham 34c9ed8a28
Product-related updates. (#74454) 4 years ago
Alicia Cozine 9d9b08bece
fix spacing to fix header, reorg contributing page (#74421)
Co-authored-by: John R Barker <john@johnrbarker.com>
4 years ago
Lidiane Taquehara f97787ca74
Update argcomplete docs links on installation guide (#74410)
Link on installation docs is outdated. Switch to currently docs at: https://kislyuk.github.io/argcomplete/
4 years ago
Sandra McCann a75bae8a62
update versions (#74432) 4 years ago
Sandra McCann d1e6ee7b21
update changelog links and release-maint page (#74431) 4 years ago
Abhijeet Kasurde 8d499bbc83
Update Kubernetes collection name in docs (#74440) 4 years ago
Mark Chappell 63afb33d86
Use is_boto3_error_code in 'standard' example (#72313)
Use is_boto3_error_code in 'standard' example rather than e.response['Error']['Code'] (#72313)

Co-authored-by: Sloane Hertel <shertel@redhat.com>
4 years ago
Mark Chappell cf08c23b4f
Update AWS dev guides to use collections utils and fragments (#72312) 4 years ago
jakelevinez ddfc648d37
Update VMware library installation docs (#71219)
Depending upon OS/distro, please use pip/pip3.
4 years ago
dhx-mike-palandra c2985c491b
Update complex_data_manipulation.rst (#72509) 4 years ago
Ernst Oudhof 7ca5dede97
Add weos4 network platform to documentation (#74088)
* Add weos4 network platform to documentation

* Fix small format issues
4 years ago
Alicia Cozine c90922ee36
Docs - Split Developing collections page, add info on optional module_utils (#74105)
*
4 years ago
Alexandre Garnier 8698855ffd
Case-insensitive set theory filters (#74256)
Fixes #74255

* Fix call to 'unique(case_sensitive=False)' triggering error when falling back to Ansible's version which **is** case-sensitive
* Test multiple situations of 'unique' filter errors with fallback not handling specific parameters

Signed-off-by: Rick Elrod <rick@elrod.me>
Co-authored-by: Rick Elrod <rick@elrod.me>
4 years ago
Hublerho e6a5245d60
Using "~" instead of "+" for concatination (#74364)
Changed FAQ examples to conform with the Jinja documentation:
If both values on either side of a plus/+ are numbers, they will be added whereas using "~" will convert all operands into strings and then concatenate them. Closes #73799.
4 years ago
Alex Willmer c295de661c
Correct splitext() description, and example (#74377)
`splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.`
4 years ago
Sandra McCann 6119fb0a9a
lighten navigation background to make section labels easier to read for core docs (#74356)
* make section labels for /ansible-core/ docs easier to read, with black text and lighter gray background
4 years ago
Sam Doran fdbef02923
Update docs on working on docs (#74201)
* Fix the Makefile's htmlsingle command.
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
4 years ago
Toshio Kuratomi 4c79dd16be
Update the porting guide for a new ansible version (#74362) 4 years ago
Sam Doran 2cbfd1e350
Add porting guide and documentation for changes to argument spec validation (#74268)
* Add ArgumentSpecValidator to docs
* Improve docs for ArgumentSpecValidator
* Document removal of private methods

* Update module_utils documentation
    - Add docs for argument spec classes as well as validation and parameters files.
    - preserve the order in the source for errors.py
    - document DEFAULT_TYPE_VALIDATORS so it can be referenced elsewhere
    - fix automodule directive for validation.py

* Update docs in arg_spec and paremeters
    - This improves the generated documentation.

* Document breaking changes in porting guide.
* Update formatting in porting guide and add a Deprecated section
* Fine tune module_utils documentation


* Move instance docstring to the __init__ method
  Remove optional description since it fails the sanity test and I am not 100% it is valid anyway.

* Remoe incorrect parameter from docstring
  This was changed a while ago but wasn't removed from the docstring.

* Use attr rather than attribute
  The py:attribute: domain only exists in newer Sphinx >= 3.1.

* Improve documentation on exceptions
* Final pass
    - use args/kwargs instead of param
    - fix formatting errors that didn't display examples correctly
    - format TypeErrors so they are referenced as classes
    - specify complex types
4 years ago
Abhijeet Kasurde 6e56e72d99
vmware: Add a note about known issue (#73273)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
sry9681 c0cc574e65
Update lookup.rst (#73716)
Document that users must pass `allow_unsafe=True` as an option in the lookup to allow templating, with a note about security implications.

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
ml c9c84594d8
Docs: Fix k8s_config_resource_name YAML example (#74129)
The `name` key should be beneath `metadata`:
4 years ago
Abhijeet Kasurde 9ed0e37e53
Add a link to Jinja 2 templates (#74348)
Added a link to Jinja 2 templates in playbooks_templating documentation page.
Fixes: #74313

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
yuri 5f391a72ee
Update playbooks_filters.rst (#74242)
##### SUMMARY
Make the `random` filter description more clear.
4 years ago
schurzi 5e5bfa8116
remove deprecated ansible.module_utils._text from documentation (#73211)
According to comment in ansible.module_utils._text it is deprecated and
should not be used. This is now reflected in the documentation.
4 years ago
Baptiste Mille-Mathias 99a2b5f300
Provide results to examples (#73984) 4 years ago
David Shrewsbury d44eb03f49
Remove include from tests (#74330) 4 years ago
daeseokyoun 9369bd6ca1
correct how to install Docker SDK for Python (#74288)
* docs: correct guide for the latest Docker SDK for Python
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Daeseok Youn <daeseok.youn@navercorp.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Brian Coca 7b39ee361d
corrected epmhasis line (#74254)
need to be careful when adding lines as you create a different offset
4 years ago
Scott Sinclair 325ccf22fe
Fix issue with version 3 in docs version list (#74089)
Previously would subsitute the "3" in "s3" instead of the version location in the URL
4 years ago
Matt Martz 17237c1d88
Deprecate Py2.6 support for target nodes (#74165) 4 years ago
Toshio Kuratomi ee38202fc0
Update the porting guide for ansible package 4.0.0 alpha4 (#74280) 4 years ago
Alicia Cozine 126e9244c2
updates list of available versions for Ansible 3 (#74265)
* updates list of available versions for Ansible 3
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Brian Coca 270f109bb3
fix see_also formatting (#74252) 4 years ago
Rick Elrod 19aeb4706d
[conditional] Remove support for bare variables (#74208)
Change:
- Variables used in ``when`` conditionals are no longer parsed and
  attempted to be converted to booleans. All non-empty strings are
  considered true (empty strings, false).

Test Plan:
- Updated existing tests
- Added a bunch of new tests with various kinds of truthy/falsy
  values.

Tickets:
- Fixes #74134

Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
Sandra McCann 481c036632 update intersphinx links for Ansible 3 4 years ago
Alicia Cozine d7f826c987
Change look and feel of the `ansible-core` docs (#74200) 4 years ago
Matthew Cengia c7473828c7
Docs: Remove duplicate word (#74223)
The word "to" was erroneously used twice consecutively.

Signed-off-by: Matthew Cengia <mattcen@mattcen.com>
4 years ago
Rick Elrod d7df8a4484
[cron] Remove deprecated features (#74197)
Change:
- Require name always
- Drop 'reboot' parameter in favor of 'special_time: reboot'

Test Plan:
- CI

Tickets:
- fixes #74132

Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
Sandra McCann 7443e9d659
pin docutils to 0.16 until theme problem is fixed (#74193) 4 years ago
Matt Martz 09c8faca9f
Add 2.12 roadmap (#74000) 4 years ago
Alicia Cozine 05662fd2ab
Docs: clarify role docs - vars vs params, dependencies (#74104) 4 years ago
Rick Elrod 3a74f7ea22
prep for 2.12 version bump (#74126)
* prep for 2.12
* Add 2.12 deprecations and sort ignore.txt list.

Signed-off-by: Rick Elrod <rick@elrod.me>
4 years ago
Toshio Kuratomi 112a7718c6
Porting guide update for ansible-4.0 alpha3 (#74075) 4 years ago
Toshio Kuratomi 47ffa27416
Update the porting guide for a new ansible version (#74073) 4 years ago
Baptiste Mille-Mathias 6b33864a2c
Clarify tags on tasks are applied with OR and not AND (#74038)
Co-authored-by: flowerysong <junk+github@flowerysong.com>
4 years ago
Felix Fontein af7f3fc266
Revert "Add duplicated set filter and documentation (#72729)" (#74053)
This reverts commit 99a6627c60.

* ci_complete
4 years ago
Baptiste Mille-Mathias 99a6627c60
Add duplicated set filter and documentation (#72729)
Co-authored-by: Kerry <kerry@flatline-studios.com>
4 years ago
Alicia Cozine c66cff444c
documents the use of ansible.legacy (#73942) 4 years ago
Leandro Scardua 5dbcaa4c01
Update version on FreeBSD (#73664)
##### SUMMARY
<!--- Your description here -->
On the main freebsd change, and no the version: py37-ansible

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Sandra McCann 59c61bc88a
update docs to uninstall ansible-base on upgrade (#74024) 4 years ago
sgpinkus 2abb2d3f17
Update playbooks_variables.rst. To say you can define variables within a playbook is somewhat misleading. Variables are defined within plays and are only visible within the play they are defined in *not* the entire playbook. There is no way to define vars to have strictly playbook scope. (#73986)
+label: docsite_pr
4 years ago
Marketka 0bf9b7fdf8
Added prerequisites to install for CentOS (#73993)
* Added prerequisites to install for CentOS as well so CentOS users don't have to look for alternatives for each Ubuntu package.

Signed-off-by: mm667937 <marketa.muzikova@broadcom.com>


Signed-off-by: mm667937 <marketa.muzikova@broadcom.com>
4 years ago
saruter 73c08df2db
Docs: Add filter "urlencode" with example (#74034)
* Add example for URLENCODE filter
4 years ago
Alicia Cozine eb631c1881
use present tense for porting guide entries (#74021)
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Andrew Klychkov 46b02e125f
dev_guide/testing_integration: update image list (#74017) 4 years ago
David Greaves 4881ca1dcb
Introduce the concept of playbooks early on (#74018)
* Introduce the concept of playbooks early on
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Mark Mercado 3bccfb1615
Updating Community docs with DO information (#74019) 4 years ago
Andrew Klychkov 77ec2b3b3a
Documentation: update committer_guidelines.rst (#73782)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
Toshio Kuratomi c8a7899869
Update the porting guide for a new ansible version (#74016) 4 years ago
Andrew Klychkov 0543916a86
Docsite: clarify a changelog entry format (#73902)
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Jim Speir 4780e10a2b
Adding jborean93/WindowsServer2019 in docs (#73950) 4 years ago
Matt Davis c6cf7986ab
add porting guide info for optional module_utils (#73979) 4 years ago
Brian Coca ccd9a992cf
complex data example using value and default from list of dicts (#73937) 4 years ago
sgpinkus efe97aeb31
Update developing_inventory.rst (#73931)
* Update developing_inventory.rst

hashes/dictionaries in JSON (JavaScript Object Notation) are represented by what JSON calls "objects", so use that established terminology instead of "hash", "dictionary", or "hash/dictionary" etc.

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

Co-authored-by: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>
4 years ago
Ompragash Viswanathan 561cdf3ace
Updated COLLECTIONS_4.rst to include ansible-inclusion repo link for new collection submission (#73582)
Co-authored-by: Sandra McCann <samccann@redhat.com>

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Sloane Hertel 95dc8f2361
Add some dev documentation for constructed features (#73497) 4 years ago
Alicia Cozine 30c465c1a9
Promote publication (#72400)
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
4 years ago
Alicia Cozine b57444af14
Rebased pr73824 (#73934)
Co-authored-by: Eugene <k.evgen61@gmail.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
4 years ago
Toshio Kuratomi 0279d02980 Add porting guide for ansible 4 4 years ago
Toshio Kuratomi e10da3c368 Porting guide changes when adding a new ansible release
* Add the ansible-4 porting guide to the index
* Need to exclude the porting guide for ansible-4 from the core docs build
4 years ago
Ikko Ashimine 3098022146
Fix typo in porting_guide_3.rst (#73871)
paramater -> parameter
4 years ago
Toshio Kuratomi 197e8f5640
Mention that minor releases end once the next ansible release is made. (#73836) 4 years ago