plugin

Documentation

Index

• type Config
• type Plugin
  • func Find(fs afero.Fs, name string) (Plugin, error)
  • func List(fs afero.Fs) ([]Plugin, error)
  • func (p *Plugin) BuildRunCmd(env, args []string) *exec.Cmd

Types

type Config

type Config struct {
	// Name is the name of the plugin.
	Name string `yaml:"name,omitempty"`
	// Version is the version of the plugin.
	Version string `yaml:"version,omitempty"`
	// Description is the plugin description.
	Description string `yaml:"description,omitempty"`
	// IgnoreFlags is set if this plugin will ignore flags.
	IgnoreFlags bool `yaml:"ignore_flags,omitempty"`
	// Command is the command that needs to be called to invoke the plugin.
	Command string `yaml:"command,omitempty"`
}

Config is configuration for a Plugin.

type Plugin

type Plugin struct {
	// RootDir is the root directory for the plugin.
	RootDir string
	// Config is configuration for the plugin.
	Config Config
}

Plugin is a ksonnet plugin.

func Find

func Find(fs afero.Fs, name string) (Plugin, error)

Find finds a plugin by name.

func List

func List(fs afero.Fs) ([]Plugin, error)

List plugins

func (*Plugin) BuildRunCmd

func (p *Plugin) BuildRunCmd(env, args []string) *exec.Cmd

BuildRunCmd builds a command that runs the plugin.