Search or ask Docker

Plugin

Plugin schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

A plugin for the Engine API
Config · required

Type: object

The config of a plugin.
Args · required

Type: object

Description · required

Type: string

All schema constraints and annotations
{
  "example": "command line arguments",
  "type": "string",
  "x-nullable": false
}
Name · required

Type: string

All schema constraints and annotations
{
  "example": "args",
  "type": "string",
  "x-nullable": false
}
Settable · required

Type: array

All schema constraints and annotations
{
  "items": {
    "type": "string"
  },
  "type": "array"
}
Value · required

Type: array

All schema constraints and annotations
{
  "items": {
    "type": "string"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "properties": {
    "Description": {
      "example": "command line arguments",
      "type": "string",
      "x-nullable": false
    },
    "Name": {
      "example": "args",
      "type": "string",
      "x-nullable": false
    },
    "Settable": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Value": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "Name",
    "Description",
    "Settable",
    "Value"
  ],
  "type": "object",
  "x-go-name": "Args",
  "x-nullable": false
}
Description · required

Type: string

All schema constraints and annotations
{
  "example": "A sample volume plugin for Docker",
  "type": "string",
  "x-nullable": false
}
Documentation · required

Type: string

All schema constraints and annotations
{
  "example": "https://docs.docker.com/engine/extend/plugins/",
  "type": "string",
  "x-nullable": false
}
Entrypoint · required

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "example": [
    "/usr/bin/sample-volume-plugin",
    "/data"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
Env · required

Type: array

Array item

Schema: PluginEnv

All schema constraints and annotations
{
  "$ref": "#/components/schemas/PluginEnv"
}
All schema constraints and annotations
{
  "example": [
    {
      "Description": "If set, prints debug messages",
      "Name": "DEBUG",
      "Settable": null,
      "Value": "0"
    }
  ],
  "items": {
    "$ref": "#/components/schemas/PluginEnv"
  },
  "type": "array"
}
Interface · required

Type: object

The interface between Docker and the plugin
ProtocolScheme

Type: string

Protocol to use for clients connecting to the plugin.
All schema constraints and annotations
{
  "description": "Protocol to use for clients connecting to the plugin.",
  "enum": [
    "",
    "moby.plugins.http/v1"
  ],
  "example": "some.protocol/v1.0",
  "type": "string"
}
Socket · required

Type: string

All schema constraints and annotations
{
  "example": "plugins.sock",
  "type": "string",
  "x-nullable": false
}
Types · required

Type: array

All schema constraints and annotations
{
  "example": [
    "docker.volumedriver/1.0"
  ],
  "items": {
    "type": "string",
    "x-go-type": {
      "type": "CapabilityID"
    }
  },
  "type": "array"
}
All schema constraints and annotations
{
  "description": "The interface between Docker and the plugin",
  "properties": {
    "ProtocolScheme": {
      "description": "Protocol to use for clients connecting to the plugin.",
      "enum": [
        "",
        "moby.plugins.http/v1"
      ],
      "example": "some.protocol/v1.0",
      "type": "string"
    },
    "Socket": {
      "example": "plugins.sock",
      "type": "string",
      "x-nullable": false
    },
    "Types": {
      "example": [
        "docker.volumedriver/1.0"
      ],
      "items": {
        "type": "string",
        "x-go-type": {
          "type": "CapabilityID"
        }
      },
      "type": "array"
    }
  },
  "required": [
    "Types",
    "Socket"
  ],
  "type": "object",
  "x-go-name": "Interface",
  "x-nullable": false
}
IpcHost · required

Type: boolean

All schema constraints and annotations
{
  "example": false,
  "type": "boolean",
  "x-nullable": false
}
Linux · required

Type: object

AllowAllDevices · required

Type: boolean

All schema constraints and annotations
{
  "example": false,
  "type": "boolean",
  "x-nullable": false
}
Capabilities · required

Type: array

All schema constraints and annotations
{
  "example": [
    "CAP_SYS_ADMIN",
    "CAP_SYSLOG"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
Devices · required

Type: array

All schema constraints and annotations
{
  "items": {
    "$ref": "#/components/schemas/PluginDevice"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "properties": {
    "AllowAllDevices": {
      "example": false,
      "type": "boolean",
      "x-nullable": false
    },
    "Capabilities": {
      "example": [
        "CAP_SYS_ADMIN",
        "CAP_SYSLOG"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Devices": {
      "items": {
        "$ref": "#/components/schemas/PluginDevice"
      },
      "type": "array"
    }
  },
  "required": [
    "Capabilities",
    "AllowAllDevices",
    "Devices"
  ],
  "type": "object",
  "x-go-name": "LinuxConfig",
  "x-nullable": false
}
Mounts · required

Type: array

Array item

Schema: PluginMount

All schema constraints and annotations
{
  "$ref": "#/components/schemas/PluginMount"
}
All schema constraints and annotations
{
  "items": {
    "$ref": "#/components/schemas/PluginMount"
  },
  "type": "array"
}
Network · required

Type: object

Type · required

Type: string

All schema constraints and annotations
{
  "example": "host",
  "type": "string",
  "x-nullable": false
}
All schema constraints and annotations
{
  "properties": {
    "Type": {
      "example": "host",
      "type": "string",
      "x-nullable": false
    }
  },
  "required": [
    "Type"
  ],
  "type": "object",
  "x-go-name": "NetworkConfig",
  "x-nullable": false
}
PidHost · required

Type: boolean

All schema constraints and annotations
{
  "example": false,
  "type": "boolean",
  "x-nullable": false
}
PropagatedMount · required

Type: string

All schema constraints and annotations
{
  "example": "/mnt/volumes",
  "type": "string",
  "x-nullable": false
}
User

Type: object

GID

Type: integer

All schema constraints and annotations
{
  "example": 1000,
  "format": "uint32",
  "type": "integer"
}
UID

Type: integer

All schema constraints and annotations
{
  "example": 1000,
  "format": "uint32",
  "type": "integer"
}
All schema constraints and annotations
{
  "properties": {
    "GID": {
      "example": 1000,
      "format": "uint32",
      "type": "integer"
    },
    "UID": {
      "example": 1000,
      "format": "uint32",
      "type": "integer"
    }
  },
  "type": "object",
  "x-go-name": "User",
  "x-nullable": false
}
WorkDir · required

Type: string

All schema constraints and annotations
{
  "example": "/bin/",
  "type": "string",
  "x-nullable": false
}
rootfs

Type: object

diff_ids

Type: array

All schema constraints and annotations
{
  "example": [
    "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887",
    "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
type

Type: string

All schema constraints and annotations
{
  "example": "layers",
  "type": "string"
}
All schema constraints and annotations
{
  "properties": {
    "diff_ids": {
      "example": [
        "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887",
        "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "example": "layers",
      "type": "string"
    }
  },
  "type": "object",
  "x-go-name": "RootFS"
}
All schema constraints and annotations
{
  "description": "The config of a plugin.",
  "properties": {
    "Args": {
      "properties": {
        "Description": {
          "example": "command line arguments",
          "type": "string",
          "x-nullable": false
        },
        "Name": {
          "example": "args",
          "type": "string",
          "x-nullable": false
        },
        "Settable": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "Value": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "Name",
        "Description",
        "Settable",
        "Value"
      ],
      "type": "object",
      "x-go-name": "Args",
      "x-nullable": false
    },
    "Description": {
      "example": "A sample volume plugin for Docker",
      "type": "string",
      "x-nullable": false
    },
    "Documentation": {
      "example": "https://docs.docker.com/engine/extend/plugins/",
      "type": "string",
      "x-nullable": false
    },
    "Entrypoint": {
      "example": [
        "/usr/bin/sample-volume-plugin",
        "/data"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Env": {
      "example": [
        {
          "Description": "If set, prints debug messages",
          "Name": "DEBUG",
          "Settable": null,
          "Value": "0"
        }
      ],
      "items": {
        "$ref": "#/components/schemas/PluginEnv"
      },
      "type": "array"
    },
    "Interface": {
      "description": "The interface between Docker and the plugin",
      "properties": {
        "ProtocolScheme": {
          "description": "Protocol to use for clients connecting to the plugin.",
          "enum": [
            "",
            "moby.plugins.http/v1"
          ],
          "example": "some.protocol/v1.0",
          "type": "string"
        },
        "Socket": {
          "example": "plugins.sock",
          "type": "string",
          "x-nullable": false
        },
        "Types": {
          "example": [
            "docker.volumedriver/1.0"
          ],
          "items": {
            "type": "string",
            "x-go-type": {
              "type": "CapabilityID"
            }
          },
          "type": "array"
        }
      },
      "required": [
        "Types",
        "Socket"
      ],
      "type": "object",
      "x-go-name": "Interface",
      "x-nullable": false
    },
    "IpcHost": {
      "example": false,
      "type": "boolean",
      "x-nullable": false
    },
    "Linux": {
      "properties": {
        "AllowAllDevices": {
          "example": false,
          "type": "boolean",
          "x-nullable": false
        },
        "Capabilities": {
          "example": [
            "CAP_SYS_ADMIN",
            "CAP_SYSLOG"
          ],
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "Devices": {
          "items": {
            "$ref": "#/components/schemas/PluginDevice"
          },
          "type": "array"
        }
      },
      "required": [
        "Capabilities",
        "AllowAllDevices",
        "Devices"
      ],
      "type": "object",
      "x-go-name": "LinuxConfig",
      "x-nullable": false
    },
    "Mounts": {
      "items": {
        "$ref": "#/components/schemas/PluginMount"
      },
      "type": "array"
    },
    "Network": {
      "properties": {
        "Type": {
          "example": "host",
          "type": "string",
          "x-nullable": false
        }
      },
      "required": [
        "Type"
      ],
      "type": "object",
      "x-go-name": "NetworkConfig",
      "x-nullable": false
    },
    "PidHost": {
      "example": false,
      "type": "boolean",
      "x-nullable": false
    },
    "PropagatedMount": {
      "example": "/mnt/volumes",
      "type": "string",
      "x-nullable": false
    },
    "User": {
      "properties": {
        "GID": {
          "example": 1000,
          "format": "uint32",
          "type": "integer"
        },
        "UID": {
          "example": 1000,
          "format": "uint32",
          "type": "integer"
        }
      },
      "type": "object",
      "x-go-name": "User",
      "x-nullable": false
    },
    "WorkDir": {
      "example": "/bin/",
      "type": "string",
      "x-nullable": false
    },
    "rootfs": {
      "properties": {
        "diff_ids": {
          "example": [
            "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887",
            "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"
          ],
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "type": {
          "example": "layers",
          "type": "string"
        }
      },
      "type": "object",
      "x-go-name": "RootFS"
    }
  },
  "required": [
    "Description",
    "Documentation",
    "Interface",
    "Entrypoint",
    "WorkDir",
    "Network",
    "Linux",
    "PidHost",
    "PropagatedMount",
    "IpcHost",
    "Mounts",
    "Env",
    "Args"
  ],
  "type": "object",
  "x-go-name": "Config",
  "x-nullable": false
}
Enabled · required

Type: boolean

True if the plugin is running. False if the plugin is not running, only installed.
All schema constraints and annotations
{
  "description": "True if the plugin is running. False if the plugin is not running, only installed.",
  "example": true,
  "type": "boolean",
  "x-nullable": false
}
Id

Type: string

All schema constraints and annotations
{
  "example": "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078",
  "type": "string"
}
Name · required

Type: string

All schema constraints and annotations
{
  "example": "tiborvass/sample-volume-plugin",
  "type": "string",
  "x-nullable": false
}
PluginReference

Type: string

plugin remote reference used to push/pull the plugin
All schema constraints and annotations
{
  "description": "plugin remote reference used to push/pull the plugin",
  "example": "localhost:5000/tiborvass/sample-volume-plugin:latest",
  "type": "string",
  "x-go-name": "PluginReference",
  "x-nullable": false
}
Settings · required

Type: object

user-configurable settings for the plugin.
Args · required

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "items": {
    "type": "string"
  },
  "type": "array"
}
Devices · required

Type: array

Array item

Schema: PluginDevice

All schema constraints and annotations
{
  "$ref": "#/components/schemas/PluginDevice"
}
All schema constraints and annotations
{
  "items": {
    "$ref": "#/components/schemas/PluginDevice"
  },
  "type": "array"
}
Env · required

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "example": [
    "DEBUG=0"
  ],
  "items": {
    "type": "string"
  },
  "type": "array"
}
Mounts · required

Type: array

Array item

Schema: PluginMount

All schema constraints and annotations
{
  "$ref": "#/components/schemas/PluginMount"
}
All schema constraints and annotations
{
  "items": {
    "$ref": "#/components/schemas/PluginMount"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "description": "user-configurable settings for the plugin.",
  "properties": {
    "Args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Devices": {
      "items": {
        "$ref": "#/components/schemas/PluginDevice"
      },
      "type": "array"
    },
    "Env": {
      "example": [
        "DEBUG=0"
      ],
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "Mounts": {
      "items": {
        "$ref": "#/components/schemas/PluginMount"
      },
      "type": "array"
    }
  },
  "required": [
    "Args",
    "Devices",
    "Env",
    "Mounts"
  ],
  "type": "object",
  "x-go-name": "Settings",
  "x-nullable": false
}
All schema constraints and annotations
{
  "description": "A plugin for the Engine API",
  "properties": {
    "Config": {
      "description": "The config of a plugin.",
      "properties": {
        "Args": {
          "properties": {
            "Description": {
              "example": "command line arguments",
              "type": "string",
              "x-nullable": false
            },
            "Name": {
              "example": "args",
              "type": "string",
              "x-nullable": false
            },
            "Settable": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "Value": {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "Name",
            "Description",
            "Settable",
            "Value"
          ],
          "type": "object",
          "x-go-name": "Args",
          "x-nullable": false
        },
        "Description": {
          "example": "A sample volume plugin for Docker",
          "type": "string",
          "x-nullable": false
        },
        "Documentation": {
          "example": "https://docs.docker.com/engine/extend/plugins/",
          "type": "string",
          "x-nullable": false
        },
        "Entrypoint": {
          "example": [
            "/usr/bin/sample-volume-plugin",
            "/data"
          ],
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "Env": {
          "example": [
            {
              "Description": "If set, prints debug messages",
              "Name": "DEBUG",
              "Settable": null,
              "Value": "0"
            }
          ],
          "items": {
            "$ref": "#/components/schemas/PluginEnv"
          },
          "type": "array"
        },
        "Interface": {
          "description": "The interface between Docker and the plugin",
          "properties": {
            "ProtocolScheme": {
              "description": "Protocol to use for clients connecting to the plugin.",
              "enum": [
                "",
                "moby.plugins.http/v1"
              ],
              "example": "some.protocol/v1.0",
              "type": "string"
            },
            "Socket": {
              "example": "plugins.sock",
              "type": "string",
              "x-nullable": false
            },
            "Types": {
              "example": [
                "docker.volumedriver/1.0"
              ],
              "items": {
                "type": "string",
                "x-go-type": {
                  "type": "CapabilityID"
                }
              },
              "type": "array"
            }
          },
          "required": [
            "Types",
            "Socket"
          ],
          "type": "object",
          "x-go-name": "Interface",
          "x-nullable": false
        },
        "IpcHost": {
          "example": false,
          "type": "boolean",
          "x-nullable": false
        },
        "Linux": {
          "properties": {
            "AllowAllDevices": {
              "example": false,
              "type": "boolean",
              "x-nullable": false
            },
            "Capabilities": {
              "example": [
                "CAP_SYS_ADMIN",
                "CAP_SYSLOG"
              ],
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "Devices": {
              "items": {
                "$ref": "#/components/schemas/PluginDevice"
              },
              "type": "array"
            }
          },
          "required": [
            "Capabilities",
            "AllowAllDevices",
            "Devices"
          ],
          "type": "object",
          "x-go-name": "LinuxConfig",
          "x-nullable": false
        },
        "Mounts": {
          "items": {
            "$ref": "#/components/schemas/PluginMount"
          },
          "type": "array"
        },
        "Network": {
          "properties": {
            "Type": {
              "example": "host",
              "type": "string",
              "x-nullable": false
            }
          },
          "required": [
            "Type"
          ],
          "type": "object",
          "x-go-name": "NetworkConfig",
          "x-nullable": false
        },
        "PidHost": {
          "example": false,
          "type": "boolean",
          "x-nullable": false
        },
        "PropagatedMount": {
          "example": "/mnt/volumes",
          "type": "string",
          "x-nullable": false
        },
        "User": {
          "properties": {
            "GID": {
              "example": 1000,
              "format": "uint32",
              "type": "integer"
            },
            "UID": {
              "example": 1000,
              "format": "uint32",
              "type": "integer"
            }
          },
          "type": "object",
          "x-go-name": "User",
          "x-nullable": false
        },
        "WorkDir": {
          "example": "/bin/",
          "type": "string",
          "x-nullable": false
        },
        "rootfs": {
          "properties": {
            "diff_ids": {
              "example": [
                "sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887",
                "sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"
              ],
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "type": {
              "example": "layers",
              "type": "string"
            }
          },
          "type": "object",
          "x-go-name": "RootFS"
        }
      },
      "required": [
        "Description",
        "Documentation",
        "Interface",
        "Entrypoint",
        "WorkDir",
        "Network",
        "Linux",
        "PidHost",
        "PropagatedMount",
        "IpcHost",
        "Mounts",
        "Env",
        "Args"
      ],
      "type": "object",
      "x-go-name": "Config",
      "x-nullable": false
    },
    "Enabled": {
      "description": "True if the plugin is running. False if the plugin is not running, only installed.",
      "example": true,
      "type": "boolean",
      "x-nullable": false
    },
    "Id": {
      "example": "5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078",
      "type": "string"
    },
    "Name": {
      "example": "tiborvass/sample-volume-plugin",
      "type": "string",
      "x-nullable": false
    },
    "PluginReference": {
      "description": "plugin remote reference used to push/pull the plugin",
      "example": "localhost:5000/tiborvass/sample-volume-plugin:latest",
      "type": "string",
      "x-go-name": "PluginReference",
      "x-nullable": false
    },
    "Settings": {
      "description": "user-configurable settings for the plugin.",
      "properties": {
        "Args": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "Devices": {
          "items": {
            "$ref": "#/components/schemas/PluginDevice"
          },
          "type": "array"
        },
        "Env": {
          "example": [
            "DEBUG=0"
          ],
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "Mounts": {
          "items": {
            "$ref": "#/components/schemas/PluginMount"
          },
          "type": "array"
        }
      },
      "required": [
        "Args",
        "Devices",
        "Env",
        "Mounts"
      ],
      "type": "object",
      "x-go-name": "Settings",
      "x-nullable": false
    }
  },
  "required": [
    "Settings",
    "Enabled",
    "Config",
    "Name"
  ],
  "type": "object",
  "x-go-name": "Plugin"
}