devon-mar
e97f333532
Add missing endfor to vlan_parser example ( #72872 )
2020-12-08 16:25:56 +01: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
2aa3531b1b
Docsite: update complex_data_manipulation and playbooks_advanced_syntax rst files to use FQCNs ( #72539 )
2020-12-02 10:29:49 -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
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
Brian Coca
452bc3af04
example of exponential backup ( #72617 )
2020-11-13 16:00:21 -05: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
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
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
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
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
Sandra McCann
7c1dd1c7fb
add link to jinja docs from templating section ( #72205 )
2020-10-12 13:52:24 -05:00
Andrew Klychkov
30a651bca3
Docsite: update user_guide/playbooks_async ( #72115 )
2020-10-09 10:50:58 -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
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
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
Abhijit Menon-Sen
64d9ccb965
Reword strangely patronising introduction to loops ( #72019 )
2020-09-30 16:05:46 -04: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
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
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
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
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
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
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
Evaristo Rojas
00ed5b1f2e
Fix broken bullet list ( #71728 )
2020-09-15 16:04:07 -04:00
Andrew Klychkov
13ab9f5932
Docsite: improve playbooks_loops.rst ( #71718 )
2020-09-15 16:00:09 -04:00
Andrew Klychkov
5511c898cc
Docsite: fix a typo in user_guide/index.rst ( #71717 )
2020-09-15 11:31:38 -04: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
Matt Martz
61f6aa55b6
Add semver support to the jinja2 version test ( #71600 )
2020-09-08 08:52:27 -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
Alicia Cozine
96aee766f4
More docs updates to reflect collections ecosystem ( #71597 )
2020-09-02 13:50:12 -04:00
Alicia Cozine
b694dbadfe
User guide overhaul, Table of Contents ( #71553 )
2020-09-01 12:29:21 -04: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
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
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
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
Abhijeet Kasurde
ecea018506
Fix 404 links ( #71256 )
...
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-08-17 13:52:45 -04:00
Sayee
4f0bd5de38
a few writing style updates ( #71212 )
2020-08-13 10:53:29 -05:00
Andrew Klychkov
19589db10c
Fix references to Ansible Collections Overview ( #71227 )
2020-08-12 12:06:22 -04: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
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
Liviu Chircu
cb9336ab6d
Docs: Fix typo ( #71119 )
...
Fix typo
2020-08-06 14:12:33 -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
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
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
Baptiste Mille-Mathias
8c48366f1c
Document to_json will convert to ASCII strings by default ( #70954 )
...
... as reported in issue #68702
2020-07-30 14:45:40 -05:00
Emilien Macchi
37e9d2278a
Fix a typo in "restart mysql" example ( #70950 )
...
Fix a typo in "restart mysql" example task. It's missing a space between "state:" and "restarted".
2020-07-29 11:46:16 +05:30
Fixmetal
7a42d27462
Proper example for splitext filter in docs ( #70494 )
...
* Update playbooks_filters.rst with a clear example of how to extract its 2 tokens.
Co-authored-by: Sloane Hertel <shertel@redhat.com>
2020-07-23 15:07:55 -05:00
Sandra McCann
24e5d3a51c
fix rstcheck problem and gitignore collections dir ( #70764 )
2020-07-21 15:59:56 -05:00
David Rieger
633c2d0522
Fix misleading documentation for naming blocks ( #68458 )
...
From what I have observed it is the block itself that doesn't support the name attribute rather than the tasks inside the block.
* Update docs/docsite/rst/user_guide/playbooks_blocks.rst
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2020-07-20 09:48:53 -05:00
Toshio Kuratomi
9dda393d70
Collections docs generation ( #59761 )
...
* Build documentation for Ansible-2.10 (formerly known as ACD).
Builds plugin docs from collections whose source is on galaxy
The new command downloads collections from galaxy, then finds the
plugins inside of them to get the documentation for those plugins.
* Update the python syntax checks
* docs builds can now require python 3.6+.
* Move plugin formatter code out to an external tool, antsibull-docs.
Collection owners want to be able to extract docs for their own
websites as well.
* The jinja2 filters, tests, and other support code have moved to antsibull
* Remove document_plugins as that has now been integrated into antsibull-docs
* Cleanup and bugfix to other build script code:
* The Commands class needed to have its metaclass set for abstractmethod
to work correctly
* Fix lint issues in some command plugins
* Add the docs/docsite/rst/collections to .gitignore as
everything in that directory will be generated so we don't want any of
it saved in the git repository
* gitignore the build dir and remove edit docs link on module pages
* Add docs/rst/collections as a directory to remove on make clean
* Split the collections docs from the main docs
* remove version and edit on github
* remove version banner for just collections
* clarify examples need collection keyword defined
* Remove references to plugin documentation locations that no longer exist.
* Perhaps the pages in plugins/*.rst should be deprecated
altogether and their content moved?
* If not, perhaps we want to rephrase and link into the collection
documentation?
* Or perhaps we want to link to the plugins which are present in
collections/ansible/builtin?
* Remove PYTHONPATH from the build-ansible calls
One of the design goals of the build-ansible.py script was for it to
automatically set its library path to include the checkout of ansible
and the library of code to implement itself. Because it automatically
includes the checkout of ansible, we don't need to set PYTHONPATH in
the Makefile any longer.
* Create a command to only build ansible-base plugin docs
* When building docs for devel, only build the ansible-base docs for
now. This is because antsibull needs support for building a "devel
tree" of docs. This can be changed once that is implemented
* When building docs for the sanity tests, only build the ansible-base
plugin docs for now. Those are the docs which are in this repo so
that seems appropriate for now.
2020-07-17 13:07:35 -07:00
Alicia Cozine
db354c0300
Docs: User guide overhaul, part 5 ( #70307 )
2020-07-14 17:00:44 -04:00
Karl Goetz
c410311f55
Clarify that index_var is 0 indexed ( #70548 )
...
A little further down the page is another index, ansible_loop.index, which shares a similar description but is 1 indexed.
Its zero indexed twin has a 0 suffix.
``ansible_loop.index`` The current iteration of the loop. (1 indexed)
``ansible_loop.index0`` The current iteration of the loop. (0 indexed)
To remove ambiguity around the usage of index_var, explicitly mention that this variable is 0 indexed.
2020-07-13 14:15:44 -05:00
mahadelmi
f4ea43c4a0
Update windows_winrm.rst ( #70306 )
...
gcc also needed to be installed alongside python-devel, krb5-devel, krb5-libs, and krb5-workstation.
2020-07-13 13:43:39 -05:00
FloMiau
f7db428375
update documentation link to python 3 ( #70509 )
...
update the docs link for strftime on the filters page to point to the python3 docs
2020-07-09 11:58:39 -05:00
David Shrewsbury
4e41e37aa7
Fix flatten null perserve versionadded ( #70435 )
2020-07-02 13:28:39 -05:00
Baptiste Mille-Mathias
9eb904ea61
Add documentation for ipaddr filters ( #70343 )
2020-07-02 11:17:46 -04:00
jafiala
7c90a2d2a6
Update playbooks.rst ( #70317 )
2020-07-02 11:11:09 -04:00
Brian Coca
7a15a3a109
fix flatten handling of nulls/nones ( #70141 )
...
* fix flatten loop control issue (break -> continue)
fix issue #69012
(cherry picked from commit 2127be5ec5fixes #69012
fixes #69013
Co-authored-by: pseudocoder <borisovano@users.noreply.github.com>
Co-authored-by: David Shrewsbury <Shrews@users.noreply.github.com>
2020-07-01 18:52:03 -04:00
Brian Coca
5d3d097de3
more correct info about role main.yml ( #70326 )
...
fixes #40496
2020-07-01 16:16:21 -04:00
Alicia Cozine
c89f3cda9e
incorporate minimalism feedback on filters page ( #70366 )
...
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2020-07-01 16:15:32 -04:00
Rick Elrod
91aea92c62
Add ability to fallback to chgrp remote_tmp and its files. ( #68627 )
...
* Add ability to fallback to chgrp remote_tmp and its files.
Signed-off-by: Rick Elrod <rick@elrod.me>
2020-07-01 15:16:56 -04:00
Mark Sanders
dc6f4b6502
Fix bullet points in intro_getting_started.rst. ( #70365 )
...
The layout was jumbled due to issues with whitespace.
2020-06-29 14:05:05 -05:00
