[Kimchi-devel] [kimchi-devel][RFC][PATCH] Storagepool on existent VG: Update document

[lvroyce at linux.vnet.ibm.com]

From: Royce Lv <lvroyce at linux.vnet.ibm.com>

Add interfaces to report existent volume group on host.
the returning detail will include what pool this volume group
belongs to. If this VG is not used by any storage pool, its storage_pool
will be empty string.
So the process of creating pool on existent VG will be:
1. List VG not occupied by storage pool:
    GET /host/vgs?storage_pool=''
   This will retrieve volume group path and user can choose from one.

2. Create storage pool from chosen VG:
    POST /storagepools/
        {'path':volume_group_path, 'name': storagepool_name,
         'type': 'logical', 'devices':[]}

Signed-off-by: Royce Lv <lvroyce at linux.vnet.ibm.com>
---
 docs/API.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/API.md b/docs/API.md
index 3f7925f..ed53d94 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -986,6 +986,26 @@ stats history
     * mountpoint: If the partition is mounted, represents the mountpoint.
       Otherwise blank.
 
+### Collection: Volume groups
+
+**URI:** /host/vgs
+
+**Methods:**
+
+* **GET**: Retrieves list of volume groups.
+
+### Resource: Volume group
+
+**URI:** /host/vgs/*:name*
+
+**Methods:**
+
+* **GET**: Retrieve information of a single volume group.
+    * storage_pool: logical storage pool name which based on this volume group.
+    * path: path of this storage volume group.
+    * size: Total size of volume group.
+    * name: Name of the volume group.
+
 ### Collection: Devices
 
 **URI:** /host/devices
-- 
2.1.0