From 1071b9940b4e114cd2eabf290b739f92fbab33de Mon Sep 17 00:00:00 2001 From: Wesley Wiedenmeier Date: Sun, 28 Aug 2016 17:56:17 -0500 Subject: Improve module documentation and doc cleanup. This adds lots of config module documentation in a standard format. It will greatly improve the content at readthedocs. Additionally: * Add a 'doc' env to tox.ini * Changed default highlight language for sphinx conf from python to yaml most examples in documentation are yaml configs * Updated datasource examples to highlight sh code properly --- cloudinit/config/cc_runcmd.py | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) (limited to 'cloudinit/config/cc_runcmd.py') diff --git a/cloudinit/config/cc_runcmd.py b/cloudinit/config/cc_runcmd.py index bc09d38c..23e1e898 100644 --- a/cloudinit/config/cc_runcmd.py +++ b/cloudinit/config/cc_runcmd.py @@ -18,6 +18,38 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Runcmd +------ +**Summary:** run commands + +Run arbitrary commands at a rc.local like level with output to the console. +Each item can be either a list or a string. If the item is a list, it will be +properly executed as if passed to ``execve()`` (with the first arg as the +command). If the item is a string, it will be written to a file and interpreted +using ``sh``. + +.. note:: + all commands must be proper yaml, so you have to quote any characters yaml + would eat (':' can be problematic) + +**Internal name:** ``cc_runcmd`` + +**Module frequency:** per instance + +**Supported distros:** all + +**Config keys**:: + + runcmd: + - [ ls, -l, / ] + - [ sh, -xc, "echo $(date) ': hello world!'" ] + - [ sh, -c, echo "=========hello world'=========" ] + - ls -l /root + - [ wget, "http://example.org", -O, /tmp/index.html ] +""" + + import os from cloudinit import util -- cgit v1.2.3