From d2a25e0488d96a8a2f23e86fc257e441b5c4f45a Mon Sep 17 00:00:00 2001
From: Zhenguo Niu <Niu.ZGlinux@gmail.com>
Date: Sun, 3 Sep 2017 00:15:22 +0800
Subject: [PATCH] Add root disk partitions docs

This introduces a new user guide section and adds root disk
partitions docs

Change-Id: I3b2411e8d02f6a3430d0f527f44c28dd2f780012
---
 doc/source/index.rst                     | 22 +++++++++++++++++-----
 doc/source/user/root-disk-partitions.rst | 13 +++++++++++++
 2 files changed, 30 insertions(+), 5 deletions(-)
 create mode 100644 doc/source/user/root-disk-partitions.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index e2d317d3..08f17899 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -81,6 +81,18 @@ Sample Policy file
 
     sample_policy
 
+
+User's Guide
+============
+
+Root Disk Partitions
+--------------------
+
+.. toctree::
+    :maxdepth: 1
+
+    user/root-disk-partitions
+
 Command References
 ==================
 
@@ -91,11 +103,6 @@ Here are references for commands not elsewhere documented.
 
   cmds/mogan-dbsync
 
-Indices and tables
-==================
-
-* :ref:`search`
-
 Running tests of Mogan
 ======================
 
@@ -112,3 +119,8 @@ Installation and Setup
 
    installation/uwsgi
    installation/image-requirements
+
+Indices and tables
+==================
+
+* :ref:`search`
diff --git a/doc/source/user/root-disk-partitions.rst b/doc/source/user/root-disk-partitions.rst
new file mode 100644
index 00000000..df317155
--- /dev/null
+++ b/doc/source/user/root-disk-partitions.rst
@@ -0,0 +1,13 @@
+Root disk partitions
+--------------------
+
+Mogan supports custom partitions for root disk with partition images, meaning
+that users can specify partitions such as root_gb, ephemeral_gb, and swap_mb
+when claiming a server. But after the deployment the root partition may not
+like what your specified, as the backend driver makes the root partition the
+last partition which enables tools like cloud-init's growroot utility to expand
+the root partition until the end of the disk.
+
+.. note:: Whole disk images, on the contrary, not support partitions, passing
+          partitions to server creation results in a fault and will prevent the
+          creation from happening.