Commit graph

1771 commits

Author SHA1 Message Date
Toshio Kuratomi
287fd29db9 Use better rst markup (main change definition lists instead of code-blocks for config file options 2016-03-18 08:52:21 -07:00
Brian Coca
06e6513276 Merge pull request #15023 from bpsuntrup/documentation_issue_15022
Clarify developing modules documentation
2016-03-18 08:07:55 -07:00
SUNTRUP
3bfb556cb9 Clarify developing modules documentation
This resolves issue #15022. When doing the module tutorial, it might be
necessary for the user to read through the documentation for installing
from source to avoid dependency errors and such.
2016-03-18 09:12:17 -05:00
Toshio Kuratomi
e25caebe7a Cleanups to docs and rename of inv var 2016-03-18 06:42:37 -07:00
Brian Coca
db61e9be0c add ansible_executable inventory var
also handle the overrides appropriately
also new executable to set shell type
2016-03-17 18:54:37 -07:00
Brian Coca
84bbd2b4e3 corrected version added for ansible_version 2016-03-17 07:25:37 -07:00
Abhijit Menon-Sen
0c6693aa4c Merge pull request #14947 from mscherer/add_ansible_version_doc
Add doc on ansible_version, fix #13204
2016-03-17 14:48:50 +05:30
Abhijit Menon-Sen
00312723b2 Merge pull request #14484 from Antillean/extra-vars_docs
Documenting that extra-vars 'key=value' is for strings
2016-03-17 14:46:18 +05:30
Abhijit Menon-Sen
cc7867d1de Merge pull request #11642 from quentinsf/inventory_ignores
Mention inventory_ignore_extensions in the dynamic inventory documentation
2016-03-17 10:11:07 +05:30
Brian Coca
7f8e8ddca9 Merge pull request #14948 from mscherer/fix_doc_lexer
Fix pygments lexer name
2016-03-16 17:13:29 -07:00
Toshio Kuratomi
de708f7199 Document the issue with modules being created world-readable on the client in certain circumstances 2016-03-16 11:06:06 -07:00
Toshio Kuratomi
b6d5c6888b Update link target 2016-03-16 11:04:28 -07:00
Toshio Kuratomi
0ad4ba5fe5 Fix another docs link problem 2016-03-16 11:03:00 -07:00
karimb
6efdaa6f4f Include Ovirt in inventory list 2016-03-16 14:20:27 +01:00
Brian Coca
9be6974d37 Merge pull request #14949 from mscherer/fix_faq_syntax
Fix the lexer used, jinja2 is not valid, jinja is
2016-03-15 22:22:05 -07:00
Toshio Kuratomi
66328e5200 Merge pull request #14967 from ansible/facts-subset-and-cleanup
Facts subset and cleanup
2016-03-15 07:17:58 -07:00
Brian Coca
051b9e7b90 added warning about additional requirements 2016-03-14 22:34:17 -04:00
Toshio Kuratomi
512825455e Make ohai and facter work via module_utils Fact classes rather than in the setup module 2016-03-14 14:53:29 -07:00
Toshio Kuratomi
5a1e35224b Make changes proposed during review of restrict fact gathering feature:
* Make documentation examples into code blocks
* Make code to call the subsets more general.
* Made min subset always execute (cannot disable it).
* Use a passed in modules parameter rather than global modules.  This is needed for ziploader
* Remove unneeded __init__()
* Remove uneeded multiple inheritance from a base class
* gather_facts is now a list type
2016-03-14 14:53:29 -07:00
Yannig Perré
88772b6003 Add a way to restrict gathered facts in Ansible:
- Using gather_subset options
- By ignoring ohai/chef or facter/puppet facts
2016-03-14 14:53:28 -07:00
Michael Scherer
b3d600f1ec Fix the lexer used, jinja2 is not valid, jinja is 2016-03-13 10:03:57 +01:00
Michael Scherer
8b808cab9e Add doc on ansible_version, fix #13204 2016-03-13 09:54:24 +01:00
Michael Scherer
d7f1d865ec Fix pygments lexer name
This prevent the build from sending warnings like this:

    YAMLSyntax.rst:28: WARNING: Pygments lexer name 'YAML' is not known

and actually show real warnings and issues in the documentation
2016-03-13 09:50:52 +01:00
Jason McKerr
5128167ee6 Merge pull request #14862 from mckerrj/devel
Adding committer guidelines to docsite
2016-03-11 15:01:17 -05:00
Jason McKerr
1e85abfcf2 updates based on feedback from docschick and bcoca. 2016-03-11 14:11:06 -05:00
Matt Davis
32a1662ad0 Merge pull request #14910 from mattclay/libvirt-no-selinux
Add noseclabel support to libvirt_lxc plugin.
2016-03-11 00:24:05 +00:00
Matt Clay
ba1bcdfc17 Add noseclabel support to libvirt_lxc plugin. 2016-03-10 15:34:31 -08:00
amesbury
1871f0ec16 Fixed typo 2016-03-10 16:27:43 -06:00
Rene Moser
4264df693f docsite, cloudstack: add limited VPC support
Also see https://github.com/ansible/ansible-modules-extras/issues/1811
2016-03-10 11:41:17 +01:00
Jason McKerr
4af8676329 fix formatting for people section 2016-03-08 10:42:47 -05:00
Jason McKerr
e903b24cb7 initial checkin of the new Community Committer Guidelines 2016-03-08 10:37:30 -05:00
Michael Scherer
43309c0f5d Fix various mispellings 2016-03-06 11:29:32 +01:00
Kishin Yagami
299c18d700 Support strategy_plugins setting in a configuration file 2016-03-05 20:15:04 +09:00
Matt Martz
2da2dc621b Fix callback example in porting guide. See #14772 2016-03-04 07:18:05 -06:00
Evgeni Golov
b00a620fa5 don't escape asterisks in parameter lists 2016-03-03 23:57:30 +01:00
Dag Wieers
85a28179b7 Improve the wording a bit
According to what @amenonsen suggested in #10064.
Although the additional statement is still needed to get rid of the ambiguity.
2016-03-03 14:38:40 +01:00
Dag Wieers
18d58e42d5 Improve ambiguous statement regarding handler order
This fixes #10064
2016-03-03 14:32:56 +01:00
Brian Coca
2cd52604e2 Merge pull request #14745 from jinesh-choksi/patch-1
On RHEL/CentOS 6 needed additional dependencies to build RPM
2016-03-02 10:44:23 -05:00
Brian Coca
7404d4ce7f made dict example less ambigous
fixes #14748
2016-03-02 09:20:46 -05:00
Jinesh Choksi
78f6b61990 On RHEL/CentOS 6 needed additional dependencies to build RPM
To build an RPM on RHEL 6, we needed asciidoc, git and python-setuptools in addition to the rpm-build/make and python2-devel packages.
2016-03-02 10:54:37 +00:00
Brian Coca
70e7be0346 added clarification on moustaches 2016-03-01 12:43:52 -05:00
Brian Coca
d6716a2f90 noted issues with setup now inheriting environment 2016-03-01 09:17:16 -05:00
Brian Coca
583fafa07f Merge pull request #14689 from jmatsushita/patch-2
Updated versions with current released and development
2016-02-29 23:15:24 -05:00
Brian Coca
30b137ad34 Merge pull request #14705 from rutsky/patch-1
fix reference to chapter + trailing dot
2016-02-29 18:15:17 -05:00
nitzmahone
d699ef72d2 Fixes #12433 with distro-agnostic text 2016-02-29 14:38:35 -08:00
Matt Davis
840cda741d Merge pull request #12363 from breathe/devel
allow ConfigureRemotingForAnsible.ps1 script from public zone
2016-02-29 22:28:53 +00:00
Brian Coca
8766a9dbaf added new gather behaviour to porting guide
also removed redundant header from changelog from merge
2016-02-29 15:56:39 -05:00
brianlycett
18e4a02c25 Update YAMLSyntax.rst
Ach - it's double backquotes in this markup.
2016-02-29 16:06:06 +00:00
brianlycett
6c7680b633 Update YAMLSyntax.rst
Small updates loosely based on suggestions. :)
2016-02-29 16:04:45 +00:00
Vladimir Rutsky
35880e6254 fix reference to chapter + trailing dot 2016-02-29 18:21:05 +03:00
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
Sandra Wills
17f7e6162a playbook variables precedence list light edits
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", as if something should preceed it. The
comments from OxABAB were not helpful, 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"
intros for each list line, to help with clarity.
2016-02-19 10:16:59 -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
6e716b177e add webdocs as alias 2016-01-25 16:32:09 -05: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
Sandra Wills
9601ae60fd adding swiftype search script to footer.html 2016-01-11 11:30:28 -05:00
Brian Coca
45e686d03d another unused file 2016-01-11 11:28:23 -05:00
Brian Coca
8ff47d63e1 removed unused files to avoid confusion
really, its a vcs, no need to rename to _old and keep stuff around
2016-01-11 11:27:39 -05:00
Sandra Wills
7124a525a2 added custom code for swiftype custom search
Google custom search replacement
2016-01-11 08:54:49 -05: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
Sandra Wills
669b311dbe Merge pull request #13740 from docschick/devel
removed the "wy-side-nav-search" element
2016-01-06 14:05:36 -05:00
Sandra Wills
ab2f47327a removed the "wy-side-nav-search" element
this is so we can use the new swiftype search and it's search input
2016-01-06 13:59:25 -05: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
John Mitchell
1c3b16c2dd udpate copyright date 2016-01-04 20:02:01 -05:00
John Mitchell
692ef6dcc9 made docsite ads configurable by marketing 2016-01-04 19:59:47 -05:00
John Mitchell
0d7c328459 fixed css minification make target for docsite 2016-01-04 19:59:47 -05: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