templates

Documentation

Index

• Constants
• func AddAmazonEKSPath(name string, path string)
• func AddAzureAKSPath(name string, path string)
• func AddGoogleGKEPath(name string, path string)
• func BuildDir(buildPath string, fs *afero.Afero, builder *Builder) error
• 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) (*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 BuilderBuilder
  • func NewBuilderBuilder(logger log.Logger, v *viper.Viper, m state.Manager) *BuilderBuilder
  • func (bb *BuilderBuilder) BaseBuilder(meta api.ReleaseMetadata) (*Builder, error)
  • func (bb *BuilderBuilder) FullBuilder(meta api.ReleaseMetadata, configGroups []libyaml.ConfigGroup, ...) (*Builder, error)
  • func (bb *BuilderBuilder) NewBuilder(ctxx ...Ctx) Builder
  • func (bb *BuilderBuilder) NewConfigContext(configGroups []libyaml.ConfigGroup, templateContext map[string]interface{}) (*ConfigCtx, error)
  • func (bb *BuilderBuilder) NewShipContext() (*ShipContext, error)
  • func (bb *BuilderBuilder) NewStaticContext() *StaticCtx
• type ConfigCtx
  • func (ctx ConfigCtx) FuncMap() template.FuncMap
• type Ctx
• type InstallationContext
  • func (ctx *InstallationContext) FuncMap() template.FuncMap
• type ShipContext
  • func (ctx ShipContext) FuncMap() template.FuncMap
• type StaticCtx
  • func NewStaticContext() *StaticCtx
  • func (ctx StaticCtx) FuncMap() template.FuncMap
  • func (ctx *StaticCtx) RandomString(length uint64, providedCharset ...string) string

Constants

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

Functions

func AddAmazonEKSPath

func AddAmazonEKSPath(name string, path string)

AddAmazonEKSPath adds a kubeconfig path to the cache

func AddAzureAKSPath

func AddAzureAKSPath(name string, path string)

AddAzureAKSPath adds a kubeconfig path to the cache

func AddGoogleGKEPath

func AddGoogleGKEPath(name string, path string)

AddGoogleGKEPath adds a kubeconfig path to the cache

func BuildDir

func BuildDir(buildPath string, fs *afero.Afero, builder *Builder) error

Types

type Builder

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

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) (*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 BuilderBuilder

type BuilderBuilder struct {
	Logger  log.Logger
	Viper   *viper.Viper
	Manager state.Manager
}

func NewBuilderBuilder

func NewBuilderBuilder(logger log.Logger, v *viper.Viper, m state.Manager) *BuilderBuilder

func (*BuilderBuilder) BaseBuilder

func (bb *BuilderBuilder) BaseBuilder(
	meta api.ReleaseMetadata,
) (*Builder, error)

func (*BuilderBuilder) FullBuilder

func (bb *BuilderBuilder) FullBuilder(
	meta api.ReleaseMetadata,
	configGroups []libyaml.ConfigGroup,
	config map[string]interface{},
) (*Builder, error)

func (*BuilderBuilder) NewBuilder

func (bb *BuilderBuilder) NewBuilder(ctxx ...Ctx) Builder

func (*BuilderBuilder) NewConfigContext

func (bb *BuilderBuilder) NewConfigContext(configGroups []libyaml.ConfigGroup, templateContext map[string]interface{}) (*ConfigCtx, error)

func (*BuilderBuilder) NewShipContext

func (bb *BuilderBuilder) NewShipContext() (*ShipContext, error)

func (*BuilderBuilder) NewStaticContext

func (bb *BuilderBuilder) NewStaticContext() *StaticCtx

type ConfigCtx

type ConfigCtx struct {
	ItemValues map[string]interface{}
	Logger     log.Logger
}

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 InstallationContext

type InstallationContext struct {
	Meta   api.ReleaseMetadata
	Viper  *viper.Viper
	Logger log.Logger
}

func (*InstallationContext) FuncMap

func (ctx *InstallationContext) FuncMap() template.FuncMap

type ShipContext

type ShipContext struct {
	Logger  log.Logger
	Manager state.Manager
}

ShipContext is the context for builder functions that depend on what assets have been created.

func (ShipContext) FuncMap

func (ctx ShipContext) FuncMap() template.FuncMap

FuncMap represents the available functions in the ShipCtx.

type StaticCtx

type StaticCtx struct {
	Logger log.Logger
}

func NewStaticContext

func NewStaticContext() *StaticCtx

deprecated

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