helm

Documentation

Overview

Package helm implements support for Helm plugin, which can deploy Helm charts onto k8s clusters via Helm API.

Index

• func New(clusterPlugin plugin.ClusterPlugin, cfg config.Plugins) (plugin.CodePlugin, error)
• type ClusterConfig
• type Plugin
  • func (p *Plugin) Cleanup() error
  • func (p *Plugin) Create(deployName string, params util.NestedParameterMap, eventLog *event.Log) error
  • func (p *Plugin) Destroy(deployName string, params util.NestedParameterMap, eventLog *event.Log) error
  • func (p *Plugin) Endpoints(deployName string, params util.NestedParameterMap, eventLog *event.Log) (map[string]string, error)
  • func (p *Plugin) Resources(deployName string, params util.NestedParameterMap, eventLog *event.Log) (plugin.Resources, error)
  • func (p *Plugin) Update(deployName string, params util.NestedParameterMap, eventLog *event.Log) error

Functions

func New

func New(clusterPlugin plugin.ClusterPlugin, cfg config.Plugins) (plugin.CodePlugin, error)

New returns new instance of the Helm code plugin for specified Kubernetes cluster plugin and plugins config

Types

type ClusterConfig

type ClusterConfig struct {
	TillerNamespace string `yaml:",omitempty"`
}

ClusterConfig represents Kubernetes cluster configuration specific for Helm plugin

type Plugin

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

Plugin represents Helm code plugin for Kubernetes cluster

func (*Plugin) Cleanup

func (p *Plugin) Cleanup() error

Cleanup implements cleanup phase for the Helm plugin. It closes cached Tiller tunnel.

func (*Plugin) Create

func (p *Plugin) Create(deployName string, params util.NestedParameterMap, eventLog *event.Log) error

Create implements creation of a new component instance in the cloud by deploying a Helm chart

func (*Plugin) Destroy

func (p *Plugin) Destroy(deployName string, params util.NestedParameterMap, eventLog *event.Log) error

Destroy implements destruction of an existing component instance in the cloud by running "helm delete" on the corresponding helm chart

func (*Plugin) Endpoints

func (p *Plugin) Endpoints(deployName string, params util.NestedParameterMap, eventLog *event.Log) (map[string]string, error)

Endpoints returns map from port type to url for all services of the current chart

func (*Plugin) Resources

func (p *Plugin) Resources(deployName string, params util.NestedParameterMap, eventLog *event.Log) (plugin.Resources, error)

Resources returns list of all resources (like services, config maps, etc.) into the cluster by specified component instance

func (*Plugin) Update

func (p *Plugin) Update(deployName string, params util.NestedParameterMap, eventLog *event.Log) error

Update implements update of an existing component instance in the cloud by updating parameters of a helm chart