Type Alias: Plugin ​
Plugin:
object
A plugin for the Engine API
Type declaration ​
| Name | Type | Description |
|---|---|---|
Config | object | The config of a plugin. |
Config.Args | object | - |
Config.Args.Description | string | - |
Config.Args.Name | string | - |
Config.Args.Settable | string[] | - |
Config.Args.Value | string[] | - |
Config.Description | string | - |
Config.DockerVersion? | string | Docker Version used to create the plugin |
Config.Documentation | string | - |
Config.Entrypoint | string[] | - |
Config.Env | PluginEnv[] | - |
Config.Interface | object | The interface between Docker and the plugin |
Config.Interface.ProtocolScheme? | "" | "moby.plugins.http/v1" | Protocol to use for clients connecting to the plugin. |
Config.Interface.Socket | string | - |
Config.Interface.Types | PluginInterfaceType[] | - |
Config.IpcHost | boolean | - |
Config.Linux | object | - |
Config.Linux.AllowAllDevices | boolean | - |
Config.Linux.Capabilities | string[] | - |
Config.Linux.Devices | PluginDevice[] | - |
Config.Mounts | PluginMount[] | - |
Config.Network | object | - |
Config.Network.Type | string | - |
Config.PidHost | boolean | - |
Config.PropagatedMount | string | - |
Config.rootfs? | object | - |
Config.rootfs.diff_ids? | string[] | - |
Config.rootfs.type? | string | - |
Config.User? | object | - |
Config.User.GID? | number | - |
Config.User.UID? | number | - |
Config.WorkDir | string | - |
Enabled | boolean | True if the plugin is running. False if the plugin is not running, only installed. |
Id? | string | - |
Name | string | - |
PluginReference? | string | plugin remote reference used to push/pull the plugin |
Settings | object | Settings that can be modified by users. |
Settings.Args | string[] | - |
Settings.Devices | PluginDevice[] | - |
Settings.Env | string[] | - |
Settings.Mounts | PluginMount[] | - |