helm

Documentation

Index

• type TemplateReader
  • func (r *TemplateReader) Read() (map[string]interface{}, error)
  • func (r *TemplateReader) ReadStream(on templater.OnDataStream, stopCh <-chan struct{}) error
  • func (r *TemplateReader) RegisterQuery(query *templater.TemplateReaderQuery) error
  • func (r *TemplateReader) ValuesFromTarget() (map[string]interface{}, error)
• type TemplateWriter
  • func (w *TemplateWriter) Create(vals map[string]interface{}) (map[string]interface{}, error)
  • func (w *TemplateWriter) Transform() error
  • func (w *TemplateWriter) Update(vals map[string]interface{}) (map[string]interface{}, error)

Types

type TemplateReader

type TemplateReader struct {
	Queries []*templater.TemplateReaderQuery

	Release *release.Release
	Chart   *chart.Chart
}

TemplateReader implements the templater.TemplateReader for reading from the Helm values.

Note: ReadStream does nothing at the moment.

func (*TemplateReader) Read

func (r *TemplateReader) Read() (map[string]interface{}, error)

Read executes a set of queries against the helm values in the release/chart

func (*TemplateReader) ReadStream

func (r *TemplateReader) ReadStream(
	on templater.OnDataStream,
	stopCh <-chan struct{},
) error

ReadStream is unimplemented: stub just to implement TemplateReader

func (*TemplateReader) RegisterQuery

func (r *TemplateReader) RegisterQuery(query *templater.TemplateReaderQuery) error

RegisterQuery adds a new query to be executed against the values

func (*TemplateReader) ValuesFromTarget

func (r *TemplateReader) ValuesFromTarget() (map[string]interface{}, error)

ValuesFromTarget returns a set of values by reading from a Helm release if set, otherwise a helm chart.

type TemplateWriter

type TemplateWriter struct {
	// The object to read from, identified by its group-version-kind
	Agent *helm.Agent

	// Chart that gets installed
	Chart *chart.Chart

	// ReleaseName for upgrading the chart or installing
	ReleaseName string

	// Namespace it gets installed to
	Namespace string
}

TemplateWriter upgrades and installs charts by setting Helm values

func (*TemplateWriter) Create

func (w *TemplateWriter) Create(
	vals map[string]interface{},
) (map[string]interface{}, error)

Create installs a new chart, ChartPath must be set

func (*TemplateWriter) Transform

func (w *TemplateWriter) Transform() error

Transform does nothing, since Helm handles the transforms internally

func (*TemplateWriter) Update

func (w *TemplateWriter) Update(
	vals map[string]interface{},
) (map[string]interface{}, error)

Update upgrades a chart, ReleaseName must be set