template

Documentation

Index

• Constants
• type Builder
  • func (b *Builder) AddCtx(ctx Ctx)
  • func (b *Builder) Bool(text string, defaultVal bool) (bool, error)
  • func (b *Builder) BuildFuncMap() template.FuncMap
  • func (b *Builder) Float64(text string, defaultVal float64) (float64, error)
  • func (b *Builder) GetTemplate(name, text string, rdelim, ldelim string) (*template.Template, error)
  • func (b *Builder) Int(text string, defaultVal int64) (int64, error)
  • func (b *Builder) NewConfigContext(configGroups []kotsv1beta1.ConfigGroup, existingValues map[string]ItemValue, ...) (*ConfigCtx, error)
  • func (b *Builder) RenderTemplate(name string, text string) (string, error)
  • func (b *Builder) String(text string) (string, error)
  • func (b *Builder) Uint(text string, defaultVal uint64) (uint64, error)
• type ConfigCtx
  • func (ctx ConfigCtx) FuncMap() template.FuncMap
• type Ctx
• type ItemValue
  • func (i ItemValue) DefaultStr() string
  • func (i ItemValue) HasDefault() bool
  • func (i ItemValue) HasValue() bool
  • func (i ItemValue) ValueStr() string
• type LicenseCtx
  • func (ctx LicenseCtx) FuncMap() template.FuncMap
• type LocalRegistry
• type StaticCtx
  • func (ctx StaticCtx) FuncMap() template.FuncMap
  • func (ctx *StaticCtx) RandomString(length uint64, providedCharset ...string) string

Constants

const (
	DefaultCharset = "[_A-Za-z0-9]"
)

Types

type Builder

type Builder struct {
	Ctx    []Ctx
	Functs template.FuncMap
}

func (*Builder) AddCtx

func (b *Builder) AddCtx(ctx Ctx)

func (*Builder) Bool

func (b *Builder) Bool(text string, defaultVal bool) (bool, error)

func (*Builder) BuildFuncMap

func (b *Builder) BuildFuncMap() template.FuncMap

func (*Builder) Float64

func (b *Builder) Float64(text string, defaultVal float64) (float64, error)

func (*Builder) GetTemplate

func (b *Builder) GetTemplate(name, text string, rdelim, ldelim string) (*template.Template, error)

func (*Builder) Int

func (b *Builder) Int(text string, defaultVal int64) (int64, error)

func (*Builder) NewConfigContext

func (b *Builder) NewConfigContext(configGroups []kotsv1beta1.ConfigGroup, existingValues map[string]ItemValue, localRegistry LocalRegistry, cipher *crypto.AESCipher) (*ConfigCtx, error)

NewConfigContext creates and returns a context for template rendering

func (*Builder) RenderTemplate

func (b *Builder) RenderTemplate(name string, text string) (string, error)

func (*Builder) String

func (b *Builder) String(text string) (string, error)

func (*Builder) Uint

func (b *Builder) Uint(text string, defaultVal uint64) (uint64, error)

type ConfigCtx

type ConfigCtx struct {
	ItemValues    map[string]ItemValue
	LocalRegistry LocalRegistry
}

ConfigCtx is the context for builder functions before the application has started.

func (ConfigCtx) FuncMap

func (ctx ConfigCtx) FuncMap() template.FuncMap

FuncMap represents the available functions in the ConfigCtx.

type Ctx

type Ctx interface {
	FuncMap() template.FuncMap
}

type ItemValue

type ItemValue struct {
	Value   interface{}
	Default interface{}
}

func (ItemValue) DefaultStr

func (i ItemValue) DefaultStr() string

func (ItemValue) HasDefault

func (i ItemValue) HasDefault() bool

func (ItemValue) HasValue

func (i ItemValue) HasValue() bool

func (ItemValue) ValueStr

func (i ItemValue) ValueStr() string

type LicenseCtx

type LicenseCtx struct {
	License *kotsv1beta1.License
}

func (LicenseCtx) FuncMap

func (ctx LicenseCtx) FuncMap() template.FuncMap

FuncMap represents the available functions in the LicenseCtx.

type LocalRegistry

type LocalRegistry struct {
	Host      string
	Namespace string
	Username  string
	Password  string
}

type StaticCtx

type StaticCtx struct {
}

func (StaticCtx) FuncMap

func (ctx StaticCtx) FuncMap() template.FuncMap

func (*StaticCtx) RandomString

func (ctx *StaticCtx) RandomString(length uint64, providedCharset ...string) string

stolen from https://github.com/replicatedhq/replicated/blob/8ce3ed40436e38b8089387d103623dbe09bbf1c0/pkg/commands/random.go#L22