helm

Documentation

Index

• Constants
• func CreateChartForResource(r *scaffold.Resource, projectDir string) error
• type Dockerfile
  • func (d *Dockerfile) GetInput() (input.Input, error)
• type DockerfileHybrid
  • func (d *DockerfileHybrid) GetInput() (input.Input, error)
• type Entrypoint
  • func (e *Entrypoint) GetInput() (input.Input, error)
• type GopkgToml
  • func (s *GopkgToml) GetInput() (input.Input, error)
• type Main
  • func (m *Main) GetInput() (input.Input, error)
• type Operator
  • func (s *Operator) GetInput() (input.Input, error)
• type UserSetup
  • func (u *UserSetup) GetInput() (input.Input, error)
• type WatchesYAML
  • func (s *WatchesYAML) GetInput() (input.Input, error)

Constants

const HelmChartsDir string = "helm-charts"

HelmChartsDir is the relative directory within an SDK project where Helm charts are stored.

const WatchesYamlFile = "watches.yaml"

Functions

func CreateChartForResource

func CreateChartForResource(r *scaffold.Resource, projectDir string) error

CreateChartForResource creates a new helm chart in the SDK project for the provided resource.

Types

type Dockerfile

type Dockerfile struct {
	input.Input

	HelmChartsDir string
	ImageTag      string
}

Dockerfile specifies the Helm Dockerfile scaffold

func (*Dockerfile) GetInput

func (d *Dockerfile) GetInput() (input.Input, error)

GetInput gets the scaffold execution input

type DockerfileHybrid

type DockerfileHybrid struct {
	input.Input

	// HelmCharts - if true, include a COPY statement for the helm-charts directory
	HelmCharts bool

	// Watches - if true, include a COPY statement for watches.yaml
	Watches bool
}

DockerfileHybrid - Dockerfile for a hybrid operator

func (*DockerfileHybrid) GetInput

func (d *DockerfileHybrid) GetInput() (input.Input, error)

GetInput - gets the input

type Entrypoint

type Entrypoint struct {
	input.Input
}

Entrypoint - entrypoint script

func (*Entrypoint) GetInput

func (e *Entrypoint) GetInput() (input.Input, error)

type GopkgToml

type GopkgToml struct {
	input.Input
}

GopkgToml - the Gopkg.toml file for a hybrid operator

func (*GopkgToml) GetInput

func (s *GopkgToml) GetInput() (input.Input, error)

type Main

type Main struct {
	input.Input
}

Main - main source file for helm operator

func (*Main) GetInput

func (m *Main) GetInput() (input.Input, error)

type Operator

type Operator struct {
	input.Input

	IsClusterScoped bool
}

Operator specifies the Helm operator.yaml manifest scaffold

func (*Operator) GetInput

func (s *Operator) GetInput() (input.Input, error)

GetInput gets the scaffold execution input

type UserSetup

type UserSetup struct {
	input.Input
}

UserSetup - userSetup script

func (*UserSetup) GetInput

func (u *UserSetup) GetInput() (input.Input, error)

type WatchesYAML

type WatchesYAML struct {
	input.Input

	Resource      *scaffold.Resource
	HelmChartsDir string
}

WatchesYAML specifies the Helm watches.yaml manifest scaffold

func (*WatchesYAML) GetInput

func (s *WatchesYAML) GetInput() (input.Input, error)

GetInput gets the scaffold execution input