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_ubuntu_init_switch.py | 32 ++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) (limited to 'cloudinit/config/cc_ubuntu_init_switch.py') diff --git a/cloudinit/config/cc_ubuntu_init_switch.py b/cloudinit/config/cc_ubuntu_init_switch.py index bffb4380..31a96e4a 100644 --- a/cloudinit/config/cc_ubuntu_init_switch.py +++ b/cloudinit/config/cc_ubuntu_init_switch.py @@ -17,27 +17,33 @@ # along with this program. If not, see . """ +Ubuntu Init Switch +------------------ **Summary:** reboot system into another init. -**Description:** This module provides a way for the user to boot with systemd -even if the image is set to boot with upstart. It should be run as one of the -first ``cloud_init_modules``, and will switch the init system and then issue a -reboot. The next boot will come up in the target init system and no action will -be taken. +This module provides a way for the user to boot with systemd even if the image +is set to boot with upstart. It should be run as one of the first +``cloud_init_modules``, and will switch the init system and then issue a +reboot. The next boot will come up in the target init system and no action +will be taken. This should be inert on non-ubuntu systems, and also +exit quickly. -This should be inert on non-ubuntu systems, and also exit quickly. +.. note:: + best effort is made, but it's possible this system will break, and probably + won't interact well with any other mechanism you've used to switch the init + system. + +**Internal name:** ``cc_ubuntu_init_switch`` + +**Module frequency:** once per instance + +**Supported distros:** ubuntu -It can be configured with the following option structure:: +**Config keys**:: init_switch: target: systemd (can be 'systemd' or 'upstart') reboot: true (reboot if a change was made, or false to not reboot) - -.. note:: - - Best effort is made, but it's possible - this system will break, and probably won't interact well with any other - mechanism you've used to switch the init system. """ from cloudinit.distros import ubuntu -- cgit v1.2.3