Browse code

Add docs for volume plugin ls/get

Signed-off-by: Brian Goff <cpuguy83@gmail.com>

Brian Goff authored on 2016/01/06 11:07:34
Showing 1 changed files
... ...
@@ -54,7 +54,7 @@ containers.
54 54
 ### /VolumeDriver.Create
55 55
 
56 56
 **Request**:
57
-```
57
+```json
58 58
 {
59 59
     "Name": "volume_name",
60 60
     "Opts": {}
... ...
@@ -67,7 +67,7 @@ volume on the filesystem yet (until Mount is called).
67 67
 Opts is a map of driver specific options passed through from the user request.
68 68
 
69 69
 **Response**:
70
-```
70
+```json
71 71
 {
72 72
     "Err": ""
73 73
 }
... ...
@@ -78,7 +78,7 @@ Respond with a string error if an error occurred.
78 78
 ### /VolumeDriver.Remove
79 79
 
80 80
 **Request**:
81
-```
81
+```json
82 82
 {
83 83
     "Name": "volume_name"
84 84
 }
... ...
@@ -87,7 +87,7 @@ Respond with a string error if an error occurred.
87 87
 Delete the specified volume from disk. This request is issued when a user invokes `docker rm -v` to remove volumes associated with a container.
88 88
 
89 89
 **Response**:
90
-```
90
+```json
91 91
 {
92 92
     "Err": ""
93 93
 }
... ...
@@ -98,7 +98,7 @@ Respond with a string error if an error occurred.
98 98
 ### /VolumeDriver.Mount
99 99
 
100 100
 **Request**:
101
-```
101
+```json
102 102
 {
103 103
     "Name": "volume_name"
104 104
 }
... ...
@@ -110,7 +110,7 @@ more than once, the plugin may need to keep track of each new mount request and
110 110
 at the first mount request and deprovision at the last corresponding unmount request.
111 111
 
112 112
 **Response**:
113
-```
113
+```json
114 114
 {
115 115
     "Mountpoint": "/path/to/directory/on/host",
116 116
     "Err": ""
... ...
@@ -123,7 +123,7 @@ available, and/or a string error if an error occurred.
123 123
 ### /VolumeDriver.Path
124 124
 
125 125
 **Request**:
126
-```
126
+```json
127 127
 {
128 128
     "Name": "volume_name"
129 129
 }
... ...
@@ -132,7 +132,7 @@ available, and/or a string error if an error occurred.
132 132
 Docker needs reminding of the path to the volume on the host.
133 133
 
134 134
 **Response**:
135
-```
135
+```json
136 136
 {
137 137
     "Mountpoint": "/path/to/directory/on/host",
138 138
     "Err": ""
... ...
@@ -145,7 +145,7 @@ available, and/or a string error if an error occurred.
145 145
 ### /VolumeDriver.Unmount
146 146
 
147 147
 **Request**:
148
-```
148
+```json
149 149
 {
150 150
     "Name": "volume_name"
151 151
 }
... ...
@@ -156,7 +156,7 @@ per container stop.  Plugin may deduce that it is safe to deprovision it at
156 156
 this point.
157 157
 
158 158
 **Response**:
159
-```
159
+```json
160 160
 {
161 161
     "Err": ""
162 162
 }
... ...
@@ -164,3 +164,54 @@ this point.
164 164
 
165 165
 Respond with a string error if an error occurred.
166 166
 
167
+
168
+### /VolumeDriver.Get
169
+
170
+**Request**:
171
+```json
172
+{
173
+    "Name": "volume_name"
174
+}
175
+```
176
+
177
+Get the volume info.
178
+
179
+
180
+**Response**:
181
+```json
182
+{
183
+  "Volume": {
184
+    "Name": "volume_name",
185
+    "Mountpoint": "/path/to/directory/on/host",
186
+  },
187
+  "Err": ""
188
+}
189
+```
190
+
191
+Respond with a string error if an error occurred.
192
+
193
+
194
+### /VolumeDriver.List
195
+
196
+**Request**:
197
+```json
198
+{}
199
+```
200
+
201
+Get the list of volumes registered with the plugin.
202
+
203
+**Response**:
204
+```json
205
+{
206
+  "Volumes": [
207
+    {
208
+      "Name": "volume_name",
209
+      "Mountpoint": "/path/to/directory/on/host"
210
+    }
211
+  ],
212
+  "Err": ""
213
+}
214
+```
215
+
216
+Respond with a string error if an error occurred.
217
+