template

Documentation

Index

• type Context
• type Engine
  • func NewDefaultEngine() *Engine
  • func NewEngine(patches Patches) *Engine
  • func (e Engine) Run(name string, resource []byte, newVersion string, variables map[string]string) ([]byte, error)
• type JSON
  • func NewJSON(data []byte) (JSON, error)
  • func (t JSON) Equal(path string, compare interface{}) bool
  • func (t JSON) Has(path string) bool
  • func (t JSON) Value(path string) (interface{}, error)
• type Patch
• type Patches

Types

type Context

type Context struct {
	NewVersion string
	Data       JSON
	Vars       map[string]string
}

Context contain the template context used during conversion. Holds template variables and data.

type Engine

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

Engine is a reusable instance with a configured set of patch templates

func NewDefaultEngine

func NewDefaultEngine() *Engine

NewDefaultEngine returns a new Engine with a predefined templates

func NewEngine

func NewEngine(patches Patches) *Engine

NewEngine constructs a new Engine with the given templates

func (Engine) Run

func (e Engine) Run(name string, resource []byte, newVersion string, variables map[string]string) ([]byte, error)

Run performs the template transformation of a given json structure

type JSON

type JSON map[string]interface{}

JSON is a parsed json structure with helper functions to access the data based on json paths.

func NewJSON

func NewJSON(data []byte) (JSON, error)

NewJSON constructs a JSON object from a json string

func (JSON) Equal

func (t JSON) Equal(path string, compare interface{}) bool

Equal checks if the values are the same

func (JSON) Has

func (t JSON) Has(path string) bool

Has is a check if the json contain a value behind a json path, e.g. /spec/metadata/name

func (JSON) Value

func (t JSON) Value(path string) (interface{}, error)

Value returns the object value behind a json path, e.g. /spec/metadata/name

type Patch

type Patch struct {
	Name      string
	Template  []byte
	Variables map[string]string
}

Patch is a named JSON Patch and it's defined default variables.

type Patches

type Patches []Patch

Patches holds all known patch templates for a Engine