installer

Documentation

Overview

Package installer provides an interface for installing Helm plugins.

Index

• Variables
• func Install(i Installer) error
• type Installer
  • func NewForSource(source, version string, home helmpath.Home) (Installer, error)
• type LocalInstaller
  • func NewLocalInstaller(source string, home helmpath.Home) (*LocalInstaller, error)
  • func (i *LocalInstaller) Install() error
  • func (b *LocalInstaller) Path() string
• type VCSInstaller
  • func NewVCSInstaller(source, version string, home helmpath.Home) (*VCSInstaller, error)
  • func (i *VCSInstaller) Install() error
  • func (b *VCSInstaller) Path() string

Variables

var Debug bool

Debug enables verbose output.

var ErrMissingMetadata = errors.New("plugin metadata (plugin.yaml) missing")

ErrMissingMetadata indicates that plugin.yaml is missing.

Functions

func Install

func Install(i Installer) error

Install installs a plugin to $HELM_HOME.

Types

type Installer

type Installer interface {
	// Install adds a plugin to $HELM_HOME.
	Install() error
	// Path is the directory of the installed plugin.
	Path() string
}

Installer provides an interface for installing helm client plugins.

func NewForSource

func NewForSource(source, version string, home helmpath.Home) (Installer, error)

NewForSource determines the correct Installer for the given source.

type LocalInstaller

type LocalInstaller struct {
	// contains filtered or unexported fields
}

LocalInstaller installs plugins from the filesystem.

func NewLocalInstaller

func NewLocalInstaller(source string, home helmpath.Home) (*LocalInstaller, error)

NewLocalInstaller creates a new LocalInstaller.

func (*LocalInstaller) Install

func (i *LocalInstaller) Install() error

Install creates a symlink to the plugin directory in $HELM_HOME.

Implements Installer.

func (*LocalInstaller) Path

func (b *LocalInstaller) Path() string

Path is where the plugin will be symlinked to.

type VCSInstaller

type VCSInstaller struct {
	Repo    vcs.Repo
	Version string
	// contains filtered or unexported fields
}

VCSInstaller installs plugins from remote a repository.

func NewVCSInstaller

func NewVCSInstaller(source, version string, home helmpath.Home) (*VCSInstaller, error)

NewVCSInstaller creates a new VCSInstaller.

func (*VCSInstaller) Install

func (i *VCSInstaller) Install() error

Install clones a remote repository and creates a symlink to the plugin directory in HELM_HOME.

Implements Installer.

func (*VCSInstaller) Path

func (b *VCSInstaller) Path() string

Path is where the plugin will be symlinked to.