maas

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

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

	// EnvDir is the MAAS directory
	EnvDir = "INFRAKIT_MAAS_DIR"

	// EnvAPIKey is the env to set the API key
	EnvAPIKey = "INFRAKIT_MAAS_API_KEY"

	// EnvURL is the env to set the connection url
	EnvURL = "INFRAKIT_MAAS_URL"

	// EnvAPIVersion is the env to set the API version
	EnvAPIVersion = "INFRAKIT_MAAS_API_VERSION"
)

Variables

var DefaultOptions = Options{
	Namespace:  defaultNamespace(),
	APIKey:     local.Getenv(EnvAPIKey, "aaaa:bbbb:ccccc"),
	APIVersion: local.Getenv(EnvAPIVersion, "2.0"),
	Dir:        local.Getenv(EnvDir, defaultDir()),
	URL:        local.Getenv(EnvURL, "127.0.0.1:80"),
}

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 support this
	Namespace map[string]string

	// Dir is the MAAS directory
	Dir string

	// APIKey is the API token
	APIKey string

	// APIVersion is the version of the MAAS API
	APIVersion string

	// URL to connect to MAAS
	URL string
}

Options capture the options for starting up the plugin.