type CreateOpt func(p *v2.Plugin)

funcWithEnv¶

func WithEnv(env []string)CreateOpt

WithEnv is a CreateOpt that passes the user-provided environment variablesto the plugin container, de-duplicating variables with the same names casesensitively and only appends valid key=value pairs

funcWithSwarmService¶

func WithSwarmService(idstring)CreateOpt

WithSwarmService is a CreateOpt that flags the passed in a plugin as a pluginmanaged by swarm

type EndpointResolver interface {LookupPullEndpoints(hostnamestring) (endpoints []registry.APIEndpoint, errerror)}

type Event interface {// contains filtered or unexported methods}

type EventCreate struct {Interfaces map[string]boolPluginplugin.Plugin}

type EventDisable struct {Pluginplugin.Plugin}

type EventEnable struct {Pluginplugin.Plugin}

type EventRemove struct {Pluginplugin.Plugin}

type Executor interface {Create(idstring, spec specs.Spec, stdout, stderrio.WriteCloser)errorIsRunning(idstring) (bool,error)Restore(idstring, stdout, stderrio.WriteCloser) (alivebool, errerror)Signal(idstring, signalsyscall.Signal)error}

type ExecutorCreator func(*Manager) (Executor,error)

type Manager struct {// contains filtered or unexported fields}

funcNewManager¶

func NewManager(configManagerConfig) (*Manager,error)

NewManager returns a new plugin manager.

func (*Manager)CreateFromContext¶

func (pm *Manager) CreateFromContext(ctxcontext.Context, tarCtxio.ReadCloser, options *backend.PluginCreateConfig) (retErrerror)

CreateFromContext creates a plugin from the given pluginDir which containsboth the rootfs and the config.json and a repoName with optional tag.

func (*Manager)Disable¶

func (pm *Manager) Disable(refOrIDstring, config *backend.PluginDisableConfig)error

Disable deactivates a plugin. This means resources (volumes, networks) cant use them.

func (*Manager)Enable¶

func (pm *Manager) Enable(refOrIDstring, config *backend.PluginEnableConfig)error

Enable activates a plugin, which implies that they are ready to be used by containers.

func (*Manager)GC¶

func (pm *Manager) GC()

GC cleans up unreferenced blobs. This is recommended to run in a goroutine

func (*Manager)Get¶

func (pm *Manager) Get(idOrNamestring) (*v2.Plugin,error)

Get looks up the requested plugin in the store.

func (*Manager)HandleExitEvent¶

func (pm *Manager) HandleExitEvent(idstring)error

HandleExitEvent is called when the executor receives the exit eventIn the future we may change this, but for now all we care about is the exit event.

func (*Manager)Inspect¶

func (pm *Manager) Inspect(refOrIDstring) (*plugin.Plugin,error)

Inspect examines a plugin config

func (*Manager)List¶

func (pm *Manager) List(pluginFiltersfilters.Args) ([]plugin.Plugin,error)

List displays the list of plugins and associated metadata.

func (*Manager)Privileges¶

func (pm *Manager) Privileges(ctxcontext.Context, refreference.Named, metaHeaderhttp.Header, authConfig *registry.AuthConfig) (plugin.Privileges,error)

Privileges pulls a plugin config and computes the privileges required to install it.

func (*Manager)Pull¶

func (pm *Manager) Pull(ctxcontext.Context, refreference.Named, namestring, metaHeaderhttp.Header, authConfig *registry.AuthConfig, privilegesplugin.Privileges, outStreamio.Writer, opts ...CreateOpt)error

Pull pulls a plugin, check if the correct privileges are provided and install the plugin.

TODO: replace reference package usage with simpler url.Parse semantics

func (*Manager)Push¶

func (pm *Manager) Push(ctxcontext.Context, namestring, metaHeaderhttp.Header, authConfig *registry.AuthConfig, outStreamio.Writer)error

Push pushes a plugin to the registry.

func (*Manager)Remove¶

func (pm *Manager) Remove(namestring, config *backend.PluginRmConfig)error

Remove deletes plugin's root directory.

func (*Manager)Set¶

func (pm *Manager) Set(namestring, args []string)error

Set sets plugin args

func (*Manager)Shutdown¶

func (pm *Manager) Shutdown()

Shutdown stops all plugins and called during daemon shutdown.

func (*Manager)SubscribeEvents¶

func (pm *Manager) SubscribeEvents(bufferint, watchEvents ...Event) (eventCh <-chanany, cancel func())

SubscribeEvents provides an event channel to listen for structured events fromthe plugin manager actions, CRUD operations.The caller must call the returned `cancel()` function once done with the channelor this will leak resources.

func (*Manager)Upgrade¶

func (pm *Manager) Upgrade(ctxcontext.Context, refreference.Named, namestring, metaHeaderhttp.Header, authConfig *registry.AuthConfig, privilegesplugin.Privileges, outStreamio.Writer)error

Upgrade upgrades a plugin

TODO: replace reference package usage with simpler url.Parse semantics

type ManagerConfig struct {Store              *Store// removeRegistryServiceEndpointResolverLiveRestoreEnabledbool// TODO: removeLogPluginEvent     eventLoggerRootstringExecRootstringCreateExecutorExecutorCreatorAuthzMiddleware    *authorization.Middleware}

type SpecOpt func(*specs.Spec)

funcWithSpecMounts¶

func WithSpecMounts(mounts []specs.Mount)SpecOpt

WithSpecMounts is a SpecOpt which appends the provided mounts to the runtime spec

type Store struct {sync.RWMutex// contains filtered or unexported fields}

funcNewStore¶

func NewStore() *Store

NewStore creates a Store.

func (*Store)Add¶

func (ps *Store) Add(p *v2.Plugin)error

Add adds a plugin to memory and plugindb.An error will be returned if there is a collision.

func (*Store)CallHandler¶

func (ps *Store) CallHandler(p *v2.Plugin)

CallHandler calls the registered callback. It is invoked during plugin enable.

func (*Store)Get¶

func (ps *Store) Get(name, capabilitystring, modeint) (plugingetter.CompatPlugin,error)

Get returns an enabled plugin matching the given name and capability.

func (*Store)GetAll¶

func (ps *Store) GetAll() map[string]*v2.Plugin

GetAll retrieves all plugins.

func (*Store)GetAllByCap¶

func (ps *Store) GetAllByCap(capabilitystring) ([]plugingetter.CompatPlugin,error)

GetAllByCap returns a list of enabled plugins matching the given capability.

func (*Store)GetAllManagedPluginsByCap¶

func (ps *Store) GetAllManagedPluginsByCap(capabilitystring) []plugingetter.CompatPlugin

GetAllManagedPluginsByCap returns a list of managed plugins matching the given capability.

func (*Store)GetV2Plugin¶

func (ps *Store) GetV2Plugin(refOrIDstring) (*v2.Plugin,error)

GetV2Plugin retrieves a plugin by name, id or partial ID.

func (*Store)Handle¶

func (ps *Store) Handle(capabilitystring, callback func(string, *plugins.Client))

Handle sets a callback for a given capability. It is only used by networkand ipam drivers during plugin registration. The callback registers thedriver with the subsystem (network, ipam).

func (*Store)RegisterRuntimeOpt¶

func (ps *Store) RegisterRuntimeOpt(capabilitystring, opts ...SpecOpt)

RegisterRuntimeOpt stores a list of SpecOpts for the provided capability.These options are applied to the runtime spec before a plugin is started for the specified capability.

func (*Store)Remove¶

func (ps *Store) Remove(p *v2.Plugin)

Remove removes a plugin from memory and plugindb.

func (*Store)SetAll¶

func (ps *Store) SetAll(plugins map[string]*v2.Plugin)

SetAll initialized plugins during daemon restore.

func (*Store)SetState¶

func (ps *Store) SetState(p *v2.Plugin, statebool)

SetState sets the active state of the plugin and updates plugindb.