diff options
| author | Wesley Wiedenmeier <wesley.wiedenmeier@gmail.com> | 2016-08-28 17:56:17 -0500 |
|---|---|---|
| committer | Scott Moser <smoser@brickies.net> | 2016-09-30 13:21:00 -0400 |
| commit | 1071b9940b4e114cd2eabf290b739f92fbab33de (patch) | |
| tree | a8fbef15c5be9510df93b4544e3bca1f74e2f29a /cloudinit/config/cc_grub_dpkg.py | |
| parent | 02f6c4bb8cef17b3fe04ef4dc1ef199e20aeb4d9 (diff) | |
| download | vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.tar.gz vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.zip | |
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
Diffstat (limited to 'cloudinit/config/cc_grub_dpkg.py')
| -rw-r--r-- | cloudinit/config/cc_grub_dpkg.py | 34 |
1 files changed, 34 insertions, 0 deletions
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 <http://www.gnu.org/licenses/>. +""" +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: <true/false> + grub-pc/install_devices: <devices> + grub-pc/install_devices_empty: <devices> + grub-dpkg: (alias for grub_dpkg) +""" + import os from cloudinit import util |