release

Documentation

Overview

Package release allows to manage helm releases.

Index

• type Config
  • func (r *Config) New() (Release, error)
  • func (r *Config) Validate() error
• type Release
  • func FromYaml(data []byte) (Release, error)

Types

type Config

type Config struct {

	// Kubeconfig is content of kubeconfig file in YAML format, which will be used to authenticate
	// to the cluster and create a release.
	Kubeconfig string `json:"kubeconfig,omitempty"`

	// Namespace is a namespace, where helm release will be created and all it's resources.
	Namespace string `json:"namespace,omitempty"`

	// Name is a name of the release used to identify it.
	Name string `json:"name,omitempty"`

	// Chart is a location of the chart. It may be local path or remote chart in user repository.
	Chart string `json:"chart,omitempty"`

	// Values is a chart values in YAML format.
	Values string `json:"values,omitempty"`

	// Version is a requested version of the chart.
	Version string `json:"version,omitempty"`
}

Config represents user-configured Helm release.

func (*Config) New

func (r *Config) New() (Release, error)

New validates release configuration and builts installable version of it.

func (*Config) Validate

func (r *Config) Validate() error

Validate validates Release configuration.

type Release

type Release interface {
	ValidateChart() error
	Install() error
	Upgrade() error
	InstallOrUpgrade() error
	Exists() (bool, error)
	Uninstall() error
}

Release is an interface representing helm release.

func FromYaml

func FromYaml(data []byte) (Release, error)

FromYaml allows to quickly create new release object from serialized representation.