Merge pull request #73 from linkernetworks/hwchiu/add-api

Complete the documentation of API for Storage/Volume
linkernetworks · Jul 9, 2018 · 47f1877 · 47f1877
2 parents bd8533d + e6c9d9e
commit 47f1877
Showing 1 changed file with 179 additions and 0 deletions.
diff --git a/API.md b/API.md
@@ -115,3 +115,182 @@ Response Data:
   "message": "Delete success"
 }
 ```
+
+## Storage
+### Create Storage
+
+**POST /v1/storage**
+
+Request file:
+Type: The storage type we want to connect, it only supoorts `nfs` now.
+Name: The name of your storage and it will be used when we want to create the volume.
+NFS Parameter:
+In the NFS server, there're two parametes we need to provide, the `server IP address` and `exporting path`
+
+
+Example:
+
+```
+curl -X POST -H "Content-Type: application/json" \
+     -d '{"type":"nfs","name":"My First Storage","nfs":{"ip":"172.17.8.100","path":"/nfs"}}' \
+     http://localhost:7890/v1/storage
+```
+
+Request Data:
+```json
+{
+	"type": "nfs",
+	"name": "My First Storage",
+	"nfs": {
+		"ip":"172.17.8.100",
+		"path":"/nfs"
+	}
+}
+
+Response Data:
+
+```json
+{
+  "error": false,
+  "message": "Create success"
+}
+```
+
+### List Storage
+**GET /v1/storage/**
+
+List all the storages we created before and adding new files.
+
+storageClassName: the storage class name we will used for volume
+
+
+Example:
+```
+curl http://localhost:7890/v1/storage/
+```
+
+Response Data:
+
+```json
+[
+    {
+        "id": "5b42d9944807c52e1c804fbb",
+        "type": "nfs",
+        "name": "My First Storage",
+        "createdAt": "2018-07-09T03:42:12.708Z",
+        "storageClassName": "nfs-storageclass-5b42d9944807c52e1c804fbb",
+        "nfs": {
+            "ip": "172.17.8.100",
+            "path": "/nfs"
+        }
+    }
+]
+```
+
+### Remove Storage
+**DELETE /v1/storage/[id]**
+
+Example:
+
+```
+curl -X DELETE http://localhost:7890/v1/storage/5b3475f94807c5199773910a
+```
+
+Response Data:
+
+```json
+{
+  "error": false,
+  "message": "Delete success"
+}
+```
+
+## Volume
+### Create Volume
+
+**POST /v1/volume**
+
+Request file:
+storageName: The Storage Name you created before, the system will allocate a space for the volume to use.
+accessMode: The accessMode of the Volume including the following options.
+- ReadWriteOnce
+- ReadWriteMany
+- ReeaOneMany
+But those options won't work for NFS storage since the permission is controled by the linux permission system.
+capacity: The capacity of the volume, 
+
+Example:
+
+```
+curl -X POST -H "Content-Type: application/json" \
+     -d '{"storageName":"My First Storage","name":"My Log","accessMode":"ReadWriteMany","capacity":"300Gi"}' \
+     http://localhost:7890/v1/storage
+```
+
+Request Data:
+```json
+{
+	"storageName": "My First Storage",
+	"name": "My Log",
+	"accessMode":"ReadWriteMany",
+	"capacity":"300Gi"
+}
+
+Response Data:
+
+```json
+{
+  "error": false,
+  "message": "Create success"
+}
+```
+
+
+### List Volume
+
+**GET /v1/volume/**
+
+List all the volumes we created.
+
+storageClassName: the storage class name we will used for volume
+
+
+Example:
+```
+curl http://localhost:7890/v1/storage/
+```
+
+Response Data:
+
+```json
+[
+    {
+        "id": "5b42f25c4807c52e1c804fbc",
+        "name": "My Log",
+        "storageName": "My First Storage2",
+        "accessMode": "ReadWriteMany",
+        "capacity": "300",
+        "createdAt": "2018-07-09T05:27:56.244Z"    
+    }
+]
+```
+
+
+### Remove Volume
+
+**DELETE /v1/volume/[id]**
+
+Example:
+
+```
+curl -X DELETE http://localhost:7890/v1/volume/5b3475f94807c5199773910a
+```
+
+Response Data:
+
+```json
+{
+  "error": false,
+  "message": "Delete success"
+}
+```