v2

Documentation

Index

• type ErrInadequateCapability
  • func (e ErrInadequateCapability) Error() string
• type Plugin
  • func NewPlugin(name, id, runRoot, libRoot, tag string) *Plugin
  • func (p *Plugin) Acquire()
  • func (p *Plugin) AddRefCount(count int)
  • func (p *Plugin) BasePath() string
  • func (p *Plugin) Client() *plugins.Client
  • func (p *Plugin) FilterByCap(capability string) (*Plugin, error)
  • func (p *Plugin) GetID() string
  • func (p *Plugin) GetRefCount() int
  • func (p *Plugin) GetRuntimeSourcePath() string
  • func (p *Plugin) GetSocket() string
  • func (p *Plugin) GetTypes() []types.PluginInterfaceType
  • func (p *Plugin) InitPlugin() error
  • func (p *Plugin) InitSpec(s specs.Spec) (*specs.Spec, error)
  • func (p *Plugin) IsEnabled() bool
  • func (p *Plugin) IsV1() bool
  • func (p *Plugin) Name() string
  • func (p *Plugin) Release()
  • func (p *Plugin) RemoveFromDisk() error
  • func (p *Plugin) Restore(runRoot string)
  • func (p *Plugin) Set(args []string) error
  • func (p *Plugin) SetPClient(client *plugins.Client)

Types

type ErrInadequateCapability

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

ErrInadequateCapability indicates that the plugin did not have the requested capability.

func (ErrInadequateCapability) Error

func (e ErrInadequateCapability) Error() string

type Plugin

type Plugin struct {
	PluginObj types.Plugin `json:"plugin"`

	LibRoot         string // TODO: make private
	PropagatedMount string // TODO: make private
	Rootfs          string // TODO: make private
	// contains filtered or unexported fields
}

Plugin represents an individual plugin.

func NewPlugin

func NewPlugin(name, id, runRoot, libRoot, tag string) *Plugin

NewPlugin creates a plugin.

func (*Plugin) Acquire

func (p *Plugin) Acquire()

Acquire increments the plugin's reference count This should be followed up by `Release()` when the plugin is no longer in use.

func (*Plugin) AddRefCount

func (p *Plugin) AddRefCount(count int)

AddRefCount adds to reference count.

func (*Plugin) BasePath

func (p *Plugin) BasePath() string

BasePath returns the path to which all paths returned by the plugin are relative to. For Plugin objects this returns the host path of the plugin container's rootfs.

func (*Plugin) Client

func (p *Plugin) Client() *plugins.Client

Client returns the plugin client.

func (*Plugin) FilterByCap

func (p *Plugin) FilterByCap(capability string) (*Plugin, error)

FilterByCap query the plugin for a given capability.

func (*Plugin) GetID

func (p *Plugin) GetID() string

GetID returns the plugin's ID.

func (*Plugin) GetRefCount

func (p *Plugin) GetRefCount() int

GetRefCount returns the reference count.

func (*Plugin) GetRuntimeSourcePath

func (p *Plugin) GetRuntimeSourcePath() string

GetRuntimeSourcePath gets the Source (host) path of the plugin socket This path gets bind mounted into the plugin.

func (*Plugin) GetSocket

func (p *Plugin) GetSocket() string

GetSocket returns the plugin socket.

func (*Plugin) GetTypes

func (p *Plugin) GetTypes() []types.PluginInterfaceType

GetTypes returns the interface types of a plugin.

func (*Plugin) InitPlugin

func (p *Plugin) InitPlugin() error

InitPlugin populates the plugin object from the plugin config file.

func (*Plugin) InitSpec

func (p *Plugin) InitSpec(s specs.Spec) (*specs.Spec, error)

InitSpec creates an OCI spec from the plugin's config.

func (*Plugin) IsEnabled

func (p *Plugin) IsEnabled() bool

IsEnabled returns the active state of the plugin.

func (*Plugin) IsV1

func (p *Plugin) IsV1() bool

IsV1 returns true for V1 plugins and false otherwise.

func (*Plugin) Name

func (p *Plugin) Name() string

Name returns the plugin name.

func (*Plugin) Release

func (p *Plugin) Release()

Release decrements the plugin's reference count This should only be called when the plugin is no longer in use, e.g. with via `Acquire()` or getter.Get("name", "type", plugingetter.ACQUIRE)

func (*Plugin) RemoveFromDisk

func (p *Plugin) RemoveFromDisk() error

RemoveFromDisk deletes the plugin's runtime files from disk.

func (*Plugin) Restore

func (p *Plugin) Restore(runRoot string)

Restore restores the plugin

func (*Plugin) Set

func (p *Plugin) Set(args []string) error

Set is used to pass arguments to the plugin.

func (*Plugin) SetPClient

func (p *Plugin) SetPClient(client *plugins.Client)

SetPClient set the plugin client.