helm

Documentation

Index

• type Args
• type ArgsApplier
• type Client
  • func NewClient(log logging.Logger, restConfig *rest.Config, argAppliers ...ArgsApplier) (Client, error)
• type KustomizationRender
  • func (kr KustomizationRender) Run(renderedManifests *bytes.Buffer) (modifiedManifests *bytes.Buffer, err error)
• type RepoCreds

Types

type Args

type Args struct {
	// Namespace to install the release into.
	Namespace string
	// Wait for the release to become ready.
	Wait bool
	// Timeout is the duration Helm will wait for the release to become ready.
	Timeout time.Duration
	// SkipCRDs skips CRDs creation during Helm release install or upgrade.
	SkipCRDs bool
	// InsecureSkipTLSVerify skips tls certificate checks for the chart download
	InsecureSkipTLSVerify bool
}

Args stores common options that can be passed to a Helm client on initialization

type ArgsApplier

type ArgsApplier func(*Args)

ArgsApplier defines helm client arguments helper

type Client

type Client interface {
	GetLastRelease(release string) (*release.Release, error)
	Install(release string, chart *chart.Chart, vals map[string]interface{}, patches []ktype.Patch) (*release.Release, error)
	Upgrade(release string, chart *chart.Chart, vals map[string]interface{}, patches []ktype.Patch) (*release.Release, error)
	Rollback(release string) error
	Uninstall(release string) error
	PullAndLoadChart(spec *v1beta1.ChartSpec, creds *RepoCreds) (*chart.Chart, error)
}

Client is the interface to interact with Helm

func NewClient

func NewClient(log logging.Logger, restConfig *rest.Config, argAppliers ...ArgsApplier) (Client, error)

NewClient returns a new Helm Client with provided config

type KustomizationRender

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

KustomizationRender Implements helm PostRenderer interface

func (KustomizationRender) Run

func (kr KustomizationRender) Run(renderedManifests *bytes.Buffer) (modifiedManifests *bytes.Buffer, err error)

Run runs a set of Kustomize patches against yaml input and returns the patched content.

type RepoCreds

type RepoCreds struct {
	Username string
	Password string
}

RepoCreds keeps auth information to access a Helm Chart