templates

Documentation

Index

• func InterpolateLeafNode(executor TemplateExecutor, template []byte, tagInterpolator tagInterpolator) (interface{}, error)
• func NewClusterConfigTemplateModel(template *v1alpha1.ClusterConfigTemplate, eval evaluator) *clusterConfigTemplate
• func NewClusterDeploymentTemplateModel(template *v1alpha1.ClusterDeploymentTemplate, eval evaluator) *clusterDeploymentTemplate
• func NewClusterImageTemplateModel(template *v1alpha1.ClusterImageTemplate, eval evaluator) *clusterImageTemplate
• func NewClusterSourceTemplateModel(template *v1alpha1.ClusterSourceTemplate, eval evaluator) *clusterSourceTemplate
• func NewClusterTemplateModel(template *v1alpha1.ClusterTemplate) *clusterTemplate
• type ClusterRunTemplate
  • func NewRunTemplateModel(template *v1alpha1.ClusterRunTemplate) ClusterRunTemplate
• type Config
• type ConfigInput
• type DeploymentConditionError
  • func NewDeploymentConditionError(err error) DeploymentConditionError
  • func (e DeploymentConditionError) Error() string
• type DeploymentFailedConditionMetError
  • func NewDeploymentFailedConditionMetError(err error) DeploymentFailedConditionMetError
  • func (e DeploymentFailedConditionMetError) Error() string
• type Image
• type ImageInput
• type Inputs
  • func (i Inputs) OnlyConfig() interface{}
  • func (i Inputs) OnlyImage() interface{}
  • func (i Inputs) OnlySource() *SourceInput
• type JsonPathContext
• type JsonPathError
  • func NewJsonPathError(expression string, err error) JsonPathError
  • func (e JsonPathError) Error() string
  • func (e JsonPathError) JsonPathExpression() string
• type Labels
• type ObservedGenerationError
  • func NewObservedGenerationError(err error) ObservedGenerationError
  • func (e ObservedGenerationError) Error() string
• type Output
• type Outputs
• type Params
  • func ParamsBuilder(templateParams []v1alpha1.TemplateParam, ...) Params
• 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 Template
  • func NewModelFromAPI(template client.Object) (Template, error)
• type TemplateExecutor

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 NewClusterConfigTemplateModel

func NewClusterConfigTemplateModel(template *v1alpha1.ClusterConfigTemplate, eval evaluator) *clusterConfigTemplate

func NewClusterDeploymentTemplateModel

func NewClusterDeploymentTemplateModel(template *v1alpha1.ClusterDeploymentTemplate, eval evaluator) *clusterDeploymentTemplate

func NewClusterImageTemplateModel

func NewClusterImageTemplateModel(template *v1alpha1.ClusterImageTemplate, eval evaluator) *clusterImageTemplate

func NewClusterSourceTemplateModel

func NewClusterSourceTemplateModel(template *v1alpha1.ClusterSourceTemplate, eval evaluator) *clusterSourceTemplate

func NewClusterTemplateModel

func NewClusterTemplateModel(template *v1alpha1.ClusterTemplate) *clusterTemplate

Types

type ClusterRunTemplate

type ClusterRunTemplate interface {
	GetName() string
	GetResourceTemplate() v1alpha1.TemplateSpec
	GetOutput(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 DeploymentConditionError

type DeploymentConditionError struct {
	Err error
}

func NewDeploymentConditionError

func NewDeploymentConditionError(err error) DeploymentConditionError

func (DeploymentConditionError) Error

func (e DeploymentConditionError) Error() string

type DeploymentFailedConditionMetError

type DeploymentFailedConditionMetError struct {
	Err error
}

func NewDeploymentFailedConditionMetError

func NewDeploymentFailedConditionMetError(err error) DeploymentFailedConditionMetError

func (DeploymentFailedConditionMetError) Error

func (e DeploymentFailedConditionMetError) Error() string

type Image

type Image interface{}

type ImageInput

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

type Inputs

type Inputs struct {
	Sources    map[string]SourceInput
	Images     map[string]ImageInput
	Configs    map[string]ConfigInput
	Deployment *SourceInput
}

func (Inputs) OnlyConfig

func (i Inputs) OnlyConfig() interface{}

func (Inputs) OnlyImage

func (i Inputs) OnlyImage() interface{}

func (Inputs) OnlySource

func (i Inputs) OnlySource() *SourceInput

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 JsonPathError

type JsonPathError struct {
	Err error
	// contains filtered or unexported fields
}

func NewJsonPathError

func NewJsonPathError(expression string, err error) JsonPathError

func (JsonPathError) Error

func (e JsonPathError) Error() string

func (JsonPathError) JsonPathExpression

func (e JsonPathError) JsonPathExpression() string

type Labels

type Labels map[string]string

type ObservedGenerationError

type ObservedGenerationError struct {
	Err error
}

func NewObservedGenerationError

func NewObservedGenerationError(err error) ObservedGenerationError

func (ObservedGenerationError) Error

func (e ObservedGenerationError) Error() string

type Output

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

type Outputs

type Outputs map[string]apiextensionsv1.JSON

type Params

type Params map[string]apiextensionsv1.JSON

func ParamsBuilder

func ParamsBuilder(
	templateParams []v1alpha1.TemplateParam,
	blueprintParams []v1alpha1.DelegatableParam,
	resourceParams []v1alpha1.DelegatableParam,
	ownerParams []v1alpha1.Param,
) Params

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 Template

type Template interface {
	GetResourceTemplate() v1alpha1.TemplateSpec
	GetDefaultParams() v1alpha1.TemplateParams
	GetOutput() (*Output, error)
	SetInputs(*Inputs)
	SetStampedObject(stampedObject *unstructured.Unstructured)
	GetName() string
	GetKind() string
}

func NewModelFromAPI

func NewModelFromAPI(template client.Object) (Template, error)

type TemplateExecutor

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