template

Documentation

Index

• type Factory
  • func NewFactory(coreClient kubernetes.Interface, fetchFactory fetch.Factory, ...) Factory
  • func (f Factory) NewCue(opts v1alpha1.AppTemplateCue, genericOpts GenericOpts) Template
  • func (f Factory) NewHelmTemplate(opts v1alpha1.AppTemplateHelmTemplate, genericOpts GenericOpts) *HelmTemplate
  • func (f Factory) NewKbld(opts v1alpha1.AppTemplateKbld, genericOpts GenericOpts) *Kbld
  • func (f Factory) NewSops(opts v1alpha1.AppTemplateSops, genericOpts GenericOpts) *Sops
  • func (f Factory) NewYtt(opts v1alpha1.AppTemplateYtt, genericOpts GenericOpts) *Ytt
• type GenericOpts
• type HelmTemplate
  • func NewHelmTemplate(opts v1alpha1.AppTemplateHelmTemplate, genericOpts GenericOpts, ...) *HelmTemplate
  • func (t *HelmTemplate) TemplateDir(dirPath string) (exec.CmdRunResult, bool)
  • func (t *HelmTemplate) TemplateStream(stream io.Reader, dirPath string) exec.CmdRunResult
• type HelmTemplateCmdArgs
• type Kbld
  • func NewKbld(opts v1alpha1.AppTemplateKbld, genericOpts GenericOpts, ...) *Kbld
  • func (t *Kbld) TemplateDir(dirPath string) (exec.CmdRunResult, bool)
  • func (t *Kbld) TemplateStream(input io.Reader, dirPath string) exec.CmdRunResult
• type KbldOpts
• type Sops
  • func NewSops(opts v1alpha1.AppTemplateSops, genericOpts GenericOpts, ...) *Sops
  • func (t *Sops) TemplateDir(dirPath string) (exec.CmdRunResult, bool)
  • func (t *Sops) TemplateStream(input io.Reader, dirPath string) exec.CmdRunResult
• type Template
• type Values
  • func (t Values) AsPaths(dirPath string) ([]string, func(), error)
• type Ytt
  • func NewYtt(opts v1alpha1.AppTemplateYtt, genericOpts GenericOpts, ...) *Ytt
  • func (t *Ytt) TemplateDir(dirPath string) (exec.CmdRunResult, bool)
  • func (t *Ytt) TemplateStream(input io.Reader, dirPath string) exec.CmdRunResult

Types

type Factory

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

Factory allows to build various templaters e.g. ytt, cue.

func NewFactory

func NewFactory(coreClient kubernetes.Interface, fetchFactory fetch.Factory,
	kbldAllowBuild bool, cmdRunner exec.CmdRunner) Factory

NewFactory returns template factory.

func (Factory) NewCue

func (f Factory) NewCue(opts v1alpha1.AppTemplateCue, genericOpts GenericOpts) Template

NewCue returns a Cue templater

func (Factory) NewHelmTemplate

func (f Factory) NewHelmTemplate(
	opts v1alpha1.AppTemplateHelmTemplate, genericOpts GenericOpts) *HelmTemplate

func (Factory) NewKbld

func (f Factory) NewKbld(opts v1alpha1.AppTemplateKbld, genericOpts GenericOpts) *Kbld

func (Factory) NewSops

func (f Factory) NewSops(
	opts v1alpha1.AppTemplateSops, genericOpts GenericOpts) *Sops

func (Factory) NewYtt

func (f Factory) NewYtt(opts v1alpha1.AppTemplateYtt, genericOpts GenericOpts) *Ytt

type GenericOpts

type GenericOpts struct {
	Name      string
	Namespace string
}

type HelmTemplate

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

func NewHelmTemplate

func NewHelmTemplate(opts v1alpha1.AppTemplateHelmTemplate,
	genericOpts GenericOpts, coreClient kubernetes.Interface,
	cmdRunner exec.CmdRunner) *HelmTemplate

func (*HelmTemplate) TemplateDir

func (t *HelmTemplate) TemplateDir(dirPath string) (exec.CmdRunResult, bool)

func (*HelmTemplate) TemplateStream

func (t *HelmTemplate) TemplateStream(stream io.Reader, dirPath string) exec.CmdRunResult

TemplateStream works on a stream returning templating result. dirPath is provided for context from which to reference additional inputs.

type HelmTemplateCmdArgs

type HelmTemplateCmdArgs struct {
	BinaryName string
	Args       []string
}

HelmTemplateCmdArgs represents the binary and arguments used during templating

type Kbld

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

Kbld executes kbld tool.

func NewKbld

func NewKbld(opts v1alpha1.AppTemplateKbld,
	genericOpts GenericOpts, additionalOpts KbldOpts,
	cmdRunner exec.CmdRunner) *Kbld

NewKbld returns kbld.

func (*Kbld) TemplateDir

func (t *Kbld) TemplateDir(dirPath string) (exec.CmdRunResult, bool)

func (*Kbld) TemplateStream

func (t *Kbld) TemplateStream(input io.Reader, dirPath string) exec.CmdRunResult

type KbldOpts

type KbldOpts struct {
	// Do not want to allow building within kapp-controller pod
	AllowBuild bool
}

KbldOpts allows to configure kbld execution.

type Sops

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

Sops executes sops tool to decrypt configuration. Currently supports age and gpg as its decryption backends.

func NewSops

func NewSops(opts v1alpha1.AppTemplateSops, genericOpts GenericOpts,
	coreClient kubernetes.Interface, cmdRunner exec.CmdRunner) *Sops

NewSops returns sops.

func (*Sops) TemplateDir

func (t *Sops) TemplateDir(dirPath string) (exec.CmdRunResult, bool)

func (*Sops) TemplateStream

func (t *Sops) TemplateStream(input io.Reader, dirPath string) exec.CmdRunResult

type Template

type Template interface {
	// TemplateDir works on directory returning templating result,
	// and boolean indicating whether subsequent operations
	// should operate on result, or continue operating on the directory
	TemplateDir(dirPath string) (exec.CmdRunResult, bool)
	// TemplateStream works on a stream returning templating result.
	// dirPath is provided for context from which to reference additional inputs.
	TemplateStream(stream io.Reader, dirPath string) exec.CmdRunResult
}

type Values

type Values struct {
	ValuesFrom []v1alpha1.AppTemplateValuesSource
	// contains filtered or unexported fields
}

func (Values) AsPaths

func (t Values) AsPaths(dirPath string) ([]string, func(), error)

type Ytt

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

func NewYtt

func NewYtt(opts v1alpha1.AppTemplateYtt, genericOpts GenericOpts,
	coreClient kubernetes.Interface, fetchFactory fetch.Factory, cmdRunner exec.CmdRunner) *Ytt

func (*Ytt) TemplateDir

func (t *Ytt) TemplateDir(dirPath string) (exec.CmdRunResult, bool)

func (*Ytt) TemplateStream

func (t *Ytt) TemplateStream(input io.Reader, dirPath string) exec.CmdRunResult