template

Documentation

Index

• Constants
• type ApplicationInfo
• type Builder
  • func NewBuilder(opts BuilderOptions) (Builder, map[string]ItemValue, error)
  • 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) 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 BuilderOptions
• 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 LocalRegistry
• type StaticCtx
  • func (ctx StaticCtx) FuncMap() template.FuncMap
  • func (ctx *StaticCtx) RandomBytes(length uint64) string
  • func (ctx *StaticCtx) RandomString(length uint64, providedCharset ...string) string
• type TLSPair
• type VersionInfo
  • func VersionInfoFromInstallation(sequence int64, isAirgap bool, spec v1beta1.InstallationSpec) VersionInfo

Constants

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

Types

type ApplicationInfo

type ApplicationInfo struct {
	Slug string
}

type Builder

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

func NewBuilder

func NewBuilder(opts BuilderOptions) (Builder, map[string]ItemValue, error)

NewBuilder creates a builder with all available contexts.

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) 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 BuilderOptions

type BuilderOptions struct {
	ConfigGroups    []kotsv1beta1.ConfigGroup
	ExistingValues  map[string]ItemValue
	LocalRegistry   LocalRegistry
	Cipher          *crypto.AESCipher
	License         *kotsv1beta1.License
	ApplicationInfo *ApplicationInfo
	VersionInfo     *VersionInfo
	IdentityConfig  *kotsv1beta1.IdentityConfig
}

type ConfigCtx

type ConfigCtx struct {
	ItemValues    map[string]ItemValue
	LocalRegistry LocalRegistry
	// contains filtered or unexported fields
}

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 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) RandomBytes

func (ctx *StaticCtx) RandomBytes(length uint64) string

RandomBytes returns a base64-encoded byte array allowing the full range of byte values.

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

type TLSPair

type TLSPair struct {
	Cert string
	Key  string
	Cn   string
}

type VersionInfo

type VersionInfo struct {
	Sequence     int64  // the installation sequence. Always 0 when being freshly installed, etc
	Cursor       string // the upstream version cursor - integers for kots apps, may be semvers for helm charts
	ChannelName  string // the name of the channel that the current version was from (kots apps only)
	VersionLabel string // a pretty version label if provided (kots apps only)
	ReleaseNotes string // the release notes for the given version (kots apps only)
	IsAirgap     bool   // is this an airgap app (kots apps only)
}

func VersionInfoFromInstallation

func VersionInfoFromInstallation(sequence int64, isAirgap bool, spec v1beta1.InstallationSpec) VersionInfo