cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
28507 commits 47 branches 390 tags 440 MiB
Commit graph

334 commits

Author SHA1 Message Date
Michael DeHaan
bac3449db7 Restructure hacking readme. 2013-04-20 09:36:09 -04:00
Michael DeHaan
e2d9e1b5c2 Convert 'hacking' instructions to markdown, add more info. 2013-04-20 09:34:38 -04:00
Michael DeHaan
148d8859ba Docs on parameterized roles, make document generation output less noisy 2013-04-12 17:45:27 -04:00
Marco Vito Moscaritolo
a53259a797 Fixed option validation error 
Fixed error on validation that block javascript documentation generation.
 2013-03-29 16:30:33 +01:00
Michael DeHaan
b066e9c15c Remove authors file from version control (can still be built from 'make authors') 2013-03-25 23:36:53 -04:00
Cristian Ciupitu
29aaa5e693 module_formatter.return_data: use UTF-8 encoding 
The text parameter can contain non-ASCII characters, so we'll encode it
using UTF-8. For example the DOCUMENTATION of the bzr module has such
characters in the name of the author.
 2013-03-17 19:55:56 +02:00
Sam Kottler
86d420f481 Use verbose 'source' to make the document easier to read 2013-03-10 23:00:48 -04:00
Michael DeHaan
03db6ef24a Slightly more self-explanatory output for ./hacking/env-setup 2013-03-18 00:27:44 -04:00
Michael DeHaan
fa550f3d7e Adding a script to auto-generate an authors file, runnable from 'make authors', which is called from 'make docs/webdocs'. 2013-02-26 22:05:17 -05:00
Michael DeHaan
e51707711c Merge pull request #2120 from jpmens/doc_ex1 
Add support for additional EXAMPLES string in Ansible modules
 2013-02-23 08:58:34 -08:00
Yves Dorfsman
dfdc5bda4b Prevents PATH, PYTHONPATH etc... to be re-added. 2013-02-20 01:12:38 -07:00
Jan-Piet Mens
396a07bcc7 Add support for additional EXAMPLES string in Ansible modules 
return DOC and EXAMPLES as a list
add moduledev explanation
more
 2013-02-18 20:02:46 +01:00
Michael DeHaan
b3eb1f32e3 update hacking/test_module script to be aware of complex arguments, though it does not pass them. 2013-02-17 17:33:42 -05:00
Michael DeHaan
0ae7f996f5 Make sure all the lookup plugins are documented. 2013-02-02 11:51:25 -05:00
Les Aker
ee274b5816 fixed shebang in hacking test-module 2013-02-01 17:11:38 -05:00
junyoung
a2aacaaec8 whitespaces in FULL_PATH cause an error to get ANSIBLE_PATH 2013-01-28 10:46:34 +09:00
Daniel Hokka Zakrisson
a117944d0f Make env-setup work on Python 3 2013-01-23 19:48:13 +01:00
Blair Zajac
ec5f6ae246 hacking/env-setup: remove unused sys import. 2013-01-12 19:07:50 -08:00
Dag Wieers
66fb7fd9de Make use of yes/no booleans in playbooks 
At the moment Ansible prefers yes/no for module booleans, however booleans in playbooks are still using True/False, rather than yes/no. This changes modifies boolean uses in playbooks (and man pages) to favor yes/no rather than True/False.

This change includes:

- Adaptation of documentation and examples to favor yes/no
- Modification to manpage output to favor yes/no (the docsite output already favors yes/no)
 2012-12-14 11:56:53 +01:00
Jan-Piet Mens
f9755ca36d mail module: add MIME attachments, port and addresses with phrases 
Add HTML-escaping to code examples in rST tempate of module-formatter
 Add support for specifying port, addresses with phrases and attaching files
 Add support for custom headers and document version_added for new options
 X-Mailer header added :)
 protect empty address lists & attachment list, and add bcc
 2012-12-12 07:42:42 +01:00
Stephen Fromm
6a68d3813f Set LANG in module_common.py 
Add constant DEFAULT_MODULE_LANG that defaults to C.  Can be set via
environment variable ANSIBLE_MODULE_LANG or configuration variable
module_lang.  Updated test-module to have same behavior.
 2012-11-27 00:16:06 -08:00
Michael DeHaan
dd5a8474f8 Have module formatter ignore more types of files. 2012-11-26 18:50:26 -05:00
Jan-Piet Mens
068ef0e979 module_formatter: re-instate code 2012-11-22 07:23:10 +01:00
Jan-Piet Mens
caf003c813 DOCUMENTATION strings 2012-11-21 18:49:30 +01:00
Stephen Fromm
06e54c0b97 Add ability to specify syslog facility for modules 
Update constants.py so that one can specify environmental variable
ANSIBLE_SYSLOG_FACILITY or syslog_facility in ansible.cfg to define
the syslog facility to use.  Alternatively, you can specify
ansible_syslog_facility in inventory.  Runner now replaces
the syslog facility in the openlog() call with the default or
the injected variables ansible_syslog_facility.

This also updates hacking/test-module to behave similarly.
 2012-11-11 00:14:08 -08:00
Jan-Piet Mens
e32f4a0564 Move get_docstring from module_formatter into ansible/utils 2012-11-09 17:15:41 +01:00
Michael DeHaan
6a5df97393 Manpage documentation ALSO should be sorted 2012-11-03 18:54:38 -04:00
Michael DeHaan
626203a7c9 Module documentation should have options sorted 2012-11-03 18:52:59 -04:00
Jan-Piet Mens
afa467e975 DOCUMENTATION: LaTeX template is back 
ongoing work for the Booklet
 2012-10-24 19:42:52 +02:00
Michael DeHaan
4104478abd Added 'script', a module that can push and insantly run a remote script. Replaces the need to copy+command. 
This is a bit of a rough draft, some error handling still needs to be added.
 2012-10-20 12:12:07 -04:00
Michael DeHaan
896be48ac9 Merge pull request #1367 from jpmens/mdtempl 
Add support for Github-flavored Markdown to module_formatter
 2012-10-18 16:59:18 -07:00
Jan-Piet Mens
575459465e module_formatter: .rst now correctly handles code examples 
- fixed template (it was the template), adding indentation with Jinja2
 - added description of code examples to man-page template (was missing)
 - fixed fireball, cron, and debug module examples to confrom
 2012-10-18 13:49:19 +02:00
Jan-Piet Mens
d4f89122f4 Add support for Github-flavored Markdown to module_formatter 
- Uses HTML tables and Github-flavored code blocks (3 backticks)
 2012-10-18 07:34:17 +02:00
Stephen Fromm
60f06c36b3 Miscellaneous fixes to module_formatter.py 
Try to autodetect MODULEDIR, instead of hardcoded path in jpmens
homedir.
Check if MODULEDIR exists; exit if it doesn't.
Rewrite boilerplate() to use DOCUMENTATION.yaml in examples/.  This
makes use of tbielawa's recent change that added this example file.
This also fixes -G so that it works.  boilerplate() was commented out
before.
 2012-10-12 16:27:01 -07:00
Dag Wieers
2786149bdc Moving now from getopt to optparse 
Let me know if we can move to another library instead ;-)
 2012-10-11 18:14:38 +02:00
Michael DeHaan
6d2f003ceb Update formatter to not include orange blocks all over docsite page 2012-10-10 21:25:19 -04:00
Michael DeHaan
110244d7b4 Merge branch 'remove-argparse' of git://github.com/dagwieers/ansible into devel 
Conflicts:
	hacking/module_formatter.py

Don't run webdocs build when building packages
 2012-10-10 18:46:51 -04:00
Marco Vito Moscaritolo
ee679c0190 Unified document generator and make to generate JSON and JS files 2012-10-10 18:41:50 -04:00
Dag Wieers
2dcd0846ab Use getopt instead of argparse 
On RHEL5 and RHEL6 there is not argparse, and 'make rpm' fails because of this.
With this change it works, and I can test and fix my own documentation...
 2012-10-09 12:23:30 +02:00
Jan-Piet Mens
ba22ca13ba man pages have wrong chapter number 2012-10-05 09:09:49 +02:00
Michael DeHaan
c3f443f56c fix sorting 2012-10-04 07:08:13 -04:00
Michael DeHaan
761330b125 Fix module formatter indexing 2012-10-03 23:31:50 -04:00
Tim Bielawa
85fb7c6d4b Library functions and modules should be in the 3 man page section. Also the files should end in '.3' 2012-10-03 10:18:55 -04:00
Michael DeHaan
ad5433b166 include version added info for individual fields 2012-10-02 22:36:27 -04:00
Michael DeHaan
31a4fe412f Complain when modules do not have documentation. 2012-09-30 21:10:07 -04:00
Jan-Piet Mens
eb8a11237c module_formatter can output lists of files to process (.rst and .tex) 2012-09-30 19:07:40 +02:00
Jan-Piet Mens
e4338d0ca3 module_formatter now also uses Jinja2 trim_blocks 
- Updated man template accordingly
- seem to have left in illegal char in facter DOCUMENTATION...
 2012-09-30 15:06:18 +02:00
Jan-Piet Mens
f5e0fbf65b rst output template tweak for 'required' 2012-09-30 14:21:30 +02:00
Michael DeHaan
b96da3e5b0 Merge pull request #1158 from jpmens/man01 
documentation: man template: support empty options; add Version
 2012-09-30 05:00:39 -07:00
Jan-Piet Mens
61ee632d23 documentation: man template: support empty options; add Version to Makefile 2012-09-30 13:33:21 +02:00
Jan-Piet Mens
80a9016636 module docs: fixed rst template 
- notes is now supported
- multiline code examples are now supported (HTML rendering was off)
 2012-09-30 13:20:24 +02:00
Michael DeHaan
ce5dceab0e Merge pull request #1128 from mavimo/devel 
Added documentation to APT module
 2012-09-28 16:12:58 -07:00
Michael DeHaan
508e6ecf43 Merge pull request #1131 from jpmens/m-docs3 
Module DOCUMENTATION for template, wait_for, and yum
 2012-09-28 16:11:33 -07:00
Jan-Piet Mens
a040807fd0 Module DOCUMENTATION for template, wait_for, and yum 2012-09-29 00:49:02 +02:00
Marco Vito Moscaritolo
94de4db928 Add JSON output format to DOCUMENTS and EXAMPLES parser 2012-09-28 22:38:27 +02:00
Jan-Piet Mens
e0fb264a89 Module DOCUMENTATION: assemble, authorized_key, command, copy 
plus a small fix in rst.j2 template
  manpages generated & checked
  modules.html generated & checked
 2012-09-28 21:55:49 +02:00
Jan-Piet Mens
62d038dca4 module_formatter fixes 2012-09-28 09:59:43 +02:00
Michael DeHaan
0c855a85bc fix module formatter output messages 2012-09-27 21:34:28 -04:00
Michael DeHaan
405c097c43 Various fixes for the module documentation auto-generator 2012-09-27 21:30:32 -04:00
Michael DeHaan
83f277cfe6 Various tweaking to get the module formatter to work for 'make docs' in the docs project. Likely the templates for other module formatting types will have to change 
by the time I'm done.
 2012-09-27 21:06:31 -04:00
Jan-Piet Mens
d47e15a1f2 module_formatter in hacking/ 2012-09-26 20:41:44 +02:00
Michael DeHaan
ce01c3f7e7 Allow unicode transfer by not base64 encoding. Also: faster 2012-08-02 21:20:43 -04:00
Will Thames
4d4d0b90c5 readlink -f does not work on OS X. Replaced with a python solution 2012-07-30 21:35:24 +10:00
willthames
6219fc4932 env-setup no longer needs to be run from the ansible directory, it can be run from anywhere 
env-setup now takes a -q argument to run in quiet mode
 2012-07-30 13:18:28 +10:00
Michael DeHaan
738cea9c93 small tweaks to --help for hacking/test-module 2012-07-23 19:33:26 -04:00
Michael DeHaan
fc96b88205 Teach the test-module script about the new way MODULE_ARGS works in new-style modules. 2012-07-23 19:28:43 -04:00
bradobro
e8583833a7 test-module uses optparse with --debugger 
Refactored hacking/test-module

1. uses optparse

2. has --debugger option

tested only with pdb on Python 2.7
 2012-07-23 16:28:06 +00:00
bradobro
ade0233d57 Refactoring test-module to be more like ansible. 2012-07-23 16:04:28 +00:00
Michael DeHaan
d0f4358730 Port the copy module over to the new "common module" logic. 2012-07-21 17:07:42 -04:00
Michael DeHaan
a94ec130d2 Common module code upgrades 2012-07-17 23:09:57 -04:00
Michael DeHaan
9006d4557d Added code to allow insertion of boilerplate into modules to make them able to share lots of code, the result 
should be a huge reduction of total ansible source, at a slight cost of difficulty in original module development.

We need to apply this now to all modules, but may need to have some exemptions to things like command, which should
subclass this module.
 2012-07-17 22:34:52 -04:00
Michael DeHaan
867b2437cc consolidate output code in callbacks.py, from utils, remove extra functions 2012-07-15 10:12:49 -04:00
Peter Sankauskas
f9a14cfec1 Adding a missing '~' to use the user's home directory instead of the root file system for the module arguments 2012-05-02 09:50:20 -07:00
Michael DeHaan
6341361a5b Clarify that stderr WILL crash your module. Can't redirect because if we do we lose tracebacks 
from modules remotely when they fail to parse, and this is VERY useful data.
 2012-04-27 01:36:31 -04:00
Michael DeHaan
36e454c52f Because paramiko using a pty can't distinguish stderr and stdout, remove handling that 
treated -D as a way to show stderr, and make sure modules don't include things on stderr.
Update docs and test module script to come into line.
 2012-04-27 01:25:38 -04:00
Michael DeHaan
533c2c6126 Make it possible to use facts from hosts in templates for other hosts. 
It works like this:

{{ hostvars['127.0.0.1']['ansible_eth0']['ipv4']['address'] }}
 2012-04-21 12:45:37 -04:00
Tim Bielawa
e9e8417735 Update hacking with MANPATH. Correct hacking README details. 2012-04-17 10:53:32 -04:00
Michael DeHaan
82bd75c1e0 Update env-setup script to make it work better 2012-03-18 12:28:22 -04:00
Michael DeHaan
be55145a1e Initial crack at the file module 2012-03-15 21:53:14 -04:00
Michael DeHaan
a735dd2b17 Added the 'test-module' script, useful for testing modules without running them in Ansible. 2012-03-14 21:49:27 -04:00
Michael DeHaan
85e0de5bb2 Move print statements out of playbook.py and back into CLI so we can simplify playbook operations 
independent of output, and can also see all the output nicely grouped together if we want
to reformat it or make summaries of statistics.
 2012-03-06 19:24:36 -05:00
Tim Bielawa
c5f8bc9d79 Don't set ANSIBLE_HOSTS inside the env-setup script 2012-03-05 16:12:05 -05:00
Tim Bielawa
f2c2786a14 Update constants.py to pull module path and the hosts file from the 
environment (ANSIBLE_{LIBRARY,HOSTS}) if defined.

Update manpages to represent this.

Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}.
 2012-03-05 16:08:36 -05:00
Tim Bielawa
6343aa6214 Add environment updating script 'env-setup' to facilitate running ansible from a git checkout. 2012-03-05 13:47:01 -05:00