template

Documentation

Overview

Package template provides TemplateProcessor, capable of transforming Template objects into Config objects.

Index

• Constants
• func AddConfigLabels(c *configapi.Config, labels labels.Set) errs.ValidationErrorList
• func AddObjectLabels(obj runtime.Object, labels labels.Set) error
• func AddParameter(t *api.Template, param api.Parameter)
• func GetParameterByName(t *api.Template, name string) *api.Parameter
• func MergeInto(dst, src interface{}, flags int) error
• type Processor
  • func NewProcessor(generators map[string]Generator) *Processor
  • func (p *Processor) GenerateParameterValues(t *api.Template) error
  • func (p *Processor) Process(template *api.Template) (*configapi.Config, errs.ValidationErrorList)
  • func (p *Processor) SubstituteParameters(params []api.Parameter, item runtime.Object) (runtime.Object, error)

Constants

const (
	OverwriteExistingDstKey = 1 << iota
	ErrorOnExistingDstKey
	ErrorOnDifferentDstKeyValue
)

MergeInto flags

Functions

func AddConfigLabels

func AddConfigLabels(c *configapi.Config, labels labels.Set) errs.ValidationErrorList

AddConfigLabels adds new label(s) to all resources defined in the given Config.

func AddObjectLabels

func AddObjectLabels(obj runtime.Object, labels labels.Set) error

AddObjectLabels adds new label(s) to a single runtime.Object

func AddParameter

func AddParameter(t *api.Template, param api.Parameter)

AddParameter adds new custom parameter to the Template. It overrides the existing parameter, if already defined.

func GetParameterByName

func GetParameterByName(t *api.Template, name string) *api.Parameter

GetParameterByName searches for a Parameter in the Template based on it's name.

func MergeInto

func MergeInto(dst, src interface{}, flags int) error

MergeInto merges items from a src map into a dst map. Returns an error when the maps are not of the same type. Flags:

• ErrorOnExistingDstKey When set: Return an error if any of the dst keys is already set.
• ErrorOnDifferentDstKeyValue When set: Return an error if any of the dst keys is already set to a different value than src key.
• OverwriteDstKey When set: Overwrite existing dst key value with src key value.

Types

type Processor

type Processor struct {
	Generators map[string]Generator
}

Processor process the Template into the List with substituted parameters

func NewProcessor

func NewProcessor(generators map[string]Generator) *Processor

NewProcessor creates new Processor and initializes its set of generators.

func (*Processor) GenerateParameterValues

func (p *Processor) GenerateParameterValues(t *api.Template) error

GenerateParameterValues generates Value for each Parameter of the given Template that has Generate field specified where Value is not already supplied.

Examples:

from | value ----------------------------- "test[0-9]{1}x" | "test7x" "[0-1]{8}" | "01001100" "0x[A-F0-9]{4}" | "0xB3AF" "[a-zA-Z0-9]{8}" | "hW4yQU5i"

func (*Processor) Process

func (p *Processor) Process(template *api.Template) (*configapi.Config, errs.ValidationErrorList)

Process transforms Template object into List object. It generates Parameter values using the defined set of generators first, and then it substitutes all Parameter expression occurrences with their corresponding values (currently in the containers' Environment variables only).

func (*Processor) SubstituteParameters

func (p *Processor) SubstituteParameters(params []api.Parameter, item runtime.Object) (runtime.Object, error)

SubstituteParameters loops over all Environment variables defined for all ReplicationController and Pod containers and substitutes all Parameter expression occurrences with their corresponding values.

Example of Parameter expression:

• ${PARAMETER_NAME}

TODO: Implement substitution for more types and fields.