Documentation ¶
Index ¶
- type Config
- type ConfigArgs
- type ConfigInterface
- type ConfigLinux
- type ConfigNetwork
- type ConfigRootfs
- type ConfigUser
- type DisableOptions
- type EnableOptions
- type InstallOptions
- type InterfaceType
- type ListResponse
- type Mount
- type Plugin
- type Privilege
- type Privileges
- type RemoveOptions
- type Settings
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // args // Required: true Args ConfigArgs `json:"Args"` // description // Required: true Description string `json:"Description"` // Docker Version used to create the plugin DockerVersion string `json:"DockerVersion,omitempty"` // documentation // Required: true Documentation string `json:"Documentation"` // entrypoint // Required: true Entrypoint []string `json:"Entrypoint"` // interface // Required: true Interface ConfigInterface `json:"Interface"` // ipc host // Required: true IpcHost bool `json:"IpcHost"` // linux // Required: true Linux ConfigLinux `json:"Linux"` // mounts // Required: true Mounts []Mount `json:"Mounts"` // network // Required: true Network ConfigNetwork `json:"Network"` // pid host // Required: true PidHost bool `json:"PidHost"` // propagated mount // Required: true PropagatedMount string `json:"PropagatedMount"` // user User ConfigUser `json:"User,omitempty"` // work dir // Required: true WorkDir string `json:"WorkDir"` // rootfs Rootfs *ConfigRootfs `json:"rootfs,omitempty"` }
Config The config of a plugin. swagger:model Config
type ConfigArgs ¶
type ConfigArgs struct { // description // Required: true Description string `json:"Description"` // name // Required: true Name string `json:"Name"` // settable // Required: true Settable []string `json:"Settable"` // value // Required: true Value []string `json:"Value"` }
ConfigArgs plugin config args swagger:model ConfigArgs
type ConfigInterface ¶
type ConfigInterface struct { // Protocol to use for clients connecting to the plugin. ProtocolScheme string `json:"ProtocolScheme,omitempty"` // socket // Required: true Socket string `json:"Socket"` }
ConfigInterface The interface between Docker and the plugin swagger:model ConfigInterface
type ConfigLinux ¶
type ConfigLinux struct { // allow all devices // Required: true AllowAllDevices bool `json:"AllowAllDevices"` // capabilities // Required: true Capabilities []string `json:"Capabilities"` }
ConfigLinux plugin config linux swagger:model ConfigLinux
type ConfigNetwork ¶
type ConfigNetwork struct { // type // Required: true Type string `json:"Type"` }
ConfigNetwork plugin config network swagger:model ConfigNetwork
type ConfigRootfs ¶
type ConfigRootfs struct { // diff ids DiffIds []string `json:"diff_ids"` // type Type string `json:"type,omitempty"` }
ConfigRootfs plugin config rootfs swagger:model ConfigRootfs
type ConfigUser ¶
type ConfigUser struct { // g ID GID uint32 `json:"GID,omitempty"` // UID UID uint32 `json:"UID,omitempty"` }
ConfigUser plugin config user swagger:model ConfigUser
type DisableOptions ¶
type DisableOptions struct {
Force bool
}
DisableOptions holds parameters to disable plugins.
type EnableOptions ¶
type EnableOptions struct {
Timeout int
}
EnableOptions holds parameters to enable plugins.
type InstallOptions ¶
type InstallOptions struct { Disabled bool AcceptAllPermissions bool RegistryAuth string // RegistryAuth is the base64 encoded credentials for the registry RemoteRef string // RemoteRef is the plugin name on the registry // PrivilegeFunc RequestPrivilegeFunc AcceptPermissionsFunc func(Privileges) (bool, error) Args []string }
InstallOptions holds parameters to install a plugin.
type InterfaceType ¶
type InterfaceType struct { // capability // Required: true Capability string `json:"Capability"` // prefix // Required: true Prefix string `json:"Prefix"` // version // Required: true Version string `json:"Version"` }
InterfaceType plugin interface type swagger:model InterfaceType
func (*InterfaceType) MarshalJSON ¶
func (t *InterfaceType) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaler for InterfaceType
func (InterfaceType) String ¶
func (t InterfaceType) String() string
String implements fmt.Stringer for InterfaceType
func (*InterfaceType) UnmarshalJSON ¶
func (t *InterfaceType) UnmarshalJSON(p []byte) error
UnmarshalJSON implements json.Unmarshaler for InterfaceType
type ListResponse ¶
type ListResponse []*Plugin
ListResponse contains the response for the Engine API
type Mount ¶
type Mount struct { // description // Required: true Description string `json:"Description"` // destination // Required: true Destination string `json:"Destination"` // name // Required: true Name string `json:"Name"` // options // Required: true Options []string `json:"Options"` // settable // Required: true Settable []string `json:"Settable"` // source // Required: true Source *string `json:"Source"` // type // Required: true Type string `json:"Type"` }
Mount plugin mount swagger:model Mount
type Plugin ¶
type Plugin struct { // config // Required: true Config Config `json:"Config"` // True if the plugin is running. False if the plugin is not running, only installed. // Required: true Enabled bool `json:"Enabled"` // Id ID string `json:"Id,omitempty"` // name // Required: true Name string `json:"Name"` // plugin remote reference used to push/pull the plugin Reference string `json:"Reference,omitempty"` // settings // Required: true Settings Settings `json:"Settings"` }
Plugin A plugin for the Engine API swagger:model
type Privileges ¶
type Privileges []Privilege
Privileges is a list of Privilege
func (Privileges) Len ¶
func (s Privileges) Len() int
func (Privileges) Less ¶
func (s Privileges) Less(i, j int) bool
func (Privileges) Swap ¶
func (s Privileges) Swap(i, j int)
type RemoveOptions ¶
type RemoveOptions struct {
Force bool
}
RemoveOptions holds parameters to remove plugins.