cloud-init-dev team mailing list archive

[Scott Moser <smoser@xxxxxxxxxx>]

Scott Moser has proposed merging ~smoser/cloud-init:bug/1673818-configdrive-doc-does-read-disk into cloud-init:master.

Commit message:
doc: fix config drive doc with regard to unpartitioned disks.

The ConfigDrive datasource has read un-partitioned disks for quite
a while, but the documentation lagged behind.

LP: #1673818

Requested reviews:
  cloud init development team (cloud-init-dev)
Related bugs:
  Bug #1673818 in cloud-init: "Misleading requirements for 'unpartitioned disks' for ConfigDrive in documentation"
  https://bugs.launchpad.net/cloud-init/+bug/1673818

For more details, see:
https://code.launchpad.net/~smoser/cloud-init/+git/cloud-init/+merge/320228
-- 
Your team cloud init development team is requested to review the proposed merge of ~smoser/cloud-init:bug/1673818-configdrive-doc-does-read-disk into cloud-init:master.

diff --git a/doc/rtd/topics/datasources/configdrive.rst b/doc/rtd/topics/datasources/configdrive.rst
index acdab6a..11dd52a 100644
--- a/doc/rtd/topics/datasources/configdrive.rst
+++ b/doc/rtd/topics/datasources/configdrive.rst
@@ -18,12 +18,13 @@ support listed below)
 
 Version 1
 ---------
+**Note:** Version 1 is legacy and should be considered deprecated.  Version 2
+has been supported in OpenStack since 2012.2 (Folsom).
 
 The following criteria are required to as a config drive:
 
 1. Must be formatted with `vfat`_ filesystem
-2. Must be a un-partitioned block device (/dev/vdb, not /dev/vdb1)
-3. Must contain *one* of the following files
+2. Must contain *one* of the following files
 
 ::
 
@@ -56,8 +57,7 @@ The following criteria are required to as a config drive:
 
 1. Must be formatted with `vfat`_ or `iso9660`_ filesystem
    or have a *filesystem* label of **config-2**
-2. Must be a un-partitioned block device (/dev/vdb, not /dev/vdb1)
-3. The files that will typically be present in the config drive are:
+2. The files that will typically be present in the config drive are:
 
 ::