discovery

Documentation

Index

• Constants
• func Dir() string
• func IsErrNotUnixSocket(e error) bool
• type Plugins
  • func NewPluginDiscovery() (Plugins, error)
  • func NewPluginDiscoveryWithDirectory(pluginDir string) (Plugins, error)

Constants

const (
	// PluginDirEnvVar is the environment variable that may be used to customize the plugin discovery path.
	PluginDirEnvVar = "INFRAKIT_PLUGINS_DIR"
)

Functions

func Dir

func Dir() string

Dir returns the directory to use for plugin discovery, which may be customized by the environment.

func IsErrNotUnixSocket

func IsErrNotUnixSocket(e error) bool

IsErrNotUnixSocket returns true if the error is due to the file not being a valid unix socket.

Types

type Plugins

type Plugins interface {
	// Find looks up the plugin by name.  The name can be of the form $lookup[/$subtype].  See GetLookupAndType().
	Find(name plugin.Name) (*plugin.Endpoint, error)
	List() (map[string]*plugin.Endpoint, error)
}

Plugins provides access to plugin discovery.

func NewPluginDiscovery

func NewPluginDiscovery() (Plugins, error)

NewPluginDiscovery creates a plugin discovery based on the environment configuration.

func NewPluginDiscoveryWithDirectory

func NewPluginDiscoveryWithDirectory(pluginDir string) (Plugins, error)

NewPluginDiscoveryWithDirectory creates a plugin discovery based on the directory given.