summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/sources/smartos/README.rst28
1 files changed, 17 insertions, 11 deletions
diff --git a/doc/sources/smartos/README.rst b/doc/sources/smartos/README.rst
index e2d3312e..8b63e520 100644
--- a/doc/sources/smartos/README.rst
+++ b/doc/sources/smartos/README.rst
@@ -73,15 +73,21 @@ or not to base64 decode something:
(i.e. /etc/cloud/cloud.cfg.d) that sets which values should not be
base64 decoded.
-ephemeral_disk:
+disk_aliases and ephemeral disk:
---------------
-
-In order to instruct Cloud-init which disk to auto-mount. By default,
-SmartOS only supports a single ephemeral disk.
-
-The default SmartOS configuration will prepare the ephemeral disk and format
-it for you. SmartOS does not, by default, prepare the ephemeral disk for you.
-
-If you change ephemeral_disk, you should also consider changing
-the default disk formatting parameters. See
-doc/examples/cloud-config-disk-setup.txt for information on using this.
+By default, SmartOS only supports a single ephemeral disk. That disk is
+completely empty (un-partitioned with no filesystem).
+
+The SmartOS datasource has built-in cloud-config which instructs the
+'disk_setup' module to partition and format the ephemeral disk.
+
+You can control the disk_setup then in 2 ways:
+ 1. through the datasource config, you can change the 'alias' of
+ ephermeral0 to reference another device. The default is:
+ 'disk_aliases': {'ephemeral0': '/dev/vdb'},
+ Which means anywhere disk_setup sees a device named 'ephemeral0'
+ then /dev/vdb will be substituted.
+ 2. you can provide disk_setup or fs_setup data in user-data to overwrite
+ the datasource's built-in values.
+
+See doc/examples/cloud-config-disk-setup.txt for information on disk_setup.