Browse code

replace no-remove by sample-volume-plugin in docs

Signed-off-by: Victor Vieux <vieux@docker.com>

Victor Vieux authored on 2016/12/14 17:35:34
Showing 11 changed files
... ...
@@ -1498,74 +1498,39 @@ definitions:
1498 1498
                   type: "string"
1499 1499
     example:
1500 1500
       Id: "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078"
1501
-      Name: "tiborvass/no-remove"
1501
+      Name: "tiborvass/sample-volume-plugin"
1502 1502
       Tag: "latest"
1503 1503
       Active: true
1504
-      Config:
1505
-        Mounts:
1506
-          - Name: ""
1507
-            Description: ""
1508
-            Settable: null
1509
-            Source: "/data"
1510
-            Destination: "/data"
1511
-            Type: "bind"
1512
-            Options:
1513
-              - "shared"
1514
-              - "rbind"
1515
-          - Name: ""
1516
-            Description: ""
1517
-            Settable: null
1518
-            Source: null
1519
-            Destination: "/foobar"
1520
-            Type: "tmpfs"
1521
-            Options: null
1504
+      Settings:
1522 1505
         Env:
1523
-          - "DEBUG=1"
1506
+          - "DEBUG=0"
1524 1507
         Args: null
1525 1508
         Devices: null
1526
-      Manifest:
1527
-        ManifestVersion: "v0"
1528
-        Description: "A test plugin for Docker"
1509
+      Config:
1510
+        Description: "A sample volume plugin for Docker"
1529 1511
         Documentation: "https://docs.docker.com/engine/extend/plugins/"
1530 1512
         Interface:
1531 1513
           Types:
1532 1514
             - "docker.volumedriver/1.0"
1533 1515
           Socket: "plugins.sock"
1534 1516
         Entrypoint:
1535
-          - "plugin-no-remove"
1517
+          - "/usr/bin/sample-volume-plugin"
1536 1518
           - "/data"
1537 1519
         WorkDir: ""
1538 1520
         User: {}
1539 1521
         Network:
1540
-          Type: "host"
1541
-        Capabilities: null
1542
-        Mounts:
1543
-          - Name: ""
1544
-            Description: ""
1545
-            Settable: null
1546
-            Source: "/data"
1547
-            Destination: "/data"
1548
-            Type: "bind"
1549
-            Options:
1550
-              - "shared"
1551
-              - "rbind"
1552
-          - Name: ""
1553
-            Description: ""
1554
-            Settable: null
1555
-            Source: null
1556
-            Destination: "/foobar"
1557
-            Type: "tmpfs"
1558
-            Options: null
1559
-        Devices:
1560
-          - Name: "device"
1561
-            Description: "a host device to mount"
1562
-            Settable: null
1563
-            Path: "/dev/cpu_dma_latency"
1522
+          Type: ""
1523
+        Linux:
1524
+          Capabilities: null
1525
+          DeviceCreation: false
1526
+          Devices: null
1527
+        Mounts: null
1528
+        PropagatedMount: "/data"
1564 1529
         Env:
1565 1530
           - Name: "DEBUG"
1566 1531
             Description: "If set, prints debug messages"
1567 1532
             Settable: null
1568
-            Value: "1"
1533
+            Value: "0"
1569 1534
         Args:
1570 1535
           Name: "args"
1571 1536
           Description: "command line arguments"
... ...
@@ -6374,74 +6339,39 @@ paths:
6374 6374
               $ref: "#/definitions/Plugin"
6375 6375
             example:
6376 6376
               - Id: "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078"
6377
-                Name: "tiborvass/no-remove"
6377
+                Name: "tiborvass/sample-volume-plugin"
6378 6378
                 Tag: "latest"
6379 6379
                 Active: true
6380
-                Config:
6381
-                  Mounts:
6382
-                    - Name: ""
6383
-                      Description: ""
6384
-                      Settable: null
6385
-                      Source: "/data"
6386
-                      Destination: "/data"
6387
-                      Type: "bind"
6388
-                      Options:
6389
-                        - "shared"
6390
-                        - "rbind"
6391
-                    - Name: ""
6392
-                      Description: ""
6393
-                      Settable: null
6394
-                      Source: null
6395
-                      Destination: "/foobar"
6396
-                      Type: "tmpfs"
6397
-                      Options: null
6380
+                Settings:
6398 6381
                   Env:
6399
-                    - "DEBUG=1"
6382
+                    - "DEBUG=0"
6400 6383
                   Args: null
6401 6384
                   Devices: null
6402
-                Manifest:
6403
-                  ManifestVersion: "v0"
6404
-                  Description: "A test plugin for Docker"
6385
+                Config:
6386
+                  Description: "A sample volume plugin for Docker"
6405 6387
                   Documentation: "https://docs.docker.com/engine/extend/plugins/"
6406 6388
                   Interface:
6407 6389
                     Types:
6408 6390
                       - "docker.volumedriver/1.0"
6409 6391
                     Socket: "plugins.sock"
6410 6392
                   Entrypoint:
6411
-                    - "plugin-no-remove"
6393
+                    - "/usr/bin/sample-volume-plugin"
6412 6394
                     - "/data"
6413 6395
                   WorkDir: ""
6414 6396
                   User: {}
6415 6397
                   Network:
6416
-                    Type: "host"
6417
-                  Capabilities: null
6418
-                  Mounts:
6419
-                    - Name: ""
6420
-                      Description: ""
6421
-                      Settable: null
6422
-                      Source: "/data"
6423
-                      Destination: "/data"
6424
-                      Type: "bind"
6425
-                      Options:
6426
-                        - "shared"
6427
-                        - "rbind"
6428
-                    - Name: ""
6429
-                      Description: ""
6430
-                      Settable: null
6431
-                      Source: null
6432
-                      Destination: "/foobar"
6433
-                      Type: "tmpfs"
6434
-                      Options: null
6435
-                  Devices:
6436
-                    - Name: "device"
6437
-                      Description: "a host device to mount"
6438
-                      Settable: null
6439
-                      Path: "/dev/cpu_dma_latency"
6398
+                    Type: ""
6399
+                  Linux:
6400
+                    Capabilities: null
6401
+                    DeviceCreation: false
6402
+                    Devices: null
6403
+                  Mounts: null
6404
+                  PropagatedMount: "/data"
6440 6405
                   Env:
6441 6406
                     - Name: "DEBUG"
6442 6407
                       Description: "If set, prints debug messages"
6443 6408
                       Settable: null
6444
-                      Value: "1"
6409
+                      Value: "0"
6445 6410
                   Args:
6446 6411
                     Name: "args"
6447 6412
                     Description: "command line arguments"
... ...
@@ -171,52 +171,49 @@ Config provides the base accessible fields for working with V0 plugin format
171 171
 
172 172
 ## Example Config
173 173
 
174
-*Example showing the 'tiborvass/no-remove' plugin config.*
174
+*Example showing the 'tiborvass/sample-volume-plugin' plugin config.*
175 175
 
176 176
 ```json
177 177
 {
178
-  "description": "A test plugin for Docker",
179
-  "documentation": "https://docs.docker.com/engine/extend/plugins/",
180
-  "entrypoint": ["plugin-no-remove", "/data"],
181
-  "interface": {
182
-    "types": ["docker.volumedriver/1.0"],
183
-    "socket": "plugins.sock"
184
-  },
185
-  "network": {
186
-    "type": "host"
187
-  },
188
-  "mounts": [
189
-    {
190
-      "source": "/data",
191
-      "destination": "/data",
192
-      "type": "bind",
193
-      "options": ["shared", "rbind"]
194
-    },
195
-    {
196
-      "destination": "/foobar",
197
-      "type": "tmpfs"
198
-    }
199
-  ],
200
-  "args": {
201
-    "name": "args",
202
-    "description": "command line arguments",
203
-    "value": []
204
-  },
205
-  "env": [
206
-    {
207
-      "name": "DEBUG",
208
-      "description": "If set, prints debug messages",
209
-      "value": "1"
210
-    }
211
-  ],
212
-  "linux": {
213
-    "devices": [
214
-      {
215
-        "name": "device",
216
-        "description": "a host device to mount",
217
-        "path": "/dev/cpu_dma_latency"
218
-      }
219
-    ]
220
-  }
178
+            "Args": {
179
+                "Description": "",
180
+                "Name": "",
181
+                "Settable": null,
182
+                "Value": null
183
+            },
184
+            "Description": "A sample volume plugin for Docker",
185
+            "Documentation": "https://docs.docker.com/engine/extend/plugins/",
186
+            "Entrypoint": [
187
+                "/usr/bin/sample-volume-plugin",
188
+                "/data"
189
+            ],
190
+            "Env": [
191
+                {
192
+                    "Description": "",
193
+                    "Name": "DEBUG",
194
+                    "Settable": [
195
+                        "value"
196
+                    ],
197
+                    "Value": "0"
198
+                }
199
+            ],
200
+            "Interface": {
201
+                "Socket": "plugin.sock",
202
+                "Types": [
203
+                    "docker.volumedriver/1.0"
204
+                ]
205
+            },
206
+            "Linux": {
207
+                "Capabilities": null,
208
+                "DeviceCreation": false,
209
+                "Devices": null
210
+            },
211
+            "Mounts": null,
212
+            "Network": {
213
+                "Type": ""
214
+            },
215
+            "PropagatedMount": "/data",
216
+            "User": {},
217
+            "Workdir": ""
221 218
 }
222 219
 ```
... ...
@@ -194,8 +194,8 @@ relative to the current time on the client machine:
194 194
     2015-12-23T21:38:25.119625123Z network connect 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, container=b4be644031a3d90b400f88ab3d4bdf4dc23adb250e696b6328b85441abe2c54e, type=bridge)
195 195
 
196 196
     $ docker events --filter 'type=plugin' (experimental)
197
-    2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/no-remove:latest)
198
-    2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/no-remove:latest)
197
+    2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest)
198
+    2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest)
199 199
 
200 200
 **Format:**
201 201
 
... ...
@@ -30,27 +30,27 @@ see [`docker plugin install`](plugin_install.md). Without the `-f` option,
30 30
 a plugin that has references (eg, volumes, networks) cannot be disabled.
31 31
 
32 32
 
33
-The following example shows that the `no-remove` plugin is installed
33
+The following example shows that the `sample-volume-plugin` plugin is installed
34 34
 and enabled:
35 35
 
36 36
 ```bash
37 37
 $ docker plugin ls
38 38
 
39
-ID                  NAME                  TAG                 DESCRIPTION                ENABLED
40
-69553ca1d123        tiborvass/no-remove   latest              A test plugin for Docker   true
39
+ID                  NAME                             TAG                 DESCRIPTION                ENABLED
40
+69553ca1d123        tiborvass/sample-volume-plugin   latest              A test plugin for Docker   true
41 41
 ```
42 42
 
43 43
 To disable the plugin, use the following command:
44 44
 
45 45
 ```bash
46
-$ docker plugin disable tiborvass/no-remove
46
+$ docker plugin disable tiborvass/sample-volume-plugin
47 47
 
48
-tiborvass/no-remove
48
+tiborvass/sample-volume-plugin
49 49
 
50 50
 $ docker plugin ls
51 51
 
52
-ID                  NAME                  TAG                 DESCRIPTION                ENABLED
53
-69553ca1d123        tiborvass/no-remove   latest              A test plugin for Docker   false
52
+ID                  NAME                             TAG                 DESCRIPTION                ENABLED
53
+69553ca1d123        tiborvass/sample-volume-plugin   latest              A test plugin for Docker   false
54 54
 ```
55 55
 
56 56
 ## Related information
... ...
@@ -29,27 +29,27 @@ Enables a plugin. The plugin must be installed before it can be enabled,
29 29
 see [`docker plugin install`](plugin_install.md).
30 30
 
31 31
 
32
-The following example shows that the `no-remove` plugin is installed,
32
+The following example shows that the `sample-volume-plugin` plugin is installed,
33 33
 but disabled:
34 34
 
35 35
 ```bash
36 36
 $ docker plugin ls
37 37
 
38
-ID                  NAME                  TAG                 DESCRIPTION                ENABLED
39
-69553ca1d123        tiborvass/no-remove   latest              A test plugin for Docker   false
38
+ID                  NAME                             TAG                 DESCRIPTION                ENABLED
39
+69553ca1d123        tiborvass/sample-volume-plugin   latest              A test plugin for Docker   false
40 40
 ```
41 41
 
42 42
 To enable the plugin, use the following command:
43 43
 
44 44
 ```bash
45
-$ docker plugin enable tiborvass/no-remove
45
+$ docker plugin enable tiborvass/sample-volume-plugin
46 46
 
47
-tiborvass/no-remove
47
+tiborvass/sample-volume-plugin
48 48
 
49 49
 $ docker plugin ls
50 50
 
51
-ID                  NAME                  TAG                 DESCRIPTION                ENABLED
52
-69553ca1d123        tiborvass/no-remove   latest              A test plugin for Docker   true
51
+ID                  NAME                             TAG                 DESCRIPTION                ENABLED
52
+69553ca1d123        tiborvass/sample-volume-plugin   latest              A test plugin for Docker   true
53 53
 ```
54 54
 
55 55
 ## Related information
... ...
@@ -31,12 +31,12 @@ in a JSON array.
31 31
 Example output:
32 32
 
33 33
 ```bash
34
-$ docker plugin inspect tiborvass/no-remove:latest
34
+$ docker plugin inspect tiborvass/sample-volume-plugin:latest
35 35
 ```
36 36
 ```JSON
37 37
 {
38 38
   "Id": "8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21",
39
-  "Name": "tiborvass/no-remove:latest",
39
+  "Name": "tiborvass/sample-volume-plugin:latest",
40 40
   "Enabled": true,
41 41
   "Config": {
42 42
     "Mounts": [
... ...
@@ -79,7 +79,7 @@ $ docker plugin inspect tiborvass/no-remove:latest
79 79
       "Socket": "plugins.sock"
80 80
     },
81 81
     "Entrypoint": [
82
-      "plugin-no-remove",
82
+      "plugin-sample-volume-plugin",
83 83
       "/data"
84 84
     ],
85 85
     "Workdir": "",
... ...
@@ -143,7 +143,7 @@ $ docker plugin inspect tiborvass/no-remove:latest
143 143
 
144 144
 
145 145
 ```bash
146
-$ docker plugin inspect -f '{{.Id}}' tiborvass/no-remove:latest
146
+$ docker plugin inspect -f '{{.Id}}' tiborvass/sample-volume-plugin:latest
147 147
 ```
148 148
 ```
149 149
 8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21
... ...
@@ -33,20 +33,20 @@ the registry. Note that the minimum required registry version to distribute
33 33
 plugins is 2.3.0
34 34
 
35 35
 
36
-The following example installs `no-remove` plugin and [set](plugin_set.md) it's env variable
36
+The following example installs `vieus/sshfs` plugin and [set](plugin_set.md) it's env variable
37 37
 `DEBUG` to 1. Install consists of pulling the plugin from Docker Hub, prompting
38 38
 the user to accept the list of privileges that the plugin needs, settings parameters
39 39
  and enabling the plugin.
40 40
 
41 41
 ```bash
42
-$ docker plugin install tiborvass/no-remove DEBUG=1
42
+$ docker plugin install vieux/sshfs DEBUG=1
43 43
 
44
-Plugin "tiborvass/no-remove" is requesting the following privileges:
44
+Plugin "vieux/sshfs" is requesting the following privileges:
45 45
  - network: [host]
46
- - mount: [/data]
47
- - device: [/dev/cpu_dma_latency]
46
+ - device: [/dev/fuse]
47
+ - capabilities: [CAP_SYS_ADMIN]
48 48
 Do you grant the above permissions? [y/N] y
49
-tiborvass/no-remove
49
+vieux/sshfs
50 50
 ```
51 51
 
52 52
 After the plugin is installed, it appears in the list of plugins:
... ...
@@ -55,7 +55,7 @@ After the plugin is installed, it appears in the list of plugins:
55 55
 $ docker plugin ls
56 56
 
57 57
 ID                  NAME                  TAG                 DESCRIPTION                ENABLED
58
-69553ca1d123        tiborvass/no-remove   latest              A test plugin for Docker   true
58
+69553ca1d123        vieux/sshfs           latest              sshFS plugin for Docker    true
59 59
 ```
60 60
 
61 61
 ## Related information
... ...
@@ -36,8 +36,8 @@ Example output:
36 36
 ```bash
37 37
 $ docker plugin ls
38 38
 
39
-ID                  NAME                  TAG                 DESCRIPTION                ENABLED
40
-69553ca1d123        tiborvass/no-remove   latest              A test plugin for Docker   true
39
+ID                  NAME                             TAG                 DESCRIPTION                ENABLED
40
+69553ca1d123        tiborvass/sample-volume-plugin   latest              A test plugin for Docker   true
41 41
 ```
42 42
 
43 43
 ## Related information
... ...
@@ -33,14 +33,14 @@ a plugin using the [`docker plugin disable`](plugin_disable.md) before removing
33 33
 it (or use --force, use of force is not recommended, since it can affect
34 34
 functioning of running containers using the plugin).
35 35
 
36
-The following example disables and removes the `no-remove:latest` plugin;
36
+The following example disables and removes the `sample-volume-plugin:latest` plugin;
37 37
 
38 38
 ```bash
39
-$ docker plugin disable tiborvass/no-remove
40
-tiborvass/no-remove
39
+$ docker plugin disable tiborvass/sample-volume-plugin
40
+tiborvass/sample-volume-plugin
41 41
 
42
-$ docker plugin rm tiborvass/no-remove:latest
43
-tiborvass/no-remove
42
+$ docker plugin rm tiborvass/sample-volume-plugin:latest
43
+tiborvass/sample-volume-plugin
44 44
 ```
45 45
 
46 46
 ## Related information
... ...
@@ -33,15 +33,15 @@ The settings currently supported are:
33 33
  * args
34 34
 
35 35
 The following example change the env variable `DEBUG` on the
36
-`no-remove` plugin.
36
+`sample-volume-plugin` plugin.
37 37
 
38 38
 ```bash
39
-$ docker plugin inspect -f {{.Settings.Env}} tiborvass/no-remove
39
+$ docker plugin inspect -f {{.Settings.Env}} tiborvass/sample-volume-plugin
40 40
 [DEBUG=0]
41 41
 
42
-$ docker plugin set tiborvass/no-remove DEBUG=1
42
+$ docker plugin set tiborvass/sample-volume-plugin DEBUG=1
43 43
 
44
-$ docker plugin inspect -f {{.Settings.Env}} tiborvass/no-remove
44
+$ docker plugin inspect -f {{.Settings.Env}} tiborvass/sample-volume-plugin
45 45
 [DEBUG=1]
46 46
 ```
47 47
 
... ...
@@ -129,6 +129,6 @@ Lines. For information about JSON Lines, please refer to http://jsonlines.org/ .
129 129
     2015-12-23T21:38:25.119625123Z network connect 8b111217944ba0ba844a65b13efcd57dc494932ee2527577758f939315ba2c5b (name=test-event-network-local, container=b4be644031a3d90b400f88ab3d4bdf4dc23adb250e696b6328b85441abe2c54e, type=bridge)
130 130
 
131 131
     $ docker events --filter 'type=plugin' (experimental)
132
-    2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/no-remove:latest)
133
-    2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/no-remove:latest)
132
+    2016-07-25T17:30:14.825557616Z plugin pull ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest)
133
+    2016-07-25T17:30:14.888127370Z plugin enable ec7b87f2ce84330fe076e666f17dfc049d2d7ae0b8190763de94e1f2d105993f (name=tiborvass/sample-volume-plugin:latest)
134 134