plugin
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeArgs¶
type Args struct {// description// Example: command line arguments// Required: trueDescriptionstring `json:"Description"`// name// Example: args// Required: trueNamestring `json:"Name"`// settable// Required: trueSettable []string `json:"Settable"`// value// Required: trueValue []string `json:"Value"`}Args args
swagger:model Args
typeCapabilityID¶
func (CapabilityID)MarshalText¶
func (tCapabilityID) MarshalText() ([]byte,error)
MarshalText implementsencoding.TextMarshaler for CapabilityID
func (CapabilityID)String¶
func (tCapabilityID) String()string
String implementsfmt.Stringer for CapabilityID
func (*CapabilityID)UnmarshalText¶
func (t *CapabilityID) UnmarshalText(p []byte)error
UnmarshalText implementsencoding.TextUnmarshaler for CapabilityID
typeConfig¶
type Config struct {// args// Required: trueArgsArgs `json:"Args"`// description// Example: A sample volume plugin for Docker// Required: trueDescriptionstring `json:"Description"`// documentation// Example:https://docs.docker.com/engine/extend/plugins/// Required: trueDocumentationstring `json:"Documentation"`// entrypoint// Example: ["/usr/bin/sample-volume-plugin","/data"]// Required: trueEntrypoint []string `json:"Entrypoint"`// env// Example: [{"Description":"If set, prints debug messages","Name":"DEBUG","Settable":null,"Value":"0"}]// Required: trueEnv []Env `json:"Env"`// interface// Required: trueInterfaceInterface `json:"Interface"`// ipc host// Example: false// Required: trueIpcHostbool `json:"IpcHost"`// linux// Required: trueLinuxLinuxConfig `json:"Linux"`// mounts// Required: trueMounts []Mount `json:"Mounts"`// network// Required: trueNetworkNetworkConfig `json:"Network"`// pid host// Example: false// Required: truePidHostbool `json:"PidHost"`// propagated mount// Example: /mnt/volumes// Required: truePropagatedMountstring `json:"PropagatedMount"`// userUserUser `json:"User,omitempty"`// work dir// Example: /bin/// Required: trueWorkDirstring `json:"WorkDir"`// rootfsRootfs *RootFS `json:"rootfs,omitempty"`}Config The config of a plugin.
swagger:model Config
typeDevice¶
type Device struct {// description// Required: trueDescriptionstring `json:"Description"`// name// Required: trueNamestring `json:"Name"`// path// Example: /dev/fuse// Required: truePath *string `json:"Path"`// settable// Required: trueSettable []string `json:"Settable"`}Device device
swagger:model Device
typeEnv¶
type Env struct {// description// Required: trueDescriptionstring `json:"Description"`// name// Required: trueNamestring `json:"Name"`// settable// Required: trueSettable []string `json:"Settable"`// value// Required: trueValue *string `json:"Value"`}Env env
swagger:model Env
typeInterface¶
type Interface struct {// Protocol to use for clients connecting to the plugin.// Example: some.protocol/v1.0// Enum: ["","moby.plugins.http/v1"]ProtocolSchemestring `json:"ProtocolScheme,omitempty"`// socket// Example: plugins.sock// Required: trueSocketstring `json:"Socket"`// types// Example: ["docker.volumedriver/1.0"]// Required: trueTypes []CapabilityID `json:"Types"`}Interface The interface between Docker and the plugin
swagger:model Interface
typeLinuxConfig¶
type LinuxConfig struct {// allow all devices// Example: false// Required: trueAllowAllDevicesbool `json:"AllowAllDevices"`// capabilities// Example: ["CAP_SYS_ADMIN","CAP_SYSLOG"]// Required: trueCapabilities []string `json:"Capabilities"`// devices// Required: trueDevices []Device `json:"Devices"`}LinuxConfig linux config
swagger:model LinuxConfig
typeMount¶
type Mount struct {// description// Example: This is a mount that's used by the plugin.// Required: trueDescriptionstring `json:"Description"`// destination// Example: /mnt/state// Required: trueDestinationstring `json:"Destination"`// name// Example: some-mount// Required: trueNamestring `json:"Name"`// options// Example: ["rbind","rw"]// Required: trueOptions []string `json:"Options"`// settable// Required: trueSettable []string `json:"Settable"`// source// Example: /var/lib/docker/plugins/// Required: trueSource *string `json:"Source"`// type// Example: bind// Required: trueTypestring `json:"Type"`}Mount mount
swagger:model Mount
typeNetworkConfig¶
type NetworkConfig struct {// type// Example: host// Required: trueTypestring `json:"Type"`}NetworkConfig network config
swagger:model NetworkConfig
typePlugin¶
type Plugin struct {// config// Required: trueConfigConfig `json:"Config"`// True if the plugin is running. False if the plugin is not running, only installed.// Example: true// Required: trueEnabledbool `json:"Enabled"`// Id// Example: 5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078IDstring `json:"Id,omitempty"`// name// Example: tiborvass/sample-volume-plugin// Required: trueNamestring `json:"Name"`// plugin remote reference used to push/pull the plugin// Example: localhost:5000/tiborvass/sample-volume-plugin:latestPluginReferencestring `json:"PluginReference,omitempty"`// settings// Required: trueSettingsSettings `json:"Settings"`}Plugin A plugin for the Engine API
swagger:model Plugin
typePrivileges¶
type Privileges []Privilege
Privileges is a list of Privilege
func (Privileges)Len¶
func (sPrivileges) Len()int
func (Privileges)Less¶
func (sPrivileges) Less(i, jint)bool
func (Privileges)Swap¶
func (sPrivileges) Swap(i, jint)
typeRootFS¶
type RootFS struct {// diff ids// Example: ["sha256:675532206fbf3030b8458f88d6e26d4eb1577688a25efec97154c94e8b6b4887","sha256:e216a057b1cb1efc11f8a268f37ef62083e70b1b38323ba252e25ac88904a7e8"]DiffIds []string `json:"diff_ids"`// type// Example: layersTypestring `json:"type,omitempty"`}RootFS root f s
swagger:model RootFS
typeSettings¶
type Settings struct {// args// Required: trueArgs []string `json:"Args"`// devices// Required: trueDevices []Device `json:"Devices"`// env// Example: ["DEBUG=0"]// Required: trueEnv []string `json:"Env"`// mounts// Required: trueMounts []Mount `json:"Mounts"`}Settings user-configurable settings for the plugin.
swagger:model Settings