index

Documentation

Index

• type FileOperation
• type GoTpl
• type Platform
• type Plugin
• type PluginSpec
• type Receipt
• type ReceiptStatus
• type SourceIndex

Types

type FileOperation

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

FileOperation specifies a file copying operation from plugin archive to the installation directory.

type GoTpl

type GoTpl struct {
	Type     string `json:"type,omitempty"`
	Version  string `json:"version,omitempty"`
	BasePath string `json:"base_path,omitempty"`
}

type Platform

type Platform struct {
	URI string `json:"uri,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 describes how to perform an installation on a specific platform and how to match the target platform (os, arch).

type Plugin

type Plugin struct {
	metav1.TypeMeta   `json:",inline" yaml:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata"`
	Spec              PluginSpec `json:"spec,inline" yaml:"spec"`
	Template          GoTpl      `json:"template,inline" yaml:"template"`
}

Plugin describes a plugin manifest file.

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"`
	Homepage         string     `json:"homepage,omitempty"`
	Vars             []string   `json:"vars,omitempty"`
	Platforms        []Platform `json:"platforms,omitempty"`
}

PluginSpec is the plugin specification.

type Receipt

type Receipt struct {
	Plugin `json:",inline" yaml:",inline"`

	Status ReceiptStatus `json:"status"`
}

Receipt describes a plugin receipt file.

type ReceiptStatus

type ReceiptStatus struct {
	Source SourceIndex `json:"source"`
}

ReceiptStatus contains information about the installed plugin.

type SourceIndex

type SourceIndex struct {
	// Name is the configured name of an index a plugin was installed from.
	Name string `json:"name"`
}

SourceIndex contains information about the index a plugin was installed from.