templates

Documentation

Index

• Constants
• func InterpolateLeafNode(executor TemplateExecutor, template []byte, tagInterpolator tagInterpolator) (interface{}, error)
• func NewClusterConfigTemplateReader(template *v1alpha1.ClusterConfigTemplate) *clusterConfigTemplate
• func NewClusterDeploymentTemplateReader(template *v1alpha1.ClusterDeploymentTemplate) *clusterDeploymentTemplate
• func NewClusterImageTemplateReader(template *v1alpha1.ClusterImageTemplate) *clusterImageTemplate
• func NewClusterSourceTemplateReader(template *v1alpha1.ClusterSourceTemplate) *clusterSourceTemplate
• func NewClusterTemplateReader(template *v1alpha1.ClusterTemplate) *clusterTemplate
• type ClusterRunTemplate
  • func NewRunTemplateModel(template *v1alpha1.ClusterRunTemplate) ClusterRunTemplate
• type Config
• type ConfigInput
• type Image
• type ImageInput
• type JsonPathContext
• type Labels
• type Lifecycle
  • func (l *Lifecycle) IsImmutable() bool
• type Output
• type Outputs
• type Reader
  • func NewReaderFromAPI(template client.Object) (Reader, error)
• type Source
• type SourceInput
• type Stamper
  • func StamperBuilder(owner client.Object, templatingContext JsonPathContext, labels Labels) Stamper
  • func (s *Stamper) Stamp(ctx context.Context, resourceTemplate v1alpha1.TemplateSpec) (*unstructured.Unstructured, error)
• type StandardTagInterpolator
  • func (t StandardTagInterpolator) Evaluate(tag string) (interface{}, error)
  • func (t StandardTagInterpolator) InterpolateTag(w io.Writer, tag string) (int, error)
• type TemplateExecutor

Constants

const SuccessStatusPath = `status.conditions[?(@.type=="Succeeded")].status`

Functions

func InterpolateLeafNode

func InterpolateLeafNode(executor TemplateExecutor, template []byte, tagInterpolator tagInterpolator) (interface{}, error)

InterpolateLeafNode merges the context variables anywhere a $(<<jsonPath>>)$ tag is found It validates that the jsonPath refers to objects within the context

func NewClusterConfigTemplateReader

func NewClusterConfigTemplateReader(template *v1alpha1.ClusterConfigTemplate) *clusterConfigTemplate

func NewClusterDeploymentTemplateReader

func NewClusterDeploymentTemplateReader(template *v1alpha1.ClusterDeploymentTemplate) *clusterDeploymentTemplate

func NewClusterImageTemplateReader

func NewClusterImageTemplateReader(template *v1alpha1.ClusterImageTemplate) *clusterImageTemplate

func NewClusterSourceTemplateReader

func NewClusterSourceTemplateReader(template *v1alpha1.ClusterSourceTemplate) *clusterSourceTemplate

func NewClusterTemplateReader

func NewClusterTemplateReader(template *v1alpha1.ClusterTemplate) *clusterTemplate

Types

type ClusterRunTemplate

type ClusterRunTemplate interface {
	GetName() string
	GetResourceTemplate() v1alpha1.TemplateSpec
	GetLatestSuccessfulOutput(stampedObjects []*unstructured.Unstructured) (Outputs, *unstructured.Unstructured, error)
}

func NewRunTemplateModel

func NewRunTemplateModel(template *v1alpha1.ClusterRunTemplate) ClusterRunTemplate

type Config

type Config interface{}

type ConfigInput

type ConfigInput struct {
	Config interface{} `json:"config"`
	Name   string      `json:"name"`
}

type Image

type Image interface{}

type ImageInput

type ImageInput struct {
	Image interface{} `json:"image"`
	Name  string      `json:"name"`
}

type JsonPathContext

type JsonPathContext interface{}

JsonPathContext is any structure that you intend for jsonpath to treat as it's context. typically any struct with template-specific json structure tags

type Labels

type Labels map[string]string

type Lifecycle

type Lifecycle string

const (
	Mutable   Lifecycle = "mutable"
	Immutable Lifecycle = "immutable"
	Tekton    Lifecycle = "tekton"
)

func (*Lifecycle) IsImmutable

func (l *Lifecycle) IsImmutable() bool

type Output

type Output struct {
	Source *Source
	Image  Image
	Config Config
}

type Outputs

type Outputs map[string]apiextensionsv1.JSON

type Reader

type Reader interface {
	GetDefaultParams() v1alpha1.TemplateParams

	// GetResourceTemplate returns the actual representation of a resource to stamp, and how to handle it
	// TODO: we should be expecting something with a [ytt|template] interface, the health rules and params should
	// not be fetched here
	GetResourceTemplate() v1alpha1.TemplateSpec
	GetHealthRule() *v1alpha1.HealthRule
	IsYTTTemplate() bool
	GetLifecycle() *Lifecycle
	GetRetentionPolicy() v1alpha1.RetentionPolicy
}

func NewReaderFromAPI

func NewReaderFromAPI(template client.Object) (Reader, error)

type Source

type Source struct {
	URL      interface{} `json:"url"`
	Revision interface{} `json:"revision"`
}

type SourceInput

type SourceInput struct {
	URL      interface{} `json:"url"`
	Revision interface{} `json:"revision"`
	Name     string      `json:"name"`
}

type Stamper

type Stamper struct {
	TemplatingContext JsonPathContext
	Owner             client.Object
	Labels            Labels
}

func StamperBuilder

func StamperBuilder(owner client.Object, templatingContext JsonPathContext, labels Labels) Stamper

func (*Stamper) Stamp

func (s *Stamper) Stamp(ctx context.Context, resourceTemplate v1alpha1.TemplateSpec) (*unstructured.Unstructured, error)

type StandardTagInterpolator

type StandardTagInterpolator struct {
	Context   JsonPathContext
	Evaluator evaluator
}

func (StandardTagInterpolator) Evaluate

func (t StandardTagInterpolator) Evaluate(tag string) (interface{}, error)

func (StandardTagInterpolator) InterpolateTag

func (t StandardTagInterpolator) InterpolateTag(w io.Writer, tag string) (int, error)

type TemplateExecutor

type TemplateExecutor func(template, startTag, endTag string, f fasttemplate.TagFunc) (string, error)