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_bootcmd.py | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'cloudinit/config/cc_bootcmd.py') diff --git a/cloudinit/config/cc_bootcmd.py b/cloudinit/config/cc_bootcmd.py index b763a3c3..22b23f28 100644 --- a/cloudinit/config/cc_bootcmd.py +++ b/cloudinit/config/cc_bootcmd.py @@ -18,6 +18,34 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Bootcmd +------- +**Summary:** run commands early in boot process + +This module runs arbitrary commands very early in the boot process, +only slightly after a boothook would run. This is very similar to a +boothook, but more user friendly. The environment variable ``INSTANCE_ID`` +will be set to the current instance id for all run commands. Commands can be +specified either as lists or strings. For invocation details, see ``runcmd``. + +.. note:: + bootcmd should only be used for things that could not be done later in the + boot process. + +**Internal name:** ``cc_bootcmd`` + +**Module frequency:** per always + +**Supported distros:** all + +**Config keys**:: + + bootcmd: + - echo 192.168.1.130 us.archive.ubuntu.com > /etc/hosts + - [ cloud-nit-per, once, mymkfs, mkfs, /dev/vdb ] +""" + import os from cloudinit.settings import PER_ALWAYS -- cgit v1.2.3