helmshim

Documentation

Index

• Variables
• func MustRenderChart(opts ...RenderOption)
• func RenderChart(opts ...RenderOption) error
• func Synth[T function.Inputs](values ValuesFunc[T], opts ...RenderOption) function.SynthFunc[T]
• type ChartLoader
• type RenderOption
  • func ParseFlags() []RenderOption
  • func WithChartLoader(cl ChartLoader) RenderOption
  • func WithChartPath(path string) RenderOption
  • func WithInputReader(r *function.InputReader) RenderOption
  • func WithNamespace(ns string) RenderOption
  • func WithOutputWriter(w *function.OutputWriter) RenderOption
  • func WithReleaseName(rn string) RenderOption
  • func WithValuesFunc(fn ValuesFunc[*function.InputReader]) RenderOption
• type ValuesFunc

Variables

var (
	ErrChartNotFound      = errors.New("the requested chart could not be loaded")
	ErrRenderAction       = errors.New("the chart could not be rendered with the given values")
	ErrCannotParseChart   = errors.New("helm produced a set of manifests that is not parseable")
	ErrConstructingValues = errors.New("error while constructing helm values")
)

Functions

func MustRenderChart

func MustRenderChart(opts ...RenderOption)

MustRenderChart is the entrypoint to the Helm shim.

The most basic shim cmd's main func only needs one line: > helmshim.MustRenderChart(helmshim.ParseFlags()...)

func RenderChart

func RenderChart(opts ...RenderOption) error

Deprecated: Use Synth directly

func Synth

func Synth[T function.Inputs](values ValuesFunc[T], opts ...RenderOption) function.SynthFunc[T]

Synth produced a SynthFunc that 1) uses inputs as a values func rather than input reader 2) a writer that saves the objects to a slice rather than serializing

Types

type ChartLoader

type ChartLoader func() (*chart.Chart, error)

ChartLoader is the function for loading a helm chart.

type RenderOption

type RenderOption func(*options)

func ParseFlags

func ParseFlags() []RenderOption

func WithChartLoader

func WithChartLoader(cl ChartLoader) RenderOption

func WithChartPath

func WithChartPath(path string) RenderOption

func WithInputReader

func WithInputReader(r *function.InputReader) RenderOption

func WithNamespace

func WithNamespace(ns string) RenderOption

func WithOutputWriter

func WithOutputWriter(w *function.OutputWriter) RenderOption

func WithReleaseName

func WithReleaseName(rn string) RenderOption

func WithValuesFunc

func WithValuesFunc(fn ValuesFunc[*function.InputReader]) RenderOption

type ValuesFunc

type ValuesFunc[T function.Inputs] func(inputs T) (map[string]any, error)