external_host_plugins

Documentation

Index

• Variables
• func CreateHostPlugin(ctx context.Context, pluginType string, opt ...Option) (hp pb.HostPluginServiceClient, cleanup func() error, retErr error)
• func NewHostPluginClient(pluginPath string, opt ...Option) (*plugin.Client, error)
• func NewHostPluginServiceServer(impl pb.HostPluginServiceServer) (*hostPlugin, error)
• func ServeHostPlugin(svc pb.HostPluginServiceServer, opt ...Option) error
• type Option
  • func WithLogger(logger hclog.Logger) Option
  • func WithPluginOptions(opts ...pluginutil.Option) Option

Variables

var HandshakeConfig = plugin.HandshakeConfig{
	MagicCookieKey:   "HASHICORP_BOUNDARY_HOST_PLUGIN",
	MagicCookieValue: hostServicePluginSetName,
}

HandshakeConfig is a shared config that can be used regardless of plugin, to avoid having to know type-specific things about each plugin

Functions

func CreateHostPlugin

func CreateHostPlugin(
	ctx context.Context,
	pluginType string,
	opt ...Option,
) (
	hp pb.HostPluginServiceClient,
	cleanup func() error,
	retErr error,
)

CreateHostPlugin takes in a type, parses the various options to look for a plugin matching that name, and returns a host plugin client, a cleanup function to execute on shutdown of the enclosing program, and an error.

func NewHostPluginClient

func NewHostPluginClient(pluginPath string, opt ...Option) (*plugin.Client, error)

func NewHostPluginServiceServer

func NewHostPluginServiceServer(impl pb.HostPluginServiceServer) (*hostPlugin, error)

func ServeHostPlugin

func ServeHostPlugin(svc pb.HostPluginServiceServer, opt ...Option) error

ServeHostPlugin is a generic function to start serving a host plugin service as a plugin

Types

type Option

type Option func(*options) error

Option - a type that wraps an interface for compile-time safety but can contain an option for this package or for wrappers implementing this interface.

func WithLogger

func WithLogger(logger hclog.Logger) Option

WithLogger allows passing a logger to the plugin library for debugging

func WithPluginOptions

func WithPluginOptions(opts ...pluginutil.Option) Option

WithPluginOptions allows providing plugin-related (as opposed to configutil-related) options