plugin

Documentation

Index

• Constants
• Variables
• type Builtin
  • func Builtins() []*Builtin
• type Downloaders
• type Hooks
  • func (hooks Hooks) Get(event string) string
• type Metadata
• type Plugin
  • func FindPlugins(plugdirs string) ([]*Plugin, error)
  • func LoadAll(basedir string) ([]*Plugin, error)
  • func LoadDir(dirname string) (*Plugin, error)
  • func (p *Plugin) PrepareCommand(extraArgs []string) (string, []string)

Constants

const (
	// Install is executed after the plugin is added.
	Install = "install"
	// Delete is executed after the plugin is removed.
	Delete = "delete"
	// Update is executed after the plugin is updated.
	Update = "update"
)

Types of hooks

Variables

var (
	// ErrMissingMetadata indicates that plugin.yaml is missing.
	ErrMissingMetadata = errors.New("plugin metadata (plugin.yaml) missing")
	// ErrExists indicates that a plugin already exists
	ErrExists = errors.New("plugin already exists")
	// ErrDoesNotExist indicates that a plugin does not exist
	ErrDoesNotExist = errors.New("plugin does not exist")
	// ErrHomeMissing indicates that the directory expected to contain plugins does not exist
	ErrHomeMissing = errors.New(`plugin home "$(draft home)/plugins" does not exist`)
	// ErrMissingSource indicates that information about the source of the plugin was not found
	ErrMissingSource = errors.New("cannot get information about plugin source")
	// ErrRepoDirty indicates that the plugin repo was modified
	ErrRepoDirty = errors.New("plugin repo was modified")
	// ErrVersionDoesNotExist indicates that the request version does not exist
	ErrVersionDoesNotExist = errors.New("requested version does not exist")
)

Types

type Builtin

type Builtin struct {
	Name    string
	URL     string
	Version string
}

Builtin contains metadata to the built-in plugins. Used to install/uninstall a plugin.

func Builtins

func Builtins() []*Builtin

Builtins fetches all built-in plugins.

type Downloaders

type Downloaders struct {
	// Protocols are the list of schemes from the charts URL.
	Protocols []string `json:"protocols"`
	// Command is the executable path with which the plugin performs
	// the actual download for the corresponding Protocols
	Command string `json:"command"`
}

Downloaders represents the plugins capability if it can retrieve charts from special sources

type Hooks

type Hooks map[string]string

Hooks is a map of events to commands.

func (Hooks) Get

func (hooks Hooks) Get(event string) string

Get returns a hook for an event.

type Metadata

type Metadata struct {
	// Name is the name of the plugin
	Name string `json:"name"`

	// Version is a SemVer 2 version of the plugin.
	Version string `json:"version"`

	// Usage is the single-line usage text shown in help
	Usage string `json:"usage"`

	// Description is a long description shown in places like `helm help`
	Description string `json:"description"`

	// Command is the command, as a single string.
	//
	// The command will be passed through environment expansion, so env vars can
	// be present in this command. Unless IgnoreFlags is set, this will
	// also merge the flags passed from Helm.
	//
	// Note that command is not executed in a shell. To do so, we suggest
	// pointing the command to a shell script.
	Command string `json:"command"`

	// IgnoreFlags ignores any flags passed in from Helm
	//
	// For example, if the plugin is invoked as `helm --debug myplugin`, if this
	// is false, `--debug` will be appended to `--command`. If this is true,
	// the `--debug` flag will be discarded.
	IgnoreFlags bool `json:"ignoreFlags"`

	// UseTunnel indicates that this command needs a tunnel.
	// Setting this will cause a number of side effects, such as the
	// automatic setting of HELM_HOST.
	UseTunnel bool `json:"useTunnel"`

	// PlatformHooks are commands that will run on events based on the platform specified.
	PlatformHooks map[string]Hooks `json:"hooks"`

	// Downloaders field is used if the plugin supply downloader mechanism
	// for special protocols.
	Downloaders []Downloaders `json:"downloaders"`
}

Metadata describes a plugin.

This is the plugin equivalent of a chart.Metadata.

type Plugin

type Plugin struct {
	// Metadata is a parsed representation of a plugin.yaml
	Metadata *Metadata
	// Dir is the string path to the directory that holds the plugin.
	Dir string
}

Plugin represents a plugin.

func FindPlugins

func FindPlugins(plugdirs string) ([]*Plugin, error)

FindPlugins returns a list of YAML files that describe plugins.

func LoadAll

func LoadAll(basedir string) ([]*Plugin, error)

LoadAll loads all plugins found beneath the base directory.

This scans only one directory level.

func LoadDir

func LoadDir(dirname string) (*Plugin, error)

LoadDir loads a plugin from the given directory.

func (*Plugin) PrepareCommand

func (p *Plugin) PrepareCommand(extraArgs []string) (string, []string)

PrepareCommand takes a Plugin.Command and prepares it for execution.

It merges extraArgs into any arguments supplied in the plugin. It returns the name of the command and an args array.

The result is suitable to pass to exec.Command.