transformers

Documentation

Overview

Package transformers has implementations of resmap.ResMap transformers.

Index

• func MutateField(m map[string]interface{}, pathToField []string, createIfNotPresent bool, ...) error
• type Generator
• type RefVarTransformer
  • func NewRefVarTransformer(varMap map[string]interface{}, fs []config.FieldSpec) *RefVarTransformer
  • func (rv *RefVarTransformer) Transform(m resmap.ResMap) error
  • func (rv *RefVarTransformer) UnusedVars() []string
• type Transformer
  • func NewAnnotationsMapTransformer(m map[string]string, fs []config.FieldSpec) (Transformer, error)
  • func NewLabelsMapTransformer(m map[string]string, fs []config.FieldSpec) (Transformer, error)
  • func NewMapTransformer(pc []config.FieldSpec, m map[string]string) (Transformer, error)
  • func NewMultiTransformer(t []Transformer) Transformer
  • func NewMultiTransformerWithConflictCheck(t []Transformer) Transformer
  • func NewNameReferenceTransformer(br []config.NameBackReferences) Transformer
  • func NewNoOpTransformer() Transformer

Functions

func MutateField

func MutateField(
	m map[string]interface{},
	pathToField []string,
	createIfNotPresent bool,
	fns ...mutateFunc) error

Types

type Generator

type Generator interface {
	Generate() (resmap.ResMap, error)
}

A Generator creates an instance of resmap.ResMap.

type RefVarTransformer

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

func NewRefVarTransformer

func NewRefVarTransformer(
	varMap map[string]interface{}, fs []config.FieldSpec) *RefVarTransformer

NewRefVarTransformer returns a new RefVarTransformer that replaces $(VAR) style variables with values. The fieldSpecs are the places to look for occurrences of $(VAR).

func (*RefVarTransformer) Transform

func (rv *RefVarTransformer) Transform(m resmap.ResMap) error

Transform replaces $(VAR) style variables with values.

func (*RefVarTransformer) UnusedVars

func (rv *RefVarTransformer) UnusedVars() []string

UnusedVars returns slice of Var names that were unused after a Transform run.

type Transformer

type Transformer interface {
	// Transform modifies data in the argument, e.g. adding labels to resources that can be labelled.
	Transform(m resmap.ResMap) error
}

A Transformer modifies an instance of resmap.ResMap.

func NewAnnotationsMapTransformer

func NewAnnotationsMapTransformer(
	m map[string]string, fs []config.FieldSpec) (Transformer, error)

NewAnnotationsMapTransformer construct a mapTransformer.

func NewLabelsMapTransformer

func NewLabelsMapTransformer(
	m map[string]string, fs []config.FieldSpec) (Transformer, error)

NewLabelsMapTransformer constructs a mapTransformer.

func NewMapTransformer

func NewMapTransformer(
	pc []config.FieldSpec, m map[string]string) (Transformer, error)

NewMapTransformer construct a mapTransformer.

func NewMultiTransformer

func NewMultiTransformer(t []Transformer) Transformer

NewMultiTransformer constructs a multiTransformer.

func NewMultiTransformerWithConflictCheck

func NewMultiTransformerWithConflictCheck(t []Transformer) Transformer

NewMultiTransformerWithConflictCheck constructs a multiTransformer with checking of conflicts.

func NewNameReferenceTransformer

func NewNameReferenceTransformer(br []config.NameBackReferences) Transformer

NewNameReferenceTransformer constructs a nameReferenceTransformer with a given slice of NameBackReferences.

func NewNoOpTransformer

func NewNoOpTransformer() Transformer

NewNoOpTransformer constructs a noOpTransformer.