plugin

Documentation

Index

• func RegisterPlugins(pluginDir string, registry *operator.Registry) []error
• type Config
  • func (c *Config) Build(bc operator.BuildContext) ([]operator.Operator, error)
  • func (c Config) MarshalJSON() ([]byte, error)
  • func (c Config) MarshalYAML() (interface{}, error)
  • func (c *Config) UnmarshalJSON(raw []byte) error
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Definition
• type Parameter
• type Plugin
  • func NewPlugin(pluginID string, contents []byte) (*Plugin, error)
  • func NewPluginFromFile(path string) (*Plugin, error)
  • func (p *Plugin) NewBuilder() operator.Builder
  • func (p *Plugin) Render(params map[string]interface{}) ([]byte, error)
  • func (p *Plugin) UnmarshalText(text []byte) error
  • func (p *Plugin) Validate(params map[string]interface{}) error

Functions

func RegisterPlugins

func RegisterPlugins(pluginDir string, registry *operator.Registry) []error

RegisterPlugins adds every plugin in a directory to the global plugin registry

Types

type Config

type Config struct {
	helper.WriterConfig
	Plugin     *Plugin                `json:"-" yaml:"-"`
	Parameters map[string]interface{} `json:",inline" yaml:",squash"`
}

Config is the config values for the plugin

func (*Config) Build

func (c *Config) Build(bc operator.BuildContext) ([]operator.Operator, error)

Build implements operator.MultiBuilder

func (Config) MarshalJSON

func (c Config) MarshalJSON() ([]byte, error)

MarshalJSON marshals JSON

func (Config) MarshalYAML

func (c Config) MarshalYAML() (interface{}, error)

MarshalYAML marshals YAML

func (*Config) UnmarshalJSON

func (c *Config) UnmarshalJSON(raw []byte) error

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals YAML

type Definition

type Definition struct {
	Version            string      `json:"version"     yaml:"version"`
	Title              string      `json:"title"       yaml:"title"`
	Description        string      `json:"description" yaml:"description"`
	Parameters         []Parameter `json:"parameters"  yaml:"parameters"`
	MinStanzaVersion   string      `json:"minStanzaVersion" yaml:"min_stanza_version"`
	MaxStanzaVersion   string      `json:"maxStanzaVersion" yaml:"max_stanza_version"`
	SupportedPlatforms []string    `json:"supportedPlatforms" yaml:"supported_platforms"`
}

Definition contains metadata for rendering the plugin

type Parameter

type Parameter struct {
	Name        string `json:"name" yaml:"name"`
	Label       string `json:"label" yaml:"label"`
	Description string `json:"description" yaml:"description"`
	Required    bool   `json:"required" yaml:"required"`

	// "string", "int", "bool", "strings", or "enum"
	Type string `json:"type" yaml:"type"`

	// only useable if Type == "enum"
	ValidValues []string `json:"validValues" yaml:"valid_values"`

	// Must be valid according to Type & ValidValues
	Default    interface{}                       `json:"default" yaml:"default"`
	RelevantIf map[string]map[string]interface{} `json:"relevantIf" yaml:"relevant_if"`
}

Parameter is a basic description of a plugin's parameter.

type Plugin

type Plugin struct {
	Definition `yaml:",inline"`
	ID         string `json:"id" yaml:"id"`
	Template   *template.Template
}

Plugin is the rendered result of a plugin template.

func NewPlugin

func NewPlugin(pluginID string, contents []byte) (*Plugin, error)

NewPlugin builds a new plugin from an ID and file contents

func NewPluginFromFile

func NewPluginFromFile(path string) (*Plugin, error)

NewPluginFromFile builds a new plugin from a file

func (*Plugin) NewBuilder

func (p *Plugin) NewBuilder() operator.Builder

NewBuilder creates a new, empty config that can build into an operator

func (*Plugin) Render

func (p *Plugin) Render(params map[string]interface{}) ([]byte, error)

Render will render a plugin's template with the given parameters

func (*Plugin) UnmarshalText

func (p *Plugin) UnmarshalText(text []byte) error

UnmarshalText unmarshals a plugin from a text file

func (*Plugin) Validate

func (p *Plugin) Validate(params map[string]interface{}) error

Validate checks the provided params against the parameter definitions to ensure they are valid