Commit graph

2767 commits

Author SHA1 Message Date
devon-mar
e97f333532
Add missing endfor to vlan_parser example (#72872) 2020-12-08 16:25:56 +01:00
Toshio Kuratomi
6608f3aab3
Update ansible roadmap (#72838)
* Update to the ansible package roadmap for 3.0.0

* Rename files for the ansible roadmap from 2.11 to 3.0

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-12-04 19:50:01 -08:00
Abhijeet Kasurde
38f21557ba
json_query: Add examples for starts_with and contains (#72821)
* Add a note about - data structure returned from register variables
needs to be parsed using ``to_json | from_json`` in order to
get correct result.
* Add examples for starts_with and contains

Fixes: https://github.com/ansible-collections/community.general/issues/320

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-12-03 14:52:00 -05:00
Andrew Klychkov
0a7fcd135c
Docsite: update "Migrating Ansible content to a different collection" info (#72710)
* add a reminder about ignore-*.txt entries, fix formatting, add symlink removal note
* Update docs/docsite/rst/dev_guide/developing_collections.rst

Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: David Moreau Simard <moi@dmsimard.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-12-03 13:29:01 -06:00
Andrew Klychkov
2aa3531b1b
Docsite: update complex_data_manipulation and playbooks_advanced_syntax rst files to use FQCNs (#72539) 2020-12-02 10:29:49 -06:00
David Moreau Simard
478b2687ec
Update the porting guide to include 2.10.4 (#72782) 2020-12-01 18:30:48 -06:00
Simon Heimberg
79fb065d16
document that handler can not run include_role and import_role (#72744)
Warn the users until issue #20493 is fixed.
2020-12-01 10:15:46 -06:00
gfyoung
fa481e3316
Fix missing dashes in playbooks intro doc (#72746) 2020-11-30 16:19:40 -05:00
Pablo Martinez
454ac6420e
Update playbooks_filters_ipaddr.rst (#72705)
Fix the order of the arguments for ansible.netcommon.reduce_on_network. Pass the network as the argument and the list of IP addresses as the filter input.
2020-11-30 11:58:11 -06:00
gdiamond
74196577a3
added sample output for echo example (#72718) 2020-11-30 09:59:27 -05:00
Abhijeet Kasurde
a57539f764
Update VMware module development (#72603)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-11-23 09:35:27 -05:00
gdiamond
35022e13a8
Update intro_getting_started.rst (#72689)
Move the command output to immediately follow the example.
2020-11-20 14:35:19 -06:00
Marco Lembo
1937dd5e9c
Update developing_plugins.rst (#72305)
##### SUMMARY
ansible_date_time returns utc time. datetime.utcnow() rather than datetime.now()

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-11-17 21:45:03 +01:00
Simon Heimberg
ad4ddd8211
document what the name of a play is (#72633)
##### SUMMARY

Make clear that `ansible_play_name` is the name attribute from the play and not the file name of the playbook.

improves #57361

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-11-17 11:56:49 -05:00
Brian Coca
452bc3af04
example of exponential backup (#72617) 2020-11-13 16:00:21 -05:00
Ashwini Mhatre
8c67432fc8
Update intro_installation.rst (#72586) 2020-11-11 10:44:50 -05:00
Sean Blundy
a5eb788578
Minor Edit: Fix typo in platform_index.rst (#72564)
Fix Dell OS 10 dellemc.os10.0s10 to dellemc.os10.os10 in platform_index.rst
2020-11-10 16:22:07 -06:00
Matthew Davis
ddad9930aa
Clarify collection paths in docs (#72510)
* Clarify collection paths in docs, fix rst syntax, rephrase docs about using collection from folder/local git

Co-authored-by: Felix Fontein <felix@fontein.de>
2020-11-10 16:19:43 -06:00
Brian Coca
8eab113cb1
show keyword documentation in ansible-doc (#72476)
* show keyword documentation in ansible-doc

Co-authored-by: Felix Fontein <felix@fontein.de>
2020-11-09 09:55:17 -05:00
Matt Martz
96ad5b799e
Emit warning when running on the controller with a Python older than 3.8 (#72467)
* Emit warning when running on the controller with a Python older than 3.8

* Add spaces

Co-authored-by: Matt Clay <matt@mystile.com>

* and more spaces

Co-authored-by: Matt Clay <matt@mystile.com>

* s/Py/Python/

Co-authored-by: Matt Clay <matt@mystile.com>

* Add note to Control node requirements about Py3.8 requirement

* Add collection_name to deprecated call

* more spaces

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* Clarify that we are only packaging for py3.8+

Co-authored-by: Matt Clay <matt@mystile.com>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
2020-11-09 08:53:52 -06:00
Mohammad Sadegh Dehghan
599805e316
Introduce Ansible plugin in Jetbrains section of doc (#72465) 2020-11-05 16:08:43 -05:00
Felix Fontein
da1c1e8bb8
Add info on how to contribute to **community**-maintained collections as well. (#72494) 2020-11-05 16:07:45 -05:00
Lydie
a5a0b8f0e7
Style guide edit to the tools page (#72506) 2020-11-05 15:28:34 -05:00
Felix Fontein
01d207a3e3
Improve argument spec documentation (#72335)
* Link to argument spec documentation from 'Creating a module'.

* Use items instead of sub-headings.

* Update deprecation information.

* Document conditional requirements.

* Document supports_check_mode and add_file_common_args.

* Add deprecation examples.

* Re-add word.

* Improve title.

* Fix RST formatting, add conditional dependency section starter.
2020-11-04 18:17:46 +01:00
Felix Fontein
569d937df8
Improve config.rst formatting (#72354)
* Indent Jinja2 directives.

* Show version_added and deprecations for ini settings and environment variables.

* Make default conditional, add choices. Copied from #55474.

* Add Ansible variables. Copied from #55474.

* Turn ini keys and environment variables into lists. Copied from #55474.

* Improve formatting. Copied from #55474.
2020-11-04 10:48:10 -06:00
Andrew Klychkov
dbe43e071e
Docsite: update user_guide/playbooks_module_defaults (#72051)
* Docsite: update user_guide/playbooks_module_defaults, add name: lines and use FQCN consistently
2020-11-04 09:58:47 -06:00
Samy Mahmoudi
8ada1bb447
docs: Transpose two words to correct a sentence. (#72329) 2020-11-04 09:40:39 -06:00
Josh
1a5d2938c6
Update playbooks_filters_ipaddr.rst (#72464)
Fix small code formatting issue - remove extra `:` before code-block.
2020-11-04 09:14:17 -06:00
Toshio Kuratomi
d53c47940a Update the ansible-2.10 porting guide 2020-11-03 15:47:34 -08:00
Sandra McCann
d76f85208d
clarify upstream release status of 2.10 (#72269)
* clarify upstream release status of 2.10

* wordsmith
2020-11-03 11:39:27 -05:00
Kohei Takahashi
2e4038f4d2
Fixed a typo in user_guide/playbooks_conditinals (#72427)
+label: docsite_pr
2020-11-02 10:04:57 -05:00
Daniel Tavernier
dd19c9f737
Update playbooks_tags.rst (#72351)
##### SUMMARY
Corrected the "Adding tags to blocks" example syntax. 


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-10-27 15:50:49 -04:00
Matt Davis
83909bfa22
Remove ansible-galaxy login (#72288)
* GitHub is removing the underlying API used to implement the `login` command. Since the general consensus seems to be that relatively nobody currently uses this command (in favor of explicit token passing), support was simply removed for interactive login. If a future need arises, this command should be reimplemented via OAuth Device Auth Grants.
* login or role login commands now produce a fatal error with a descriptive message
* updated 2.10 and 2.11 porting guide entries

* remove dead code/config, update messages and porting guides
2020-10-23 09:11:45 -07:00
Abhijeet Kasurde
b6360dc5e0
VMware: scenario guide for vmware_tools connection plugin (#72080)
* VMware: scenario guide for vmware_tools connection plugin

Scenario doc to guide user about the usage of vmware_tools
using connection plugin.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* review comments

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-10-23 10:44:12 -04:00
Abhijeet Kasurde
fe65144a4a
vmware: Using env variable for custom SSL path (#72273)
When validate_certs is True and user has custom SSL
certificate path, user can use ``REQUESTS_CA_PATH``
in ``environment`` parameter of task to specify this path.

Fixes: https://github.com/ansible-collections/community.vmware/issues/49

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-10-22 14:48:26 -04:00
Nathan Scott
c20329a0f6
Update migrating_roles.rst (#72260)
Fix a typo in the sample spec file Source0 line
2020-10-20 13:19:45 -05:00
Sandra McCann
3ece57c01a
remove ansibleFest banner (#72253) 2020-10-20 13:18:16 -05:00
Jaime Hablutzel
afba5c2852
Miscellaneous fixes in user_guide/intro_inventory.rst docs (#72202)
* Fixing missing hosts entry under the group dict.

* Added missing 'vars:' key

* Reordering arguments for consistency with the format displayed by "ansible-playbook --help"

* Fixing contradictory text
2020-10-20 10:35:15 -05:00
Abhijeet Kasurde
02658d7bf8
k8s: Scenario guides (#72095)
* Start Kubernetes Scenario guides for users
* K8S inventory scenario guide

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-10-20 10:11:33 -04:00
Ronald Eddy Jr
d18901dd4a
Update HTTP -> HTTPS (#72244)
Co-authored-by: Ronald Eddy Jr <ron@Ronalds-MacBook-Pro.local>
2020-10-19 15:57:20 -04:00
Matt Martz
a33cc191bd
Update 2.11 Roadmap to include dates and planned work (#72222)
* Update 2.11 Roadmap to include dates and planned work

* remove comma
2020-10-15 13:52:51 -05:00
Justin Otherguy
8465f285cc
Update playbooks_strategies.rst (#72176)
beside the fact that naming the variable to specify the number of machines executed in *parallel* is named *serial* - the number of hosts chosen in this example is not optimal, either: 2x2 = 4; so - 3 hosts in 2 batches should clear things up a little
2020-10-14 12:26:16 -05:00
Ken Celenza
b18e462bbb
Consistent Taxonomy (#72215)
Historically "these" have been called directives, attributes, and keywords. We've now settled on `keyword` (https://docs.ansible.com/ansible/latest/reference_appendices/playbooks_keywords.html). Update all documentation to reflect this term.
2020-10-14 12:16:30 -05:00
Toshio Kuratomi
6e7a40dd94
Update the porting guide for a new ansible version (#72211) 2020-10-13 12:36:23 -05:00
Jordan Borean
caba47dd3f
Add support for GSSAPI/Kerberos to urls.py (#72113)
* Add support for GSSAPI/Kerberos to urls.py

* Test out changes with the latest test container

* Get remote hosts working

* Fix up httptester_krb5_password reader

* Fix tests for opensuse and macOS

* Hopefully last lot of testing changes

* Dont do CBT on macOS

* Fixes from review
2020-10-13 14:16:07 +10:00
Sandra McCann
7c1dd1c7fb
add link to jinja docs from templating section (#72205) 2020-10-12 13:52:24 -05:00
Sandra McCann
c084bc160c
add details on how to get API token for Galaxy (#72203) 2020-10-12 13:47:41 -05:00
Andrius Benokraitis
9382738f52
Update contributing_maintained_collections.rst (#72178)
##### SUMMARY
Adding Kubernetes.Core collection, editing vmware.vmware_rest a bit


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-10-09 16:12:45 -04:00
Andrew Klychkov
30a651bca3
Docsite: update user_guide/playbooks_async (#72115) 2020-10-09 10:50:58 -05:00
Raphael Prosillo
e119c2d2bf
Add The Bullhorn to the community communication page (#72125)
Update documentation on communication channels for Ansible.
2020-10-09 10:49:53 -05:00
Jens Heinrich
835752cc53
Update playbooks_vars_facts.rst (#72150)
Remove misleading typo, add a note on the mode of local facts

Co-authored-by: JensHeinrich <github.com/JensHeinrich>
2020-10-09 10:44:27 -05:00
Gonéri Le Bouder
af7fd0f79d doc: use FQCN for vmware_rest examples
Use the collection name + the module name for clarity.
2020-10-08 15:24:13 -04:00
Gonéri Le Bouder
c72e2ee675
import of the vmware_rest documentation (#72090)
Co-authored-by: Jill R <4121322+jillr@users.noreply.github.com>
2020-10-07 11:33:55 -04:00
Evan Van Dam
3db08adbb1
Add optional attribute arg for min and max filters (#50909)
* Pass **kwargs to min and max filters

* Use the jinja2 filters if available

* Add unit tests

* Add examples to docs passing attribute
2020-10-05 10:40:37 -04:00
Lars Kellogg-Stedman
bc98ebf29f
installation docs - add tip pointing to pip docs (#71741) 2020-10-02 15:34:44 -04:00
Erik Zettel
2b79cd2c0f
Fix typos (#72072) 2020-10-02 10:32:03 -04:00
Andrew Klychkov
3efc8b6de8
Docsite: update user_guide/playbooks_prompts (#72049) 2020-10-01 16:34:23 -04:00
Andrew Klychkov
c12fce3aa9
Docsite: update user_guide/playbooks_checkmode (#72052) 2020-10-01 16:33:24 -04:00
Andrew Klychkov
77840f886e
Docsite: update user_guide/playbooks_debugger (#72053) 2020-10-01 16:32:03 -04:00
Zois Pagoulatos
eee13962e5
Minor typo in test_strategies.rst (#72060) 2020-10-01 14:34:23 -04:00
DarrenHSKG
88a676246e
Update porting_guide_2.8.rst (#72041)
##### SUMMARY
Removed translatable words from codeblocks as per https://github.com/ansible/ansible/issues/59449

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-10-01 11:53:02 +01:00
Abhijit Menon-Sen
64d9ccb965
Reword strangely patronising introduction to loops (#72019) 2020-09-30 16:05:46 -04:00
Felix Fontein
a077bca5d5
ansible-test: improve version number validation, validate some semantic versioning properties (#71679)
* Validate removal versions.
* Validate that removal collection versions and version_added collection versions conform to semver spec.
* Validate removal version numbers in meta/runtime.yml.
* Stricter validation for isodates (f.ex. YYYY-M-D is not allowed).
* Improve error reporting.
* Validate removal collection versions.

Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru>
2020-09-29 13:33:45 -07:00
Jorge Vallecillo
94522b7c10
Fix typos (#71970) 2020-09-28 14:33:24 -04:00
Andrew Klychkov
74be7de361
Docsite: improve user_guide/playbooks_vars_facts (#71973)
* Docsite: improve user_guide/playbooks_vars_facts
2020-09-28 14:32:01 -04:00
Andrew Klychkov
8ae3998ecf
Docsite: update user_guide/vault (#71975) 2020-09-28 14:29:34 -04:00
Andrew Klychkov
0645436acd
Docsite: update user_guide/playbooks_filters (#71980) 2020-09-28 14:26:57 -04:00
Andrius Benokraitis
c5a161b2b0
Update faq.rst (#71982)
Added link to https://access.redhat.com/solutions/5295121 in third sentence
2020-09-28 11:07:03 -04:00
Alicia Cozine
eed606e0e9
adds name lines to handler re-use examples (#71946)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-09-25 12:46:45 -04:00
Gonéri Le Bouder
c1005147e0 doc: add vmware_rest_guidelines
Add the development guidelines for the vmware_rest collection.
2020-09-25 12:24:48 -04:00
Alicia Cozine
27826827e9
updates intersphinx references for docs links (#71921)
* DOCS: updates intersphinx references for docs links
* TESTS: Raise the number of bytes scanned to determine if a file is binary. The newest ansible-2.10.inv file has its first null byte at position 2261. 4096 is still a cheap chunksize to read so it still makes sense to raise this.

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2020-09-25 10:33:29 -05:00
Obioma Osuagwu
4cb20dba97
Update index.rst (#71887)
* Update docs/docsite/rst/community/index.rst to include another link to the mailing lists list
2020-09-25 10:28:51 -05:00
Andrew Klychkov
c19af92be6
Docsite: improve user_guide/playbooks_variables (#71938)
* Docsite: improve user_guide/playbooks_variables
2020-09-25 09:48:33 -05:00
Andrew Klychkov
2fed63a930
Docsite: improve inventory-related pages (#71907)
* Update docs/docsite/rst/plugins/inventory.rst
2020-09-25 09:46:24 -05:00
Abhijeet Kasurde
4f990e7615
dev_guide: Add Pygments Lexer examples (#71458)
* dev_guide: Add Pygments Lexer examples

Fixes: #51307

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* adds ansible-output lexer, remmoves unsupported lexers

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-09-24 15:00:17 -05:00
Brian Coca
9a39452a31
update the definition of changed (#71865)
* add nuance to the definition of changed, add notes to modules that return "changed" without changing state
2020-09-24 14:33:22 -05:00
Badhreesh
a47eafa581
Update playbooks_reuse_roles.rst (#71880)
Change "vars_files" to "vars, files" under the Roles heading
2020-09-24 13:40:02 -05:00
Andrew Klychkov
25bfda8417
Docsite: improve user_guide/intro_inventory (#71859) 2020-09-24 13:34:41 -05:00
Andrew Klychkov
c3841b8440
Docsite: improve user_guide/playbooks_tags (#71858) 2020-09-24 13:33:03 -05:00
Andrew Klychkov
7a0a2f188b
Docsite: improve user_guide/playbooks_reuse_roles (#71857)
* Docsite: improve user_guide/playbooks_reuse_roles

* fix
2020-09-24 13:29:28 -05:00
Andrew Klychkov
2655fc0c23
Docsite: update Migrating Ansible content to a different collection (#71854)
Co-authored-by: Felix Fontein <felix@fontein.de>
2020-09-24 14:19:04 -04:00
Baptiste Mille-Mathias
401be27053
Add example values and results for theory filters (#71908)
Add example values and results for theory filters
2020-09-24 12:18:17 -05:00
Andrew Klychkov
ed6fb2e3f6
Docsite: improve user_guide/intro_adhoc (#71909) 2020-09-24 12:16:15 -05:00
Sandra McCann
70e25dc158
clarify releases download for older releases only (#71892) 2020-09-24 09:57:16 -05:00
Sandra McCann
e358946b98
update install instructions for pip (#71891) 2020-09-24 09:56:27 -05:00
Sandra McCann
4aedd1b987
add new glossary terms for 2.10 (#71813)
* add new terms for 2.10
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-09-24 09:45:54 -05:00
Sandra McCann
d6063b7457
clarify FQCN use for playbooks (#71816)
* clarify FQCN use

* Apply suggestions from code review

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-09-24 09:45:11 -05:00
brnl
5b27b307b9
Update intro_getting_started.rst (#71851)
Fixed the formatting on the remote user name override list.
2020-09-22 15:29:31 -05:00
Toshio Kuratomi
606924a4b4
Update the porting guide for a new ansible version (#71863) 2020-09-22 13:52:08 -04:00
Sandra McCann
bf4e102d97 update version switcher for 2.10 release 2020-09-22 10:46:58 -07:00
Sandra McCann
0e5911d650
add cli parser documentation (#71497)
* with native network example, linux example
2020-09-22 11:54:24 -05:00
Sandra McCann
bcfead8e0f change duplicated label 2020-09-21 12:32:11 -07:00
Andrew Klychkov
3db4be2c3b
Docsite: improve user_guide/playbooks_reuse (#71834) 2020-09-21 10:31:07 -04:00
Andrew Klychkov
05a45f63ff
Docsite: misc fixes of playbooks_delegation (#71753) 2020-09-17 10:22:03 -04:00
Andrew Klychkov
aa1f0bd062
Docsite: fix playbooks_conditionals (#71754) 2020-09-17 10:21:28 -04:00
Andrew Klychkov
79dc6fa948
Docsite: fix user_guide/playbooks_blocks (#71769) 2020-09-17 10:20:22 -04:00
Andrew Klychkov
1cf42897d2
Docsite: fix user_guide/playbooks_handlers (#71770) 2020-09-17 10:19:24 -04:00
Andrew Klychkov
2c6661d4c1
Docsite: fix user_guide/playbooks_error_handling (#71771) 2020-09-17 10:18:21 -04:00
Andrew Klychkov
a204f5f955
Docsite: fix user_guide/playbooks_environment (#71772) 2020-09-17 10:17:05 -04:00
Rick Elrod
7a38c470ba
[docs] add porting guide for DNF GPG validation (#71640)
* [docs] add porting guide for DNF GPG validation

Change:
- This was a breaking change (security fix), but I neglected to add a
  porting guide entry for it previously.

Tickets:
- Refs #71537
- Refs #71539
- Refs #71540
- Refs #71541

Signed-off-by: Rick Elrod <rick@elrod.me>

* changes from sivel

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-09-15 16:07:34 -04:00