Commit graph

2431 commits

Author SHA1 Message Date
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
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
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
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
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
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
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
Abhijeet Kasurde
760334303b
vmware: Add docs for filters (#71670)
Add a scenario guide for filters in VMware documentation

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-09-15 16:06:37 -04:00
Shounak
c36e939414
Fixed invalid urls inside guide_packet.rst and collections_using.rst (#71705)
* Fixed invalid urls inside guide_packet.rst and collections_using.rst

* Reverted fix for collections_using.rst
2020-09-15 16:05:27 -04:00
Evaristo Rojas
00ed5b1f2e
Fix broken bullet list (#71728) 2020-09-15 16:04:07 -04:00
Shufeng
4bf61f0714
Fix typo in delveloping_plugins_network (#71737) 2020-09-15 16:03:08 -04:00
Andrew Klychkov
a80131a283
Docsite: misc fixes (#71697) 2020-09-15 16:01:49 -04:00
Andrew Klychkov
13ab9f5932
Docsite: improve playbooks_loops.rst (#71718) 2020-09-15 16:00:09 -04:00
Sloane Hertel
7048542199
Fix passing the connection timeout to connection plugins (#71722)
* Fix passing the connection timeout to connection plugins
2020-09-15 11:34:11 -04:00
Andrew Klychkov
5511c898cc
Docsite: fix a typo in user_guide/index.rst (#71717) 2020-09-15 11:31:38 -04:00
Amin Vakil
7a0e545700
Add how to run unit test link in testing_units_modules doc (#71523)
* Add how to run unit test link in testing_units_modules
* Fix sanity test
2020-09-10 15:21:01 -05:00
Guillaume Vincent
1a06587f3b
Fix typo in the documentation (#71701)
Fix typo in the documentation: casting instead of casing
2020-09-10 10:49:59 -05:00
Andrew Klychkov
73bed95ead
Docsite: add reference to Style guide (#71694) 2020-09-10 10:17:13 -04:00
Jérôme Loyet
daca3ade99
Allow list of filters for the setup module (#68551)
The setup module can now filter out multiple pattern by providing a list
to the filter parameter instead of just a string. Single string sill
works. Previous behaviour remains.

(cherry picked from commit b5c36dac483fdd74d6c570d77cc8f3e396720366)
2020-09-09 20:40:48 +02:00
Alicia Cozine
b430f9b9aa
Adds FAQ and other pointers for collections (#71606) 2020-09-09 13:16:26 -04:00
esmersmith
a34043c6be
Changed all_modules references to list_of_collections in the documentation (#71656) 2020-09-09 11:43:40 -05:00
Zois Pagoulatos
1ad0f666d5
Fix typo in documentation (#71652)
Fix typo on the page about unit testing modules,
2020-09-09 11:41:43 -05:00
Toshio Kuratomi
9fcf1db871
Update the porting guide for 2.10.0b2 (#71677) 2020-09-09 08:37:56 -05:00
Matt Martz
61f6aa55b6
Add semver support to the jinja2 version test (#71600) 2020-09-08 08:52:27 -05:00
Toshio Kuratomi
4d4e75ee05
Update to the ansible-2.10.0 pre-release schedule (#71647) 2020-09-04 20:26:43 -05:00
Sandra McCann
bbd4ec13f1
clarify that collection names use same requirements as namespaces (#71639) 2020-09-04 14:37:44 -05:00
Sandra McCann
2f240f5dd7
Add note on where inventory scripts moved to' (#71638) 2020-09-04 14:35:08 -05:00
Andrew Klychkov
7bfeed3e24
Docsite: replace Latin phrases to English (#71588)
Replace Latin phrases like "e.g." and "i.e." and "etc." with English phrases. 

* Update docs/docsite/rst/community/committer_guidelines.rst
* Update docs/docsite/rst/dev_guide/developing_modules_documenting.rst
* Update docs/docsite/rst/dev_guide/developing_program_flow_modules.rst
* Update docs/docsite/rst/dev_guide/module_lifecycle.rst
* Update docs/docsite/rst/user_guide/intro_inventory.rst
* Update docs/docsite/rst/user_guide/playbooks_loops.rst
* Update docs/docsite/rst/user_guide/playbooks_reuse.rst
* Update docs/docsite/rst/dev_guide/platforms/aws_guidelines.rst
* Update docs/docsite/rst/dev_guide/testing.rst
* Update docs/docsite/rst/dev_guide/testing_integration.rst
* Update docs/docsite/rst/porting_guides/porting_guide_2.5.rst
* Update docs/docsite/rst/reference_appendices/faq.rst
2020-09-03 14:47:57 -05:00
Martin Krizek
a3b954e5c9
Force template module to use non-native Jinja2 (#68560)
Fixes #46169
2020-09-03 09:01:34 +02:00
Sandra McCann
b518a5db14
add skeleton ansible 2.11 roadmap (#71566)
* add skeleton ansible roadmap to docs/docsite/rst/roadmap/COLLECTIONS_2_11.rst
2020-09-02 13:48:53 -05:00
Alicia Cozine
96aee766f4
More docs updates to reflect collections ecosystem (#71597) 2020-09-02 13:50:12 -04:00
Sandra McCann
7f9258b024
update backport instructions for 2.11 (#71567)
* update backport instructions in docs/docsite/rst/community/development_process.rst

Co-authored-by: Matt Martz <matt@sivel.net>
2020-09-02 11:53:48 -05:00
Andrew Klychkov
bfba0ffc45
Docsite: improve developing_modules_documenting.rst (#71590)
* Docsite: improve developing_modules_documenting.rst

* add necessary dots to returns descriptions
2020-09-02 09:26:42 -04:00
Andrew Klychkov
cda5854099
Docsite: improve spelling_word_choice.rst (#71592) 2020-09-02 09:24:53 -04:00
Toshio Kuratomi
1882c60b04
Update the porting guide for ansible-2.10.0b1 (#71583) 2020-09-01 18:47:51 -04:00
Rick Elrod
0c50ee1abe
[docs] Fix up porting guides for CVE revert (#71580)
Change:
- Fix up wording and do proper backports for porting guide entries.

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-09-01 17:25:58 -05:00
Alicia Cozine
b694dbadfe
User guide overhaul, Table of Contents (#71553) 2020-09-01 12:29:21 -04:00
Alicia Cozine
29b20bd1b1
DOCS: Mentions ansible-base, adds collections pointers to Community and Dev Guides (#71480) 2020-09-01 12:25:37 -04:00
Andrew Klychkov
56423b1648
testing_sanity.rst: add argument for running in docker (#71223) 2020-09-01 12:00:13 -04:00
Sandra McCann
f75223d2c6
update install for 2.10 (#71543)
* update install for 2.10
2020-08-31 15:34:20 -05:00
Matt Deacalion
ec3920cef1
Update intro_patterns.rst (#71542)
Call out the trailing comma when specifying a single host. Small snag that took me a while to notice.
2020-08-31 14:49:18 -05:00
Amin Vakil
bc6461432e
Add --allow-disabled to sanity docs (#71524) 2020-08-31 10:46:03 -05:00
Sandra McCann
d6fe849b2e
add skeleton 2.11 base roadmap (#71478) 2020-08-27 16:45:20 -05:00
Toshio Kuratomi
c586d436fa
Feature freeze date has been merged with Ansible-2.10.0beta1 (#71494) 2020-08-27 15:55:55 -04:00
Sandra McCann
addee0699e
quick update to changelog instructins (#71492) 2020-08-27 11:05:35 -05:00
Sandra McCann
b6f10b9b52
update Network Advanced Topics for FQCN (#71325)
* update Network Advanced Topics for FQCN
2020-08-26 12:33:59 -05:00
Alicia Cozine
f82a1e06d7
updates network plugin docs pages for 2.10 (#71467)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-08-26 12:05:20 -04:00
Abhijeet Kasurde
3c8744f0c1
Add link to Matt's blog (#71436)
nitzmahone's blog nicely explained why Windows is not supported
as Ansible controller. Link that in documentation so users can
read about it.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-25 10:09:07 -04:00
Abhijeet Kasurde
0b16c0a8c7
user_guide: Fix reuse role examples (#71440)
Fixes: #53919

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-25 10:08:17 -04:00
Abhijeet Kasurde
5c1594916a
user_guide: Add an example for loop (#71441)
Explain how to use complex data in loop while converting
from with_together

Fixes: #47906

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-25 10:07:21 -04:00
John Westcott IV
a6537b59ab
Modify wording to specify two ctl-d to end stdin input in ansible-vault (#69436)
* 51860 - Modify wording to specify two ctl-d to end stdin input in ansible-vault
* removes space to make line 160 chars
2020-08-24 15:08:16 -05:00
Patrick Reader
2b7461eb52
fix broken links due to master -> main branch rename (#71426) 2020-08-24 15:39:21 -04:00
flowerysong
66e38bf499
docs: Remove examples using the ec2.py script (#69107)
This script is mostly unmaintained and relies on the deprecated and
unmaintained `boto` library. Featuring it prominently in the docs
leads to many new users using it instead of the supported `aws_ec2`
inventory plugin.
2020-08-21 14:50:09 -05:00
Sandra McCann
6c48c62f93
document securing editor for vault (#71404) 2020-08-21 13:42:53 -05:00
Sloane Hertel
fb035da3b2
clarify inventory plugin user documentation (#71387) 2020-08-21 12:26:02 -04:00
Eric G
13ab73cd89
Docs: ansible_host can contain FQDN (#71186) 2020-08-21 12:14:18 -04:00
David M. Lee
3e4377300b
Explain duplicate checks includes tags and when (#68183)
##### SUMMARY
Per #67913, when comparing dependencies, Ansible takes into account parameters, tags and the when clause in determining whether a role is a duplicate or not.

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2020-08-21 11:49:43 -04:00
Sloane Hertel
1425e3597b
Allow meta tasks to use tags (#67508)
* Support tags for explicit meta tasks

Add --list-tasks tests for meta tags

Add breaking_changes changelog fragment and porting guide
2020-08-21 11:08:49 -04:00
Abhijeet Kasurde
59b80b9146
docs: Update Kubernetes Guide (#71372)
Fixes: #61681

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-21 10:37:03 -04:00
Andrew Klychkov
5498b0bb71
Documentation: improve dev_guide/testing_integration.rst (#71370) 2020-08-20 15:24:22 -04:00
Felix Fontein
a479b003e8
Fix module links. (#71030) 2020-08-20 14:08:41 -04:00
Andrew Klychkov
b82889eef5
Add note about integration tests for new modules to the dev guide (#71345) 2020-08-20 10:15:08 -04:00
Sandra McCann
74f88c56a5
quick fix to change main back to devel (#71342)
* quick fix to change main back to devel
* Update docs/docsite/rst/dev_guide/developing_collections.rst

Co-authored-by: Felix Fontein <felix@fontein.de>
2020-08-19 15:26:12 -05:00
Rick Elrod
ea58d7c233
Make it so callback plugins can act on implicit/explicit meta tasks (#71009)
Change:
- Now sends meta tasks to the task start callback
- Lets callback plugins opt-in to receiving implicit tasks

Test Plan:
- New integration tests

Tickets:
- Indirectly fixes #71007 by allowing custom callbacks with this data

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-18 16:56:48 -05:00
Abhijeet Kasurde
a1257d75aa
network: Correct documentation (#71246)
ini-style inventory does not support Ansible Vault password.
This fixes network_best_practices_2.5 doc.
Fixes: #69039

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-18 15:34:25 -05:00
Abhijeet Kasurde
4f993922c8
Add documentation about info/facts module development (#71250)
Fixes: #40151

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-18 15:56:43 -04:00
Sandra McCann
f79a7c5585
Update Network Getting Started for FQCN/collection world (#71188)
* pull out network roles, cleanup, update first playbook examples, update gather facts section, some inventory conversion to .yml, update inventory and roles, simplify the navigation titles, fix tocs, feedback comments
2020-08-18 14:14:32 -05:00
Alicia Cozine
5073cfc8bc
incorporate minimalism feedback on debugging page (#71272)
Co-authored-by: bobjohnsrh <50667510+bobjohnsrh@users.noreply.github.com>
2020-08-18 14:16:36 -04:00
Alicia Cozine
02ea80f6d7
tidies up vars page (#71339) 2020-08-18 14:01:03 -04:00
Sayee
4d68efbe24
Writing style updates to Using Variables topic (#71194)
* updated topic title, underline length for headings, and incorporated peer feedback
2020-08-18 11:25:33 -05:00
Andrew Klychkov
180507c62b
dev_guide: improve developing_collections.rst (#71332) 2020-08-18 12:07:27 -04:00
Remi Verchere
824cd4cbeb
Update ansible european IRC channel (#71326)
Signed-off-by: Rémi VERCHERE <remi@verchere.fr>
2020-08-17 17:06:48 -05:00
Abhijeet Kasurde
606604bb97
Add warning about copyright year change (#71251)
To simplify project administration and avoid any legal issues,
add a warning in the docs. This reflects - https://github.com/ansible/ansible/issues/45989#issuecomment-423635622 and fixes: #45989

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-17 15:44:06 -05:00
Sayee
ecd3b52ad7
Writing style updates to Developing dynamic inventory topic (#71245)
* modified the writing style

* incorporated peer feedback
2020-08-17 14:16:19 -05:00
Abhijeet Kasurde
ecea018506
Fix 404 links (#71256)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-17 13:52:45 -04:00
Felix Fontein
ee48e0b0ad
Fix roadmap formatting. (#71275) 2020-08-17 13:50:22 -04:00
Felix Fontein
61b7f234bd
Update auto-generated 2.10 porting guide in devel. (#71276) 2020-08-17 13:49:38 -04:00
Andrew Klychkov
a496b89d6f
overview_architecture.rst: fix playbook example (#71303) 2020-08-17 13:44:05 -04:00
Andrew Klychkov
9296ee9329
developing_modules_in_groups.rst: add note about releasing (#71305) 2020-08-17 13:43:15 -04:00
Baptiste Mille-Mathias
92d59a58c0
Fix code markups and add link to CVE (#71082) 2020-08-17 10:55:30 -04:00
Toshio Kuratomi
e507c127e5
Move 2.10.0rc1 release date a few days forward. (#71270)
At yesterday's meeting it was decided to have ansible-2.10.0 depend on
ansible-base-2.10.1 so that we can get several fixes for ansible-base's
routing (including adding the gluster.gluster collection).
ansible-base-2.10.1 will release on September 8th.  So we will plan on
releasing ansible-2.10.0rc1 on the 10th.

https://meetbot.fedoraproject.org/ansible-community/2020-08-12/ansible_community_meeting.2020-08-12-18.00.html
2020-08-13 17:21:36 -05:00
Sayee
4f0bd5de38
a few writing style updates (#71212) 2020-08-13 10:53:29 -05:00
Sandra McCann
553ccedcd3
Update release page for ansible and ansible-base (#71229)
* [docs] 2.7 is EOL, add 2.10 which is almost out
- Remove 2.7 support from the maintenance schedule
- Add 2.10 which is in RC and will be out soon enough.
Signed-off-by: Rick Elrod <rick@elrod.me>

* Update docs/docsite/rst/reference_appendices/release_and_maintenance.rst, fix table and separate ansible-base from ansible, fix rstcheck errors, clean up sections, explain the two packages
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Rick Elrod <rick@elrod.me>
2020-08-12 15:51:38 -05:00
Alicia Cozine
ae3b8eec12
Adds fest link (#71241)
* adds two possible links to AnsibleFest - pick one

* selected preferred text

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-08-12 16:44:56 -04:00
Sam Doran
888be697cb
Revert "Change default file permissions so they are not world readable (#70221)" (#71231)
* Revert "Change default file permissions so they are not world readable (#70221)"

This reverts commit 5260527c4a.

* Revert "Fix warning for new default permissions when mode is not specified (#70976)"

This reverts commit dc79528cc6.
2020-08-12 12:29:04 -05:00
Andrew Klychkov
19589db10c
Fix references to Ansible Collections Overview (#71227) 2020-08-12 12:06:22 -04:00
Sayee
7195788ffe
updates per writing style (#70978)
* updated to follow IBM and Ansible style guides
* modified heading underlines
* incorporated peer review feedback
2020-08-10 17:39:34 -05:00
Abhijeet Kasurde
0a7ab396c7
filters: minor doc fix (#71178)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-10 16:32:15 -04:00
Sandra McCann
172230d7b8
update Ansible-maintained platform guides with FQCN (#70369)
* update platform guides with FQCN
* implemented feedback
* fix remainin fqcn
* Update docs/docsite/rst/network/user_guide/platform_netconf_enabled.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-08-10 15:09:35 -05:00
Sandra McCann
f4388de14d
add another resource module example (#71162)
* Update docs/docsite/rst/network/user_guide/network_resource_modules.rst
Co-authored-by: Nilashish Chakraborty <nilashishchakraborty8@gmail.com>
2020-08-10 11:18:43 -05:00
Håkon Solbjørg
e72e12aa27
docs: 'ansible_play_hosts' lists active hosts, not limited by serial (#71116)
ansible_play_batch lists the currently targeted host(s) in the serial/batch, while
ansible_play_hosts lists all the hosts which will be targeted by the play.
2020-08-10 09:42:45 -05:00
Brian Coca
f46b124d65
start of 'data manipulation' examples (#46979)
Co-authored-by: Klaus Frank <agowa338@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-10 10:18:41 +05:30
kshitijcode
5f8b45a70e
Updating Getting Started with Resources section #68962 (#71102)
* Updating Getting Started with Resources section #68962
* Add links, including Workshops URL #68962
2020-08-07 16:09:19 -05:00
Sandra McCann
56748a8060
remove network for 2.10 base porting guide (#71158) 2020-08-07 14:27:01 -05:00
Sandra McCann
abe4a1d533
remove network section from base porting guide (#71157) 2020-08-07 14:26:49 -05:00
Toshio Kuratomi
0a9638ce4b
Update the porting guide for ansible-2.10.0a8 (#71141) 2020-08-07 12:22:02 -04:00
Daniel Finneran
fb9c9570d5
Fixes due to branch being renamed (#71115)
The ansible collection repository correctly renamed their default branch from `master` to `main`, which has caused a number for broken urls. This PR fixes those urls.
2020-08-06 14:14:27 -05:00
Liviu Chircu
cb9336ab6d
Docs: Fix typo (#71119)
Fix typo
2020-08-06 14:12:33 -05:00
Rick Elrod
4e55b93613
virt facts: allow guest/host to have >1 virt tech (#70832)
Change:
- Allow systems to declare multiple virt techs. For example if a system
  is both a docker container, but virtualized on KVM, show both. If a
  system is set up to run virtualbox and KVM VMs, show both.

- This is done by introducing new facts keys:
  - virtualization_tech_guest
  - virtualization_tech_host

- Backwards compatibility is preserved by keeping track of the previous
  return-points and refusing to update those keys after we would have
  returned, but now returning them at the end, so that the new keys can
  accumulate their data.

Test Plan:
- Local
- CI

Tickets:
- Refs #66304
- Refs #17151
- Refs #17058
- Probably others

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-06 09:45:37 -05:00
Toshio Kuratomi
fb144c4414
Update ansible doc formats (#71070)
* Fix tty_ify bugs and refactor

* Move tty_ify() and supporting attributes to the DocCLI class as that's
  the only thing using it.
* Add unittest for the code.
* Fix a bug where the substitution macros can be detected when they are
  a part of another word.
* Add support for L(), R(), and HORIZONTALLINE which were added to the
  website docs many years ago.

* Update test/units/cli/test_doc.py

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

Co-authored-by: Matt Clay <matt@mystile.com>
2020-08-05 10:53:25 -07:00
Sandra McCann
72d3d44163
add note to uninstall older versions of ansible for pip (#71023)
* add note to uninstall older versions of ansible for pip

* combine with the other PR
2020-08-04 13:39:24 -05:00
Rick Elrod
0d7c144ce4
Allow macOS ACLs to work for unpriv -> unpriv (#70785)
Change:
- Use `chmod +a` in the fallback chain to allow MacOS to use ACLs to
  allow an unprivileged user to become an unprivileged user.

Test Plan:
- CI, new tests

Tickets:
- Fixes #70648

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-04 14:32:48 -04:00
Jeff Groom
79f7104556
Update platform_index.rst (#70927) 2020-08-04 14:31:37 -04:00
Abhijeet Kasurde
0055673c70
VMware: Inventory scenario guide for hostnames (#71055)
Added a scenario guide for ``hostnames`` parameter
for vmware_vm_inventory.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-04 14:30:33 -04:00
Sloane Hertel
a9eb8b0488
Add some documentation for the format of meta/runtime.yml (#71035)
* Document the format of meta/runtime.yml

* Document multiple Ansible versions

Clarify difference between deprecation and tombstone fields

* add note
2020-08-04 11:25:08 -04:00
Rick Elrod
7f62a9d7b5
Make cache adjudicator's flush call plugin flush (#70987)
Change:
- Previously CachePluginAdjudicator#flush only removed entries from the
  cache backend that it knew about by using them earlier. Now it calls
  the underlying plugin's flush() method.

Test Plan:
- New unit tests

Tickets:
- Fixes #68770

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-03 17:16:15 -05:00
Brian Coca
11a31e99e6
added note about fakeroot (#71018)
see #70895
2020-08-03 16:36:26 -04:00
Nathaniel Case
a0523e5b8a
Update documentation of httpapi's handle_httperror method for clarity (#70991) 2020-08-03 16:35:00 -04:00
Alicia Cozine
4f4436c124
updates changelog types; some updates for easier translation (#71027)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
2020-08-03 13:46:41 -04:00
Toshio Kuratomi
e10902d744
Add the ansible_2_10 intersphinx reference. (#71028)
There are links from the scenario guides to collections but collections
docs aren't built in testing or locally when we're on the devel branch.
Due to that we need to make sure those references resolve to the
production docsite.  We can use intersphinx to make sure that happens.

* The test for binary files wasn't reading enough of the file.

Checking for null bytes in the first 1024 bytes failed to diagnose the
ansible_2_10.inv file as binary
2020-08-03 12:31:36 -05:00
Abhijeet Kasurde
a6725d6e2a
docs: Add a note about package requirements for fact gathering (#70796)
Fixes: #26148

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-03 12:09:40 -05:00
Terciero
864573a38d
Document common return values with examples (#71046)
* adding return value examples
* shift to console code blocks
* cleaning up whitespace and shortening invocation example
* reordering diff section
2020-08-03 11:51:58 -05:00
Brendon O'Sullivan
9850915bd6
Update intro_getting_started.rst (#71039)
Added two additional learning resources in the See also: section- forgot closing backticks
2020-08-03 10:35:36 -05:00
Rick Elrod
701c638757
Document string tests a bit more (#71049)
- Explain how `regex` differs from `match` and `search`.
- Document `multiline` and `ignorecase`.

Signed-off-by: Rick Elrod <rick@elrod.me>
2020-08-03 10:19:20 -05:00