helm

Documentation

Overview

Package helm contains the helm CLI client interface and implementation.

Index

• Variables
• type CLIClient
  • func NewHelmClient(config *clientcmdapi.Config) *CLIClient
  • func (c *CLIClient) Delete(name, namespace string) error
  • func (c *CLIClient) Pull(options Options) error
  • func (c *CLIClient) Upgrade(name, namespace string, options Options) error
• type Client
• type Options
  • func (o Options) ConfigureArchive(args []string) []string
  • func (o Options) ConfigureAuth(args []string) []string
  • func (o Options) ConfigureRepo(args []string) []string
  • func (o Options) ConfigureTLS(args []string) []string
  • func (o Options) ConfigureVersion(args []string) []string

Variables

var (
	// CommandPath is the location of the helm binary.
	CommandPath = "./helm"
)

Types

type CLIClient

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

CLIClient is a Helm client that interacts with the Helm CLI.

func NewHelmClient

func NewHelmClient(config *clientcmdapi.Config) *CLIClient

NewHelmClient creates a new Helm client from the given config

func (*CLIClient) Delete

func (c *CLIClient) Delete(name, namespace string) error

Delete deletes a Helm release.

func (*CLIClient) Pull

func (c *CLIClient) Pull(options Options) error

Pull downloads a Helm chart.

func (*CLIClient) Upgrade

func (c *CLIClient) Upgrade(name, namespace string, options Options) error

Upgrade upgrades a Helm release.

type Client

type Client interface {
	Delete(name, namespace string) error
	Pull(options Options) error
	Upgrade(name, namespace string, options Options) error
}

Client is an interface for interacting with the Helm CLI.

type Options

type Options struct {
	Chart string
	Path  string

	Registry        string
	Repo            string
	Version         string
	Values          string
	SetValues       map[string]string
	SetStringValues map[string]string

	Username string
	Password string

	Atomic          bool
	Force           bool
	CreateNamespace bool

	Untar    bool
	UntarDir string

	CaFile                string
	InsecureSkipTLSVerify bool

	ExtraArgs []string
}

Options holds all the options for installing/pulling/upgrading a chart.

func (Options) ConfigureArchive

func (o Options) ConfigureArchive(args []string) []string

ConfigureArchive adds the archive flags to the command.

func (Options) ConfigureAuth

func (o Options) ConfigureAuth(args []string) []string

ConfigureAuth adds basic auth flags to the command.

func (Options) ConfigureRepo

func (o Options) ConfigureRepo(args []string) []string

ConfigureRepo adds the repo flag to the command.

func (Options) ConfigureTLS

func (o Options) ConfigureTLS(args []string) []string

ConfigureTLS adds TLS flags to the command.

func (Options) ConfigureVersion

func (o Options) ConfigureVersion(args []string) []string

ConfigureVersion adds the version flag to the command.