template

package

v0.5.3 Latest Latest Go to latest Published: Nov 16, 2022 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const TemplatePath = "TEMPLATE_PATH"

This section is empty.

This section is empty.

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 interface {
	Run(name string, resource []byte, newVersion string, variables map[string]string) ([]byte, error)
}

Engine is a interface that describes a way to prepare the Deployment for cloning.

func NewDefaultEngine() Engine

NewDefaultEngine returns a new Engine with a predefined templates.

func NewDefaultPatchEngine(path string) Engine

NewDefaultPatchEngine returns a new Engine with a predefined templates.

func NewPatchEngine(patches Patches) Engine

NewPatchEngine constructs a new Engine with the given templates.

type JSON map[string]interface{}

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

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

NewJSON constructs a JSON object from a json string.

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

Equal checks if the values are the same.

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 (t JSON) Value(path string) (interface{}, error)

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

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 []Patch

Patches holds all known patch templates for a Engine.