helm

Documentation

Index

• Constants
• type Helm
  • func (h *Helm) Process() error
• type HelmRepository
• type Provider
  • func (p *Provider) Changed() (bool, error)
  • func (p *Provider) Create() error
  • func (p *Provider) Destroy() error
  • func (p *Provider) Init(cfg htypes.Resource, l logger.Logger) error
  • func (p *Provider) Lookup() ([]string, error)
  • func (p *Provider) Refresh() error

Constants

const TypeHelm string = "helm"

TypeHelm is the string representation of the ResourceType

Types

type Helm

type Helm struct {
	types.ResourceMetadata `hcl:",remain"`

	Depends []string `hcl:"depends_on,optional" json:"depends,omitempty"`

	Cluster k8s.K8sCluster `hcl:"cluster" json:"cluster"`

	// Optional HelmRepository, if specified will try to download the chart from the give repository
	Repository *HelmRepository `hcl:"repository,block" json:"repository"`

	// name of the chart within the repository or Go Getter reference to download chart from
	Chart string `hcl:"chart" json:"chart"`

	// semver of the chart to install
	Version string `hcl:"version,optional" json:"version,omitempty"`

	Values       string            `hcl:"values,optional" json:"values"`
	ValuesString map[string]string `hcl:"values_string,optional" json:"values_string"`

	// Namespace is the Kubernetes namespace
	Namespace string `hcl:"namespace,optional" json:"namespace,omitempty"`

	// CreateNamespace when set to true Helm will create the namespace before installing
	CreateNamespace bool `hcl:"create_namespace,optional" json:"create_namespace,omitempty"`

	// Skip the install of any CRDs
	SkipCRDs bool `hcl:"skip_crds,optional" json:"skip_crds,omitempty"`

	// Retry the install n number of times
	Retry int `hcl:"retry,optional" json:"retry,omitempty"`

	// Timeout specifies the maximum time a chart can run, default 300s
	Timeout string `hcl:"timeout,optional" json:"timeout"`

	// Define health checks for the pods deployed by the chart
	HealthCheck *healthcheck.HealthCheckKubernetes `hcl:"health_check,block" json:"health_check,omitempty"`
}

Helm defines configuration for running Helm charts

func (*Helm) Process

func (h *Helm) Process() error

type HelmRepository

type HelmRepository struct {
	Name string `hcl:"name" json:"name"`
	URL  string `hcl:"url" json:"url"`
}

type Provider

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

func (*Provider) Changed

func (p *Provider) Changed() (bool, error)

func (*Provider) Create

func (p *Provider) Create() error

Create implements the provider Create method

func (*Provider) Destroy

func (p *Provider) Destroy() error

Destroy implements the provider Destroy method

func (*Provider) Init

func (p *Provider) Init(cfg htypes.Resource, l logger.Logger) error

func (*Provider) Lookup

func (p *Provider) Lookup() ([]string, error)

Lookup implements the provider Lookup method

func (*Provider) Refresh

func (p *Provider) Refresh() error