1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

1333 commits

Author SHA1 Message Date
Yannik
767856c463 fix typo 2016-02-28 22:19:20 +01:00
Yannik
192e22f6f4 fix typo 2016-02-28 10:11:07 +01:00
Jun Matsushita
de0e7de15c Updated versions with current released and development 2016-02-27 12:39:58 +01:00
Brian Coca
b0bed27211 minor doc fixes 2016-02-26 16:46:26 -05:00
Brian Coca
e60fef4dbe Merge pull request #14660 from dagwieers/doc-hybrid-plugin
Added a section wrt. hybrid plugins and provide an example for lookup…
2016-02-25 17:19:46 -05:00
Brian Coca
fbdcb22e36 now generate list of playbook ojbect directives
TODO: needs links/info and conditionals added
2016-02-25 16:48:37 -05:00
Dag Wieers
e5600ee204 Turn it in correct reStructuredText
Why not AsciiDoc is beyond me, as it is much easier for documentation.
2016-02-25 17:12:24 +01:00
Dag Wieers
c1d90e3f2d Added a section wrt. hybrid plugins and provide an example for lookup plugins 2016-02-25 17:01:28 +01:00
Brian Coca
03c33053aa clarified become options do not imply others
fixes #14635
2016-02-24 10:58:40 -05:00
brianlycett
4160a3f40b Update YAMLSyntax.rst
A brief explanation was added regarding multi-line values.
2016-02-24 15:06:21 +00:00
James Cammarata
8e0c8ffe7b Merge pull request #14512 from scottsb/patch-1
Fix leftover references to sudo instead of become
2016-02-24 09:18:32 -05:00
Matt Martz
3ac0143cf1 Merge pull request #13654 from sivel/paramiko-proxy-command
Add ProxyCommand support to the paramiko connection plugin
2016-02-23 11:30:43 -06:00
Matt Martz
38b663471d Merge pull request #14311 from sivel/unsafe-yaml-constructor
Add new 'unsafe' YAML constructor
2016-02-23 11:29:53 -06:00
Strahinja Kustudić
28b4f2a595 Adds ANSIBLE_VAULT_PASSWORD_FILE to the documentation site 2016-02-23 14:38:47 +01:00
James Cammarata
283532e11d Updating IRC channel list in community doc 2016-02-22 13:24:08 -05:00
Matthew Huxtable
b59b5a286b docsite: add missing closing square bracket 2016-02-22 16:07:48 +00:00
Sandra Wills
11f081cb99 minor typo fix
missing "the" added to 2.x listing to match wording for 1.x
2016-02-19 10:35:43 -05:00
Sandra Wills
c172a289e4 light editing of variable precedence list wording
QA had asked me a while ago to clean up the way the precedence list for 1.x was worded,
as the intro from the list started with "then comes", as if something should preceed
it. The comments from OxABAB were not helpful themselves, but his issue reminded me that
this was on my to do list to make a little cleaner and clearer.  Edits made to remove the
"then comes" intros for each list line, to help with clarity.
2016-02-19 10:32:34 -05:00
Toshio Kuratomi
86b8dc0e79 Add a configuration setting that allows the user to specify printing of task arguments in the header.
Fixes #14554
2016-02-18 04:20:35 -08:00
Michael Scherer
4102812a69 Remove spurious 'either', fix #14520 2016-02-17 11:13:59 +00:00
Scott Buchanan
71dffbc28f Fix leftover references to sudo instead of become
Catching a few places that earlier PR #10788 missed.
2016-02-16 16:19:26 -05:00
brianlycett
665e158ec0 Update YAMLSyntax.rst
Updated to include a bit more depth in explaining the YAML, along with a link the Wikipedia page on YAML syntax.
2016-02-16 16:40:44 +00:00
Adam Hartz
cebf127d68 Change reference to basic.py, where the implementation details live 2016-02-16 10:32:57 -05:00
Adam Hartz
327b27ba1c Update stated location of common_module.py 2016-02-16 09:48:40 -05:00
Kamal Wood
0c1395ed2f Documenting that values passed in using the extra-vars 'key=value' syntax are interpreted as strings. 2016-02-15 14:13:39 +00:00
Illia Krauchanka
889c273ac4 Update playbooks_lookups.rst 2016-02-15 15:53:34 +03:00
Brian Coca
4b953c4b16 extended api example with more options in tasks
also adopted to less requried options
2016-02-13 20:15:56 -05:00
Anton Belonovich
d24761af1b Update playbooks_roles.rst 2016-02-12 00:01:36 +03:00
Timothy Hopper
f014b548e4 Link to /videos instead of the less obvious /resources 2016-02-11 10:34:39 -05:00
Brian Coca
50dfd4b057 fixed bad tag example 2016-02-05 15:48:56 -05:00
Dag Wieers
0a20c53ed6 A few more typos
I came across another typo, and fixed similar ones in the docs.
2016-02-05 18:38:56 +01:00
Dag Wieers
2f411557f5 Fix small typo
While reading one of the docs I found this small typo.
2016-02-05 13:54:58 +01:00
Brian Coca
597638c401 revamped become page
its not only for the 'upgrade from 1.8' anymore, become is the
official way to do things and now presents as such, no need to know
about previous options, but still keep info there for those that
were using them..
2016-02-04 20:36:20 -05:00
Brian Coca
3d894b0f13 corrected mizpellz 2016-02-04 20:10:37 -05:00
Brian Coca
d6283129e1 corrections and additions to porting guide
fixes in syntax to what is now allowable
added section from user feedback
2016-02-04 19:39:56 -05:00
Brian Coca
7037f793b9 Expain our commitment to API 2016-02-04 19:39:56 -05:00
Matt Martz
5cd4afaa1d Add documentation about the unsafe YAML tag 2016-02-04 11:54:23 -06:00
Brian Coca
c433289a8b clarified how block applies directives to tasks
previous text could be interpreted as the block itself doing the evaluation and skipping
2016-02-03 14:34:08 -05:00
Greg Taylor
96e22970ee Fix a note tag in the API docs. 2016-02-02 09:58:08 -08:00
Brian Coca
0e551e6d46 clarified ansible_shell_type description 2016-02-02 11:00:31 -05:00
Brian Coca
6105c8c77c corrected name of inventory_hostnames lookup plugin 2016-02-02 09:41:21 -05:00
Toshio Kuratomi
9e3932ffca Some attributes of callbacks aren't in v2. Port plugins to the v2 way to do that
Update porting guide with info on callback porting
2016-01-29 19:45:12 -08:00
Brian Coca
f26673904f updated intro adhoc to use become 2016-01-29 17:46:18 -05:00
Brian Coca
4b1d621442 Merge pull request #14173 from sradvan/doc-fix-bsd-intro
grammar fixes; capitalize where necessary; general clean-up
2016-01-28 15:53:00 -05:00
Scott Radvan
ba9e5fa6ba grammar fixes; capitalize where necessary; general clean-up 2016-01-28 21:58:49 +13:00
Darren Tong
90c14644b0 Fixing typo depricated for deprecated. 2016-01-27 23:22:27 -08:00
James Cammarata
39b4117816 Merge pull request #14153 from oneswig/doc-ipaddr-add-subnet-masks
Details on how to convert subnet masks into CIDR
2016-01-27 16:34:03 -05:00
Brian Coca
a928465c9e added note about 1.9 ppa 2016-01-27 16:26:44 -05:00
Stig Telfer
326ae21089 Details on how to convert subnet masks into CIDR
Use data reported by Ansible network facts as an example.
2016-01-27 12:14:50 +00:00
Brian Coca
4dc3441cdb Merge pull request #14102 from senk/fix_docu
Fixes documentation formatting
2016-01-25 14:33:23 -05:00
Matthew Seaman
043b2cbcb4 Change example to use pkg rather than the obsolete pkg_add
pkg_add has been obsoleted in all released versions of FreeBSD for
several years.  Change the example to use the appropriate pkg(8)
command line.
2016-01-25 16:20:17 +00:00
Robin Naundorf
6cc7f7890f Fixes documentation formatting
Fixes documentation formatting
2016-01-25 11:51:30 +01:00
James Cammarata
6b166a1048 Merge pull request #14071 from rozha/devel
Fix server numbers in first 10 next 10 example
2016-01-23 09:30:37 -05:00
Ilya Novickov
46bd5a0d9c Fix server numbers in first 10 next 10 example 2016-01-22 18:50:41 +08:00
Greg DeKoenigsberg
f3336fba44 Tweaking Python 2.4 requirement 2016-01-21 13:02:03 -05:00
Greg DeKoenigsberg
981e9c44ba Put Python 2.4 in checklist
It's in the travis check, but we don't spell it out explicitly in the guidelines.
2016-01-21 12:22:26 -05:00
Greg DeKoenigsberg
a10e15c765 Update developing_test_pr.rst 2016-01-20 10:29:25 -05:00
Greg DeKoenigsberg
a4f91c2c53 format fix for github markup 2016-01-20 10:27:37 -05:00
Greg DeKoenigsberg
b900c104b9 Adding submodule help 2016-01-20 10:25:49 -05:00
Brian Coca
3750af45d4 clarified with_file 2016-01-19 21:20:24 -05:00
Brian Coca
742bd2c554 clarify role include paths 2016-01-19 08:49:16 -05:00
Brian Coca
11ca4e6282 Merge pull request #13934 from dlangille/dlangille-patch-2
Specify the correct default options for sudo_flags
2016-01-18 17:42:39 -05:00
Brian Coca
1c9774785f Merge pull request #13923 from slimandslam/patch-1
Added example of running commands on a remote Windows Server
2016-01-18 17:26:50 -05:00
Dan Langille
2765708450 Specify the correct default values for sudo_flags
The correct default options for sudo_flags can be found at: https://github.com/ansible/ansible/blob/devel/lib/ansible/constants.py#L181

Slightly alter explanation of '-H' so as not to confuse it with -E, --preserve-env (which preserves existing environment variables).

When adding the two other options, include short explanations of those options.

Add note about '-n', which did not appear in 1.x I believe, and which bit me.
2016-01-16 15:28:41 -05:00
Dan Langille
2cde16a06c Add correct default options for sudo_flags
see https://github.com/ansible/ansible/blob/devel/lib/ansible/constants.py#L181
2016-01-16 14:37:04 -05:00
Ryan Groten
e6ab0daa4b minor wording fixes 2016-01-15 14:11:17 -07:00
J Levitt
8e059d058b Added example of running commands on a remote Windows Server
Added example of running commands on a remote Windows Server
2016-01-15 14:17:23 -06:00
Brian Coca
ec95f50cb6 updated docs with new test grammer examples 2016-01-14 12:29:02 -05:00
Brian Coca
4de4d59d7a changed examples to not use 'port' directive 2016-01-13 18:06:55 -05:00
Toshio Kuratomi
f72d380bcf Specify all variables in the description to make it more clear 2016-01-13 13:15:08 -08:00
Toshio Kuratomi
be9d817618 Make example of deprecated args clearer 2016-01-13 12:35:28 -08:00
Brian Coca
739e4c0386 corrected info about windows module naming and loc 2016-01-13 10:32:36 -05:00
jfrappier
21ac96fa35 Updated intro_getting_started.rst to reference --ask-become-pass 2016-01-12 21:51:47 -05:00
Toshio Kuratomi
a3dcd99d96 Documentation fixes 2016-01-12 12:00:00 -08:00
Brian Coca
d9d4ad828a zpell the corerstly 2016-01-12 14:07:39 -05:00
Brian Coca
2374abbeda api not thread safe
also removed runner ref in general description as it is now a 1.x only thing.
2016-01-12 14:05:33 -05:00
Brian Coca
06b0161e6d fixed extract version 2016-01-12 13:26:46 -05:00
Toshio Kuratomi
cacc22abbb Add the porting guide 2016-01-11 13:58:39 -08:00
Brian Coca
a12164497b Merge pull request #13726 from teolupus/devel
Added OpenStack dynamic inventory example
2016-01-11 16:07:27 -05:00
Brian Coca
f8b06e1613 Merge pull request #13785 from claremacrae/patch-1
Fixed typo: Integerations -> Integrations
2016-01-11 14:36:56 -05:00
James E. Blair
51255aed9b Fix typo in API docs
This typo caused a SyntaxError when attempting to run the example
in the API docs.
2016-01-11 09:48:25 -08:00
Clare Macrae
04ace28f6d Fixed typo: Integerations -> Integrations 2016-01-09 22:34:03 +00:00
Brian Coca
41a417be1f noted that regex_escape was added in 2.0
fixes #13759
2016-01-07 19:02:49 -05:00
Sebastian Thiel
28be222ff0 correct invocation of launchctl
When I executed `launchctl limit maxfiles 1024 2048` , my entire system would become unusable, as all of the sudden no process could use any file anymore, reporting that the max file limit was reached.
Only a hard reboot could fix the problem, which fortunately revealed that the configuration was not saved.

The change I made *should* remedy the issue, even though I didn't test it.
Therefore I hope you can revise the documentation to be sure nothing bad happens.

# Meta

Tested on OSX 10.11.2
2016-01-07 16:55:41 +01:00
Michael
519952d7d7 Fix module name 2016-01-07 00:08:49 -08:00
Bruno Almeida do Lago
9e32099b5e Added OpenStack dynamic inventory example
Added an example illustrating how to use the OpenStack dynamic inventory script
to the "Dynamic Inventory" section.
2016-01-05 16:48:49 +13:00
Fuentes, Christopher
de529c1734 minor grammar error was making me pull hair out 2016-01-04 13:52:06 -05:00
mgarstecki
5accc98587 Correction of a double negation
The sentence seemed to imply that return codes from modules are significant, while they are not. The second part of the sentence confirms this, as it advises to use standard return codes only for future proofing.
2015-12-30 11:57:12 +01:00
Brian Coca
2000566031 minor fix to become docs 2015-12-28 10:24:49 -05:00
Brian Coca
395bfec2f9 Merge pull request #13670 from stephen144/patch-1
intro_adhoc.rst: clarify idempotence explanation
2015-12-28 10:20:08 -05:00
Brian Coca
c489b271d1 updated release cycle to 4 months instead of 2 2015-12-27 14:18:07 -05:00
Stephen Medina
cd9e18d0e5 clarify idempotence explanation
Small typo; wasn't sure what to replace it with.
2015-12-25 08:56:08 -08:00
Matt Martz
630a35adb0 Add ProxyCommand support to the paramiko connection plugin 2015-12-23 15:15:07 -06:00
Brian Coca
b201cf2ee1 switched from pythonic None to generic null 2015-12-23 10:30:24 -05:00
Matt Roberts
809c9af68c Update playbooks_intro.rst
If you follow the documentation through in order you shouldn't have 
read about modules yet.
2015-12-23 08:18:46 +00:00
Toshio Kuratomi
b33f72636a Also remove the bool casting function info (transparent to module writer now) 2015-12-22 07:25:50 -08:00
Toshio Kuratomi
b310d0ce76 Update the developing doc to modern method of specifying bool argspec values 2015-12-22 07:23:51 -08:00
Brian Coca
eb16e11253 Merge pull request #13613 from azaghal/devel-13126-dig_lookup_documentation
Adding documentation for the 'dig' lookup (#13126).
2015-12-21 13:46:02 -05:00
Brian Coca
593d80c63d role search path clarified 2015-12-21 13:15:12 -05:00
Branko Majic
6ec58bbd5f
Adding documentation for the 'dig' lookup (#13126). 2015-12-20 14:19:20 +01:00
James Cammarata
491fd754f1 Updating the porting guide to note the complex args/bare vars change
Related to #13518
2015-12-16 16:36:16 -05:00
James Cammarata
76b4b9ed2c Merge pull request #13501 from chouseknecht/galaxy-2.0-update
Galaxy 2.0 update
2015-12-16 15:01:12 -05:00
Chrrrles Paul
851c0058b1 Removing yaml support for path: 2015-12-16 12:45:05 -06:00
David
63b624707d Fix typo 2015-12-16 23:46:06 +08:00
Brian Coca
5d1a2eac3e Merge pull request #13500 from mscherer/fix_markup_doc_modules
Fix the markdown used for the Windows module section
2015-12-14 18:43:18 -05:00
gp
e595c50197 Fix typo in galaxy.rst
Fix typo
2015-12-14 12:06:35 -05:00
chouseknecht
95785f149d Fix docs. The search command works with both galaxy.ansible.com and galaxy-qa.ansible.com. 2015-12-13 05:23:04 -05:00
chouseknecht
06dde0d332 Fixed documentation typos and bits that needed clarification. Fixed missing spaces in VALID_ACTIONS. 2015-12-13 05:23:04 -05:00
chouseknecht
847f454bcc Add a section to intro_configuration for Galaxy. 2015-12-13 05:23:04 -05:00
chouseknecht
342dee0023 Define and handle ignore_certs correctly. Preserve search term order. Tweak to Galaxy docsite. 2015-12-13 05:23:04 -05:00
chouseknecht
f1c72ff8f5 Make sure it is clear that new commands require using the Galaxy 2.0 Beta site. 2015-12-13 05:23:04 -05:00
chouseknecht
989604b1a3 Fix typo. 2015-12-13 05:23:04 -05:00
Usman Ehtesham Gul
4779f29777 Fix Doc mistake
Fix Doc mistake in ansible/docsite/rst/playbooks_variables.rst
2015-12-13 01:24:27 -05:00
Brian Coca
d7b516f75d added releases doc 2015-12-12 13:16:40 -05:00
Brian Coca
0a112a1b06 fixed formating issues with rst 2015-12-12 13:14:14 -05:00
Brian Coca
8db2912745 corrected section anchors 2015-12-12 12:59:00 -05:00
Brian Coca
14f3739260 Merge pull request #13505 from janek-warchol/patch-2
Explain how 'run_once' interacts with 'serial'
2015-12-12 00:29:37 -05:00
Brian Coca
58072c92fb removed 'bare' example in environment
now shows how to use explicit templating
2015-12-11 09:32:19 -05:00
Jan Warchoł
72f0679f68 Explain how 'run_once' interacts with 'serial' 2015-12-10 16:22:37 +01:00
Michael Scherer
fe72fff57d Fix the markdown used for the Windows module section 2015-12-10 02:00:31 +01:00
Toshio Kuratomi
30e729557f Add first draft of porting guide for 2.0 2015-12-09 16:43:41 -08:00
Brian Coca
a61387846d draft release documentation 2015-12-09 14:54:11 -08:00
Toshio Kuratomi
a19e083d33 Note that handlers inside of includes are not possible at the moment 2015-12-09 13:52:01 -08:00
nitzmahone
a7cd41b482 Windows doc updates 2015-12-09 16:30:32 -05:00
Toshio Kuratomi
0211da2fe9 Clarify language of delegate_facts documentation 2015-12-09 08:44:46 -08:00
chouseknecht
4f84769a17 Galaxy 2.0 2015-12-09 10:51:12 -05:00
Brian Coca
c1cec64aa8 added delegate_facts docs 2015-12-08 14:18:38 -08:00
Brian Coca
dcedfbe26c corrected usage of ec2.py's profile option
this was never introduced into ansible-playbook though the docs
stated otherwise. We still explain how to use the env var to get the
same result.
2015-12-07 09:54:55 -08:00
sam-at-github
a96a879fcf Add fullstop to make sentence make sense. Touch parargraph while at it. 2015-12-05 13:06:58 +11:00
Brian Coca
7d073bdd17 Merge pull request #13345 from amenonsen/extract
Add an 'extract' filter
2015-12-03 11:19:06 -08:00
Toshio Kuratomi
9caa2b0452 Revert "Update docs and example config for requiretty + pipelining change"
This reverts commit f873cc0fb5.

Reverting pipelining change for now due to hard to pin down bugs: #13410  #13411
2015-12-03 07:59:23 -08:00
Brian Coca
6559616a04 updated docs for 2.0 api 2015-12-02 12:03:07 -08:00
Brian Coca
abeec3c8b5 Merge pull request #13322 from muffl0n/docs_regex_replace_named_groups
Add example for regex_replace using named groups
2015-12-02 09:43:45 -08:00
Abhijit Menon-Sen
8cf1815867 Add an 'extract' filter
At its most basic, this is nothing more than an array or hash lookup,
but when used in conjunction with map, it is very useful. For example,
while constructing an "ssh-keyscan …" command to update known_hosts on
all hosts in a group, one can get a list of IP addresses with:

    groups['x']|map('extract', hostvars, 'ec2_ip_address')|list

This returns hostvars[a].ec2_ip_address, hostvars[b].ec2_ip_address, and
so on. You can even specify an array of keys for a recursive lookup, and
mix string and integer keys depending on what you're looking up:

    ['localhost']|map('extract', hostvars, ['vars','group_names',0])|first
        == hostvars['localhost']['vars']['group_names'][0]
            == 'ungrouped'

Includes documentation and tests.
2015-12-02 18:16:38 +05:30
Brian Coca
afefaff1a7 Merge pull request #13382 from mscherer/doc_with_inventory
Add a documentation on how to loop over all inventory host
2015-12-01 18:33:59 -08:00
Michael Scherer
c8bac7f54b Remove empty line breaking the formatting of the title 2015-12-02 00:24:14 +01:00
Michael Scherer
517b533d46 Add a documentation on how to loop over all inventory host
Related to #13343
2015-12-02 00:21:10 +01:00
Ming Qian
7724c958e1 Update intro_windows.rst
first pull. thanks.
2015-12-01 11:24:17 -08:00
Toshio Kuratomi
f873cc0fb5 Update docs and example config for requiretty + pipelining change 2015-12-01 10:24:15 -08:00
James Cammarata
d1b5653b53 Merge pull request #13367 from leedm777/patch-1
Corrected group separator
2015-12-01 10:48:08 -05:00
sreekanth
96bd2a4447 Added missing closing quote 2015-12-01 17:30:43 +05:30
David M. Lee
cfdb12c2ec Corrected group separator
The text said comma, but the examples were all colons.
2015-11-30 21:44:18 -06:00
Kerim Satirli
96c6b74754 removes editorial
I feel that Ansible is above the "my hosted Git community is better than yours" discussion and thus removed the editorial around Bitbucket
2015-11-27 10:09:55 +01:00
muffl0n
fa3848a1f2 Add example for regex_replace using named groups 2015-11-26 12:56:30 +01:00
Raphael Badin
20a45ab36d Fix missing word in developing_modules.rst 2015-11-25 18:29:17 +01:00
dizzler
b937018fcd Fix typo in modules_core.rst 2015-11-24 12:49:15 -07:00
René Moser
a9f5837157 docsite: cloudstack: fix missing quotes in example 2015-11-23 07:10:47 +01:00
Matt Davis
8f00d1c698 Merge pull request #13212 from cchurch/recommended_pywinrm_version
Recommend using pywinrm >= 0.1.1 from PyPI instead of GitHub version.
2015-11-20 15:22:04 -08:00
Gilles Cornu
dc60e08aa0 Documentation: Update the Vagrant Guide
This is an attempt to solve #7665.

Revert the change applied by f56a6e0951
(#12310), as the inventory generated by Vagrant still rely on the legacy
`_ssh` setting names for backwards compatibility reasons.
See also https://github.com/mitchellh/vagrant/issues/6570
2015-11-20 21:50:41 +01:00
Chris Church
dea07438b5 Recommend using pywinrm >= 0.1.1 from PyPI instead of GitHub version. 2015-11-18 17:49:21 -05:00