summaryrefslogtreecommitdiff
path: root/cloudinit/config
diff options
context:
space:
mode:
authorJames Falcon <therealfalcon@gmail.com>2021-09-22 16:30:12 -0500
committerGitHub <noreply@github.com>2021-09-22 16:30:12 -0500
commit24a15e9cd3acd7c93efe9755b98897ee8c0476c7 (patch)
tree736901058a930df6f886f211a49f30e03a86d7cc /cloudinit/config
parenta1e78b2ea3eb00dcd64d41ca83a240334c851a45 (diff)
downloadvyos-cloud-init-24a15e9cd3acd7c93efe9755b98897ee8c0476c7.tar.gz
vyos-cloud-init-24a15e9cd3acd7c93efe9755b98897ee8c0476c7.zip
docs: update cc_disk_setup for fs to raw disk (#1017)
Diffstat (limited to 'cloudinit/config')
-rw-r--r--cloudinit/config/cc_disk_setup.py11
1 files changed, 7 insertions, 4 deletions
diff --git a/cloudinit/config/cc_disk_setup.py b/cloudinit/config/cc_disk_setup.py
index 3ec49ca5..440f05f1 100644
--- a/cloudinit/config/cc_disk_setup.py
+++ b/cloudinit/config/cc_disk_setup.py
@@ -50,15 +50,18 @@ filesystem on may be specified either as a path or as an alias in the format
``<alias name>.<y>`` where ``<y>`` denotes the partition number on the device.
The partition can also be specified by setting ``partition`` to the desired
partition number. The ``partition`` option may also be set to ``auto``, in
-which this module will search for the existance of a filesystem matching the
+which this module will search for the existence of a filesystem matching the
``label``, ``type`` and ``device`` of the ``fs_setup`` entry and will skip
creating the filesystem if one is found. The ``partition`` option may also be
set to ``any``, in which case any file system that matches ``type`` and
``device`` will cause this module to skip filesystem creation for the
``fs_setup`` entry, regardless of ``label`` matching or not. To write a
-filesystem directly to a device, use ``partition: none``. A label can be
-specified for the filesystem using ``label``, and the filesystem type can be
-specified using ``filesystem``.
+filesystem directly to a device, use ``partition: none``. ``partition: none``
+will **always** write the filesystem, even when the ``label`` and
+``filesystem`` are matched, and ``overwrite`` is ``false``.
+
+A label can be specified for the filesystem using
+``label``, and the filesystem type can be specified using ``filesystem``.
.. note::
If specifying device using the ``<device name>.<partition number>`` format,