vars

Documentation

Index

• Constants
• Variables
• func Run(plugins func() discovery.Plugins, name plugin.Name, config *types.Any) (transport plugin.Transport, impls map[run.PluginCode]interface{}, ...)
• type Options

Constants

const (
	// Kind is the canonical name of the plugin for starting up, etc.
	Kind = "vars"

	// EnvTemplate is the env for the template to evaluate
	EnvTemplate = "INFRAKIT_VARS_TEMPLATE"
)

Variables

var DefaultOptions = Options{
	InitialTemplate: ptr(local.Getenv(EnvTemplate, "")),
}

DefaultOptions return an Options with default values filled in.

Functions

func Run

func Run(plugins func() discovery.Plugins, name plugin.Name,
	config *types.Any) (transport plugin.Transport, impls map[run.PluginCode]interface{}, onStop func(), err error)

Run runs the plugin, blocking the current thread. Error is returned immediately if the plugin cannot be started.

Types

type Options

type Options struct {

	// InitialTemplate is the url or literal (with str://) of the template to evaluate to initialize the values.
	// The template must evaluate to a map.  Slice is not supported
	InitialTemplate *string
}

Options capture the options for starting up the plugin.