template

Documentation

Index

• Constants
• func GetEnvVars(prefix string) map[string]string
• func IsTemplate(data string) bool
• type RenderType
  • func ParseRenderType(item string) (RenderType, error)
• type TemplateData
  • func CollectTemplatingData(constants map[string]interface{}, variables []VariableConfig, ...) (*TemplateData, error)
  • func NewTemplateData() *TemplateData
• type TemplateRenderer
  • func NewTemplateRenderer(templateData *TemplateData) *TemplateRenderer
  • func (r *TemplateRenderer) ExecuteConstTemplate(templateString string) ([]byte, error)
  • func (r *TemplateRenderer) ExecuteFullTemplate(templateString string) ([]byte, error)
  • func (r *TemplateRenderer) ExecuteMaskedTemplate(templateString string) ([]byte, error)
  • func (r *TemplateRenderer) ExecuteNonSensitiveTemplate(templateString string) ([]byte, error)
  • func (r *TemplateRenderer) Render(templateString string, t RenderType) ([]byte, error)
• type VariableConfig

Constants

const (
	PREFIX = "LULA_VAR_"
	CONST  = "const"
	VAR    = "var"
)

Functions

func GetEnvVars

func GetEnvVars(prefix string) map[string]string

get all environment variables with the established prefix

func IsTemplate

func IsTemplate(data string) bool

IsTemplate checks if the given string contains valid template syntax

Types

type RenderType

type RenderType string

const (
	MASKED       RenderType = "masked"
	CONSTANTS    RenderType = "constants"
	NONSENSITIVE RenderType = "non-sensitive"
	ALL          RenderType = "all"
)

func ParseRenderType

func ParseRenderType(item string) (RenderType, error)

type TemplateData

type TemplateData struct {
	Constants          map[string]interface{}
	Variables          map[string]string
	SensitiveVariables map[string]string
}

func CollectTemplatingData

func CollectTemplatingData(constants map[string]interface{}, variables []VariableConfig, overrides map[string]string) (*TemplateData, error)

Prepare the templateData object for use in templating

func NewTemplateData

func NewTemplateData() *TemplateData

type TemplateRenderer

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

func NewTemplateRenderer

func NewTemplateRenderer(templateData *TemplateData) *TemplateRenderer

func (*TemplateRenderer) ExecuteConstTemplate

func (r *TemplateRenderer) ExecuteConstTemplate(templateString string) ([]byte, error)

ExecuteConstTemplate templates only constants this templates only values in the constants map

func (*TemplateRenderer) ExecuteFullTemplate

func (r *TemplateRenderer) ExecuteFullTemplate(templateString string) ([]byte, error)

ExecuteFullTemplate templates everything

func (*TemplateRenderer) ExecuteMaskedTemplate

func (r *TemplateRenderer) ExecuteMaskedTemplate(templateString string) ([]byte, error)

ExecuteMaskedTemplate templates all values, but masks the sensitive ones for display/printing only

func (*TemplateRenderer) ExecuteNonSensitiveTemplate

func (r *TemplateRenderer) ExecuteNonSensitiveTemplate(templateString string) ([]byte, error)

ExecuteNonSensitiveTemplate templates only constants and non-sensitive variables used for compose operations

func (*TemplateRenderer) Render

func (r *TemplateRenderer) Render(templateString string, t RenderType) ([]byte, error)

type VariableConfig

type VariableConfig struct {
	Key       string
	Default   string
	Sensitive bool
}