vagrant

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 = "vagrant"

	// EnvNamespaceTags is the env to set for namespace tags. It's k=v,...
	EnvNamespaceTags = "INFRAKIT_VAGRANT_NAMESPACE_TAGS"

	// EnvDir is the env for setting the vagrant directory
	EnvDir = "INFRAKIT_VAGRANT_DIR"

	// EnvTemplateURL is the env for setting the vagrant file template url
	EnvTemplateURL = "INFRAKIT_VAGRANT_TEMPLATE_URL"
)

Variables

var DefaultOptions = Options{
	Namespace:   defaultNamespace(),
	Dir:         local.Getenv(EnvDir, ""),
	TemplateURL: local.Getenv(EnvTemplateURL, ""),
}

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 {
	// Namespace is a set of kv pairs for tags that namespaces the resource instances
	// TODO - this is currently implemented in AWS and other cloud providers but not
	// in vagrant
	Namespace map[string]string

	// Dir is the directory where vagrant files are kept
	Dir string

	// TemplateURL is the URL for the vagrant template
	TemplateURL string
}

Options capture the options for starting up the plugin.