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_grub_dpkg.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) (limited to 'cloudinit/config/cc_grub_dpkg.py') diff --git a/cloudinit/config/cc_grub_dpkg.py b/cloudinit/config/cc_grub_dpkg.py index 156722d9..33ca40a1 100644 --- a/cloudinit/config/cc_grub_dpkg.py +++ b/cloudinit/config/cc_grub_dpkg.py @@ -18,6 +18,40 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Grub Dpkg +--------- +**Summary:** configure grub debconf installation device + +Configure which device is used as the target for grub installation. This module +should work correctly by default without any user configuration. It can be +enabled/disabled using the ``enabled`` config key in the ``grub_dpkg`` config +dict. The global config key ``grub-dpkg`` is an alias for ``grub_dpkg``. If no +installation device is specified this module will look for the first existing +device in: + + - ``/dev/sda`` + - ``/dev/vda`` + - ``/dev/xvda`` + - ``/dev/sda1`` + - ``/dev/vda1`` + - ``/dev/xvda1`` + +**Internal name:** ``cc_grub_dpkg`` + +**Module frequency:** per instance + +**Supported distros:** ubuntu, debian + +**Config keys**:: + + grub_dpkg: + enabled: + grub-pc/install_devices: + grub-pc/install_devices_empty: + grub-dpkg: (alias for grub_dpkg) +""" + import os from cloudinit import util -- cgit v1.2.3