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_resizefs.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_resizefs.py')
-rw-r--r-- | cloudinit/config/cc_resizefs.py | 26 |
1 files changed, 26 insertions, 0 deletions
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 <http://www.gnu.org/licenses/>. +""" +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: <true/false/"noblock"> + resize_rootfs_tmp: <directory> +""" + import errno import os import stat |