packet

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

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

	// EnvProject is the env to set the project
	EnvProject = "INFRAKIT_PACKET_PROJECT"

	// EnvAPIToken is the env to set the API token
	EnvAPIToken = "INFRAKIT_PACKET_API_TOKEN"
)

Variables

var DefaultOptions = Options{
	Namespace: defaultNamespace(),
	Project:   local.Getenv(EnvProject, ""),
	APIToken:  local.Getenv(EnvAPIToken, ""),
}

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

	// Project is the Packet project
	Project string

	// APIToken is the API token
	APIToken string
}

Options capture the options for starting up the plugin.