|
@@ -1,17 +1,12 @@
|
|
-<!--[metadata]>
|
|
|
|
-+++
|
|
|
|
-aliases = [
|
|
|
|
|
|
+---
|
|
|
|
+aliases: [
|
|
"/engine/extend/"
|
|
"/engine/extend/"
|
|
]
|
|
]
|
|
-title = "Plugin manifest"
|
|
|
|
-description = "How develop and use a plugin with the managed plugin system"
|
|
|
|
-keywords = ["API, Usage, plugins, documentation, developer"]
|
|
|
|
-advisory = "experimental"
|
|
|
|
-[menu.main]
|
|
|
|
-parent = "engine_extend"
|
|
|
|
-weight=1
|
|
|
|
-+++
|
|
|
|
-<![end-metadata]-->
|
|
|
|
|
|
+title: "Plugin manifest"
|
|
|
|
+description: "How develop and use a plugin with the managed plugin system"
|
|
|
|
+keywords: ["API, Usage, plugins, documentation, developer"]
|
|
|
|
+advisory: "experimental"
|
|
|
|
+---
|
|
|
|
|
|
# Plugin Manifest Version 0 of Plugin V2
|
|
# Plugin Manifest Version 0 of Plugin V2
|
|
|
|
|
|
@@ -47,7 +42,7 @@ Manifest provides the base accessible fields for working with V0 plugin format
|
|
- **`interface`** *PluginInterface*
|
|
- **`interface`** *PluginInterface*
|
|
|
|
|
|
interface implemented by the plugins, struct consisting of the following fields
|
|
interface implemented by the plugins, struct consisting of the following fields
|
|
-
|
|
|
|
|
|
+
|
|
- **`types`** *string array*
|
|
- **`types`** *string array*
|
|
|
|
|
|
types indicate what interface(s) the plugin currently implements.
|
|
types indicate what interface(s) the plugin currently implements.
|
|
@@ -55,9 +50,9 @@ Manifest provides the base accessible fields for working with V0 plugin format
|
|
currently supported:
|
|
currently supported:
|
|
|
|
|
|
- **docker.volumedriver/1.0**
|
|
- **docker.volumedriver/1.0**
|
|
-
|
|
|
|
|
|
+
|
|
- **`socket`** *string*
|
|
- **`socket`** *string*
|
|
-
|
|
|
|
|
|
+
|
|
socket is the name of the socket the engine should use to communicate with the plugins.
|
|
socket is the name of the socket the engine should use to communicate with the plugins.
|
|
the socket will be created in `/run/docker/plugins`.
|
|
the socket will be created in `/run/docker/plugins`.
|
|
|
|
|
|
@@ -73,7 +68,7 @@ Manifest provides the base accessible fields for working with V0 plugin format
|
|
- **`network`** *PluginNetwork*
|
|
- **`network`** *PluginNetwork*
|
|
|
|
|
|
network of the plugin, struct consisting of the following fields
|
|
network of the plugin, struct consisting of the following fields
|
|
-
|
|
|
|
|
|
+
|
|
- **`type`** *string*
|
|
- **`type`** *string*
|
|
|
|
|
|
network type.
|
|
network type.
|
|
@@ -83,11 +78,11 @@ Manifest provides the base accessible fields for working with V0 plugin format
|
|
- **bridge**
|
|
- **bridge**
|
|
- **host**
|
|
- **host**
|
|
- **none**
|
|
- **none**
|
|
-
|
|
|
|
|
|
+
|
|
- **`capabilities`** *array*
|
|
- **`capabilities`** *array*
|
|
|
|
|
|
capabilities of the plugin (*Linux only*), see list [`here`](https://github.com/opencontainers/runc/blob/master/libcontainer/SPEC.md#security)
|
|
capabilities of the plugin (*Linux only*), see list [`here`](https://github.com/opencontainers/runc/blob/master/libcontainer/SPEC.md#security)
|
|
-
|
|
|
|
|
|
+
|
|
- **`mounts`** *PluginMount array*
|
|
- **`mounts`** *PluginMount array*
|
|
|
|
|
|
mount of the plugin, struct consisting of the following fields, see [`MOUNTS`](https://github.com/opencontainers/runtime-spec/blob/master/config.md#mounts)
|
|
mount of the plugin, struct consisting of the following fields, see [`MOUNTS`](https://github.com/opencontainers/runtime-spec/blob/master/config.md#mounts)
|
|
@@ -95,27 +90,27 @@ Manifest provides the base accessible fields for working with V0 plugin format
|
|
- **`name`** *string*
|
|
- **`name`** *string*
|
|
|
|
|
|
name of the mount.
|
|
name of the mount.
|
|
-
|
|
|
|
|
|
+
|
|
- **`description`** *string*
|
|
- **`description`** *string*
|
|
-
|
|
|
|
|
|
+
|
|
description of the mount.
|
|
description of the mount.
|
|
-
|
|
|
|
|
|
+
|
|
- **`source`** *string*
|
|
- **`source`** *string*
|
|
|
|
|
|
source of the mount.
|
|
source of the mount.
|
|
-
|
|
|
|
|
|
+
|
|
- **`destination`** *string*
|
|
- **`destination`** *string*
|
|
|
|
|
|
destination of the mount.
|
|
destination of the mount.
|
|
-
|
|
|
|
|
|
+
|
|
- **`type`** *string*
|
|
- **`type`** *string*
|
|
|
|
|
|
mount type.
|
|
mount type.
|
|
-
|
|
|
|
|
|
+
|
|
- **`options`** *string array*
|
|
- **`options`** *string array*
|
|
|
|
|
|
options of the mount.
|
|
options of the mount.
|
|
-
|
|
|
|
|
|
+
|
|
- **`devices`** *PluginDevice array*
|
|
- **`devices`** *PluginDevice array*
|
|
|
|
|
|
device of the plugin, (*Linux only*), struct consisting of the following fields, see [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices)
|
|
device of the plugin, (*Linux only*), struct consisting of the following fields, see [`DEVICES`](https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#devices)
|
|
@@ -123,11 +118,11 @@ Manifest provides the base accessible fields for working with V0 plugin format
|
|
- **`name`** *string*
|
|
- **`name`** *string*
|
|
|
|
|
|
name of the device.
|
|
name of the device.
|
|
-
|
|
|
|
|
|
+
|
|
- **`description`** *string*
|
|
- **`description`** *string*
|
|
|
|
|
|
description of the device.
|
|
description of the device.
|
|
-
|
|
|
|
|
|
+
|
|
- **`path`** *string*
|
|
- **`path`** *string*
|
|
|
|
|
|
path of the device.
|
|
path of the device.
|
|
@@ -139,15 +134,15 @@ Manifest provides the base accessible fields for working with V0 plugin format
|
|
- **`name`** *string*
|
|
- **`name`** *string*
|
|
|
|
|
|
name of the env.
|
|
name of the env.
|
|
-
|
|
|
|
|
|
+
|
|
- **`description`** *string*
|
|
- **`description`** *string*
|
|
-
|
|
|
|
|
|
+
|
|
description of the env.
|
|
description of the env.
|
|
-
|
|
|
|
|
|
+
|
|
- **`value`** *string*
|
|
- **`value`** *string*
|
|
|
|
|
|
value of the env.
|
|
value of the env.
|
|
-
|
|
|
|
|
|
+
|
|
- **`args`** *PluginArgs*
|
|
- **`args`** *PluginArgs*
|
|
|
|
|
|
args of the plugin, struct consisting of the following fields
|
|
args of the plugin, struct consisting of the following fields
|
|
@@ -155,16 +150,16 @@ Manifest provides the base accessible fields for working with V0 plugin format
|
|
- **`name`** *string*
|
|
- **`name`** *string*
|
|
|
|
|
|
name of the env.
|
|
name of the env.
|
|
-
|
|
|
|
|
|
+
|
|
- **`description`** *string*
|
|
- **`description`** *string*
|
|
-
|
|
|
|
|
|
+
|
|
description of the env.
|
|
description of the env.
|
|
-
|
|
|
|
|
|
+
|
|
- **`value`** *string array*
|
|
- **`value`** *string array*
|
|
|
|
|
|
values of the args.
|
|
values of the args.
|
|
-
|
|
|
|
-
|
|
|
|
|
|
+
|
|
|
|
+
|
|
## Example Manifest
|
|
## Example Manifest
|
|
|
|
|
|
*Example showing the 'tiborvass/no-remove' plugin manifest.*
|
|
*Example showing the 'tiborvass/no-remove' plugin manifest.*
|