resolver

Documentation

Index

• type ChartRelease
• type Mode
• type Options
• type ResolvedChart
  • func NewLocallyResolvedChart(path string, chartVersion string) ResolvedChart
  • func NewRemotelyResolvedChart(path string, chartVersion string, chartRepo string) ResolvedChart
• type Resolver
  • func NewResolver(runner shell.Runner, options Options) Resolver

Types

type ChartRelease

type ChartRelease struct {
	Name    string
	Repo    string
	Version string
}

ChartRelease the set of attributes needed to find and download a Helm chart

type Mode

type Mode int

Mode is an enum type referring to the two types of releases supported by terra-helmfile.

const (
	Development Mode = iota // Development mode: prefer source copies of charts
	Deploy                  // Deploy mode: prefer released versions of charts (in versions/ directories)
)

type Options

type Options struct {
	Mode       Mode   // development / deploy
	SourceDir  string // path to chart source directory
	CacheDir   string // path where downloaded charts should be cached
	ScratchDir string // scratch directory where temporary files should be created
}

type ResolvedChart

type ResolvedChart interface {
	// Path where the resolved chart can be found on disk
	Path() string
	// Version of the resolved chart.
	Version() string
	// SourceDescription of where the chart was found.
	// If local, this will be path on disk relative to current working directory. (eg. "./charts/agora")
	// If repo, this will be the name of the Helm repo. (eg. "terra-helm")
	SourceDescription() string
}

ResolvedChart represents the outcome of a successful resolution of a chart release.

func NewLocallyResolvedChart

func NewLocallyResolvedChart(path string, chartVersion string) ResolvedChart

NewLocallyResolvedChart creates a ResolvedChart based from the local filesystem

func NewRemotelyResolvedChart

func NewRemotelyResolvedChart(path string, chartVersion string, chartRepo string) ResolvedChart

NewRemotelyResolvedChart creates a ResolvedChart based from a remote Helm repo

type Resolver

type Resolver interface {
	// Resolve determines where a Helm chart should be sourced from.
	// If in "deploy" mode, downloads and unpacks the published chart from the Helm repository.
	// If in "development" mode, runs "helm dependency update" on the local working/source copy of the chart.
	// Under some conditions, "development" mode falls back to downloading published chart and vice versa.
	Resolve(chart ChartRelease) (ResolvedChart, error)
}

Resolver determines where a Helm chart should be sourced from.

func NewResolver

func NewResolver(runner shell.Runner, options Options) Resolver