index

Documentation

Index

• func IsSafePluginName(name string) bool
• type FileOperation
• type Platform
  • func (p Platform) Validate() error
• type Plugin
  • func (p Plugin) Validate(name string) error
• type PluginList
• type PluginSpec

Functions

func IsSafePluginName

func IsSafePluginName(name string) bool

IsSafePluginName checks if the plugin Name is save to use.

Types

type FileOperation

type FileOperation struct {
	From string `json:"from,omitempty"`
	To   string `json:"to,omitempty"`
}

FileOperation TODO(lbb)

type Platform

type Platform struct {
	Head   string `json:"head,omitempty"`
	URI    string `json:"uri,omitempty"`
	Sha256 string `json:"sha256,omitempty"`

	Selector *metav1.LabelSelector `json:"selector,omitempty"`
	Files    []FileOperation       `json:"files"`

	// Bin specifies the path to the plugin executable.
	// The path is relative to the root of the installation folder.
	// The binary will be linked after all FileOperations are executed.
	Bin string `json:"bin"`
}

Platform TODO(lbb)

func (Platform) Validate

func (p Platform) Validate() error

Validate TODO(lbb)

type Plugin

type Plugin struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec PluginSpec `json:"spec"`
}

Plugin is a top-level type. TODO(lbb): Add deepcopy code generation.

func (Plugin) Validate

func (p Plugin) Validate(name string) error

Validate TODO(lbb)

type PluginList

type PluginList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []Plugin `json:"items"`
}

PluginList TODO(lbb)

type PluginSpec

type PluginSpec struct {
	Version          string `json:"version,omitempty"`
	ShortDescription string `json:"shortDescription,omitempty"`
	Description      string `json:"description,omitempty"`
	Caveats          string `json:"caveats,omitempty"`

	Platforms []Platform `json:"platforms,omitempty"`
}

PluginSpec TODO(lbb)