Commit graph

2454 commits

Author SHA1 Message Date
Sam Doran
12f4b0db04
Fix typo in porting guide () 2021-05-24 11:53:51 -05:00
Abhijeet Kasurde
1bd7dcf339
encrypt: add new paramter 'ident' ()
Add a new parameter `ident` for specifying version of BCrypt
algorithm. This parameter is only valid for `blowfish` hash type.
2021-05-24 11:46:37 -04:00
Sean Cavanaugh
20ef733ee0
Update network_resources.rst () 2021-05-24 11:25:55 -04:00
Abhijeet Kasurde
015331518d
windows: Add openssh installation link ()
* Added a link to openssh installation on Windows

Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-05-21 11:00:39 +05:30
Chander G
888fea69e5
Fix small typo in playbook_filters doc ()
Move versionadded to next line to render correctly.
2021-05-19 16:23:42 +05:30
Sandra McCann
138dfa4549
add release note and mark 3 unmaintained () 2021-05-18 15:33:26 -05:00
Sam Doran
c0cb353ce1
Remove PyCrypto ()
* 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
2021-05-18 16:12:32 -04:00
Felix Fontein
4bf420706b
Improve and extend changelog logs ()
Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-05-18 15:02:59 -04:00
Toshio Kuratomi
fbe5f9fd7d
Update the porting guide for a new ansible version () 2021-05-18 14:50:07 -04:00
Vincent Rubiolo
5266e1e1ab
Fix broken Jinja website links (for tests) ()
The various links to the Jinja website were broken, this commit fixes them.
2021-05-18 11:40:38 -04:00
Vincent Rubiolo
8d7a5d9cb3
Fix broken Jinja website links ()
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.
2021-05-18 11:39:43 -04:00
Brian Coca
5333e4138c
note about adhoc delegate_to hosts ()
* Update docs/docsite/rst/user_guide/playbooks_delegation.rst
2021-05-17 13:24:26 -05:00
Abhijeet Kasurde
2f87b8760d
docs: Add a note about ansible_date_time ()
* For long-running playbooks, discourage users from using
`ansible_date_time`. Use `pipe` or `now` as an alternative.

* Review comments

Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2021-05-15 10:13:05 +05:30
Lydie
bf9944266c
Issue 73792: Removed mentions of R() and M() ()
* 73792: Removed mentions of R and M
2021-05-14 14:48:21 -05:00
Abhijeet Kasurde
39df263f1a
intro: Add a note about current user ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-05-14 11:41:35 -04:00
m0nt3cr1st0
25de07946c
Fix typo on roles documentation ()
##### SUMMARY
Small fix on the roles directory structure documentation

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2021-05-14 11:40:00 -04:00
Kelly Brazil
91212b2008
Add JC filter plugin example ()
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-05-14 11:37:29 -04:00
Jill R
fa15d35cb1
Update AWS guides with new SDK and Python requirements ()
The 2.0 collection releases will introduce new Python requirements
and a new SDK support policy
2021-05-14 11:35:45 -04:00
Mark Mercado
1906d75907
Adding DigitalOcean cloud support to ansible-test () 2021-05-12 16:07:21 -07:00
Alicia Cozine
829c9c3d46 updates jinja filters links with new pattern for Jinja 3.x documentation 2021-05-12 10:08:00 -07:00
Toshio Kuratomi
8f2c0e0574
Update the porting guide for ansible-3.4.0 () 2021-05-11 16:14:29 -05:00
Abhijeet Kasurde
79e12ba98e
docs: Add a note about crypt ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-05-11 11:39:08 -04:00
David Shrewsbury
8fb54885bf
Role argspec: allow new argument spec file ()
* 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>
2021-05-11 09:29:47 -05:00
Andrew Klychkov
5463cbb841
Docs: communication.rst - add ansible-community to the IRC channel list () 2021-05-06 15:10:53 -04:00
Felix Fontein
a6cc508822
Update the module lifecycle document to also cover plugins and collections ()
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-05-06 10:16:43 -04:00
Joseph Jacobs
dcb807dea7
Update cli_parsing.rst ()
Bad indent in an example
2021-05-06 09:34:07 +05:30
Matt Clay
8bd599d048 Change Shippable refs in docs to Azure Pipelines. 2021-05-05 17:21:48 -07:00
Alicia Cozine
b765d3799b
update backporting instructions to reflect new latest stable branch, some edits ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-04-30 11:42:03 -04:00
Matt Clay
a30c55f68a Remove deprecated common.removed module_util.
Tests have been updated to reflect its removal as well.
2021-04-29 16:07:56 -07:00
Toshio Kuratomi
112b175f17
Update the porting guide for a new ansible version () 2021-04-29 10:03:21 -04:00
Christian Fetzer
f194108a26
docs: Improve documentation for regex_search,replace,findall ()
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.
2021-04-28 08:45:01 -04:00
Mark Chappell
c387b318a6
AWS: update reference to auto-retrying ResourceNotFound ()
AWS Dev Guidelines: update reference to auto-retrying ResourceNotFound

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-04-28 09:59:12 +05:30
Bill Nottingham
34c9ed8a28
Product-related updates. () 2021-04-27 16:19:57 -05:00
Alicia Cozine
9d9b08bece
fix spacing to fix header, reorg contributing page ()
Co-authored-by: John R Barker <john@johnrbarker.com>
2021-04-27 10:41:10 -04:00
Lidiane Taquehara
f97787ca74
Update argcomplete docs links on installation guide ()
Link on installation docs is outdated. Switch to currently docs at: https://kislyuk.github.io/argcomplete/
2021-04-27 09:40:37 -05:00
Sandra McCann
d1e6ee7b21
update changelog links and release-maint page () 2021-04-27 09:33:21 -05:00
Abhijeet Kasurde
8d499bbc83
Update Kubernetes collection name in docs () 2021-04-27 19:00:03 +05:30
Mark Chappell
63afb33d86
Use is_boto3_error_code in 'standard' example ()
Use is_boto3_error_code in 'standard' example rather than e.response['Error']['Code'] ()

Co-authored-by: Sloane Hertel <shertel@redhat.com>
2021-04-27 17:49:00 +05:30
Mark Chappell
cf08c23b4f
Update AWS dev guides to use collections utils and fragments () 2021-04-27 17:34:49 +05:30
jakelevinez
ddfc648d37
Update VMware library installation docs ()
Depending upon OS/distro, please use pip/pip3.
2021-04-27 15:19:03 +05:30
dhx-mike-palandra
c2985c491b
Update complex_data_manipulation.rst () 2021-04-27 14:04:48 +05:30
Ernst Oudhof
7ca5dede97
Add weos4 network platform to documentation ()
* Add weos4 network platform to documentation

* Fix small format issues
2021-04-23 23:52:14 +02:00
Alicia Cozine
c90922ee36
Docs - Split Developing collections page, add info on optional module_utils ()
*
2021-04-23 17:03:46 -04:00
Alexandre Garnier
8698855ffd
Case-insensitive set theory filters ()
Fixes 

* 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>
2021-04-23 12:44:43 -05:00
Hublerho
e6a5245d60
Using "~" instead of "+" for concatination ()
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 .
2021-04-23 12:44:09 -05:00
Alex Willmer
c295de661c
Correct splitext() description, and example ()
`splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.`
2021-04-22 15:40:58 -05:00
Sam Doran
fdbef02923
Update docs on working on docs ()
* Fix the Makefile's htmlsingle command.
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2021-04-21 15:15:27 -04:00
Toshio Kuratomi
4c79dd16be
Update the porting guide for a new ansible version () 2021-04-21 10:23:31 -04:00
Sam Doran
2cbfd1e350
Add porting guide and documentation for changes to argument spec validation ()
* 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
2021-04-20 15:40:53 -04:00
Abhijeet Kasurde
6e56e72d99
vmware: Add a note about known issue ()
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>
2021-04-20 14:11:45 -04:00