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_resizefs.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'cloudinit/config/cc_resizefs.py') diff --git a/cloudinit/config/cc_resizefs.py b/cloudinit/config/cc_resizefs.py index 2a2a9f59..1b917966 100644 --- a/cloudinit/config/cc_resizefs.py +++ b/cloudinit/config/cc_resizefs.py @@ -18,6 +18,32 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Resizefs +-------- +**Summary:** resize filesystem + +Resize a filesystem to use all avaliable space on partition. This module is +useful along with ``cc_growpart`` and will ensure that if the root partition +has been resized the root filesystem will be resized along with it. By default, +``cc_resizefs`` will resize the root partition and will block the boot process +while the resize command is running. Optionally, the resize operation can be +performed in the background while cloud-init continues running modules. This +can be enabled by setting ``resize_rootfs`` to ``true``. This module can be +disabled altogether by setting ``resize_rootfs`` to ``false``. + +**Internal name:** ``cc_resizefs`` + +**Module frequency:** per always + +**Supported distros:** all + +**Config keys**:: + + resize_rootfs: + resize_rootfs_tmp: +""" + import errno import os import stat -- cgit v1.2.3