template

Documentation

Index

• Constants
• func MakeConfigAccessObject(confSvc ConfigurationService, varStack map[string]string) map[string]interface{}
• func MakeConfigAndRepoAccessFuncs(confSvc ConfigurationService, varStack map[string]string, ...) map[string]interface{}
• func MakePluginObjectStack(varStack map[string]string, baseConfigStack map[string]string) map[string]interface{}
• func MakeUtilFuncMap(varStack map[string]string) map[string]interface{}
• func NullCallback(_ Stage, err error) error
• type BuildObjectStackFunc
• type ConfigAccessFuncs
  • func MakeConfigAccessFuncs(confSvc ConfigurationService, varStack map[string]string) ConfigAccessFuncs
• type ConfigurationService
• type ConsulTemplateLoader
  • func NewConsulTemplateLoader(confSvc ConfigurationService, basePath string) *ConsulTemplateLoader
  • func (c *ConsulTemplateLoader) Abs(base, name string) string
  • func (c *ConsulTemplateLoader) Get(path string) (io.Reader, error)
• type Field
  • func WrapGeneric(getterF GetterFunc, setterF SetterFunc) Field
  • func WrapPointer(field *string) Field
• type Fields
  • func WrapMapItems(items map[string]string) Fields
  • func WrapSliceItems(items []string) Fields
  • func (fields Fields) Execute(confSvc ConfigurationService, parentPath string, varStack map[string]string, ...) (err error)
• type GenericWrapper
  • func (t *GenericWrapper) Get() string
  • func (t *GenericWrapper) Set(value string)
• type GetConfigFunc
• type GetMultiVarConfigFunc
• type GetterFunc
• type MultiVarConfigAccessFuncs
  • func MakeConfigAccessFuncsMultiVar(confSvc ConfigurationService, varStack map[string]string) MultiVarConfigAccessFuncs
• type PointerWrapper
  • func (t *PointerWrapper) Get() string
  • func (t *PointerWrapper) Set(value string)
• type RoleDisabledError
  • func (e *RoleDisabledError) Error() string
• type Sequence
  • func (sf Sequence) Execute(confSvc ConfigurationService, parentPath string, varStack VarStack, ...) (err error)
• type SetterFunc
• type Stage
• type StageCallbackFunc
• type ToPtreeFunc
  • func MakeToPtreeFunc(varStack map[string]string, propMap map[string]string) ToPtreeFunc
• type VarStack

Constants

const DEBUG_TEMPLATE_SYSTEM = false

Functions

func MakeConfigAccessObject

func MakeConfigAccessObject(confSvc ConfigurationService, varStack map[string]string) map[string]interface{}

func MakeConfigAndRepoAccessFuncs

func MakeConfigAndRepoAccessFuncs(confSvc ConfigurationService, varStack map[string]string, workflowRepo repos.IRepo) map[string]interface{}

func MakePluginObjectStack

func MakePluginObjectStack(varStack map[string]string, baseConfigStack map[string]string) map[string]interface{}

func MakeUtilFuncMap

func MakeUtilFuncMap(varStack map[string]string) map[string]interface{}

func NullCallback

func NullCallback(_ Stage, err error) error

Types

type BuildObjectStackFunc

type BuildObjectStackFunc func(stage Stage) map[string]interface{}

type ConfigAccessFuncs

type ConfigAccessFuncs map[string]GetConfigFunc

func MakeConfigAccessFuncs

func MakeConfigAccessFuncs(confSvc ConfigurationService, varStack map[string]string) ConfigAccessFuncs

deprecated

type ConfigurationService

type ConfigurationService interface {
	GetComponentConfiguration(query *componentcfg.Query) (payload string, err error)
	GetComponentConfigurationWithLastIndex(query *componentcfg.Query) (payload string, lastIndex uint64, err error)
	GetAndProcessComponentConfiguration(query *componentcfg.Query, varStack map[string]string) (payload string, err error)
	ResolveComponentQuery(query *componentcfg.Query) (resolved *componentcfg.Query, err error)

	GetDetectorForHost(hostname string) (string, error)
	GetDetectorsForHosts(hosts []string) ([]string, error)
	GetCRUCardsForHost(hostname string) (string, error)
	GetEndpointsForCRUCard(hostname, cardSerial string) (string, error)

	GetRuntimeEntry(component string, key string) (string, error)
	SetRuntimeEntry(component string, key string, value string) error
}

type ConsulTemplateLoader

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

Implements pongo2.TemplateLoader to fetch included templates from Consul paths

func NewConsulTemplateLoader

func NewConsulTemplateLoader(confSvc ConfigurationService, basePath string) *ConsulTemplateLoader

func (*ConsulTemplateLoader) Abs

func (c *ConsulTemplateLoader) Abs(base, name string) string

func (*ConsulTemplateLoader) Get

func (c *ConsulTemplateLoader) Get(path string) (io.Reader, error)

type Field

type Field interface {
	Get() string
	Set(value string)
}

func WrapGeneric

func WrapGeneric(getterF GetterFunc, setterF SetterFunc) Field

func WrapPointer

func WrapPointer(field *string) Field

type Fields

type Fields []Field

func WrapMapItems

func WrapMapItems(items map[string]string) Fields

func WrapSliceItems

func WrapSliceItems(items []string) Fields

func (Fields) Execute

func (fields Fields) Execute(confSvc ConfigurationService, parentPath string, varStack map[string]string, objStack map[string]interface{}, baseConfigStack map[string]string, stringTemplateCache map[string]template.Template, workflowRepo repos.IRepo) (err error)

type GenericWrapper

type GenericWrapper struct {
	Getter GetterFunc
	Setter SetterFunc
}

func (*GenericWrapper) Get

func (t *GenericWrapper) Get() string

func (*GenericWrapper) Set

func (t *GenericWrapper) Set(value string)

type GetConfigFunc

type GetConfigFunc func(string) string

type GetMultiVarConfigFunc

type GetMultiVarConfigFunc func(string, string) string

type GetterFunc

type GetterFunc func() string

type MultiVarConfigAccessFuncs

type MultiVarConfigAccessFuncs map[string]GetMultiVarConfigFunc

func MakeConfigAccessFuncsMultiVar

func MakeConfigAccessFuncsMultiVar(confSvc ConfigurationService, varStack map[string]string) MultiVarConfigAccessFuncs

type PointerWrapper

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

func (*PointerWrapper) Get

func (t *PointerWrapper) Get() string

func (*PointerWrapper) Set

func (t *PointerWrapper) Set(value string)

type RoleDisabledError

type RoleDisabledError struct {
	RolePath string
}

func (*RoleDisabledError) Error

func (e *RoleDisabledError) Error() string

type Sequence

type Sequence map[Stage]Fields

func (Sequence) Execute

func (sf Sequence) Execute(confSvc ConfigurationService,
	parentPath string,
	varStack VarStack,
	buildObjectStack BuildObjectStackFunc,
	baseConfigStack map[string]string,
	stringTemplateCache map[string]template.Template,
	workflowRepo repos.IRepo,
	stageCallback StageCallbackFunc) (err error)

type SetterFunc

type SetterFunc func(value string)

type Stage

type Stage int

const (
	// RESOLUTION STAGE ↓      VALUES AVAILABLE ↓
	STAGE0 Stage = iota // parent stack only (for enabled)
	STAGE1              // parent stack only                         + locals
	STAGE2              // parent stack + defaults                   + locals
	STAGE3              // parent stack + defaults + vars            + locals
	STAGE4              // parent stack + defaults + vars + uservars + locals
	STAGE5              // parent stack + defaults + vars + uservars + locals + full self-object = full stack

)

type StageCallbackFunc

type StageCallbackFunc func(stage Stage, err error) error // called after each stage template processing, if err != nil the sequence bails

type ToPtreeFunc

type ToPtreeFunc func(string, string) string

func MakeToPtreeFunc

func MakeToPtreeFunc(varStack map[string]string, propMap map[string]string) ToPtreeFunc

type VarStack

type VarStack struct {
	Locals   map[string]string
	Defaults *gera.StringWrapMap
	Vars     *gera.StringWrapMap
	UserVars *gera.StringWrapMap
}