helm

Documentation

Overview

Package helm contains the epinio-specific core to the helm client libraries. It exposes the functionality to deploy and remove helm charts/releases.

Index

• func Deploy(logger logr.Logger, parameters ChartParameters) error
• func DeployService(logger logr.Logger, parameters ServiceParameters) error
• func GetHelmClient(restConfig *rest.Config, logger logr.Logger, namespace string) (hc.Client, error)
• func Remove(cluster *kubernetes.Cluster, logger logr.Logger, app models.AppRef) error
• func RemoveService(logger logr.Logger, cluster *kubernetes.Cluster, app models.AppRef) error
• func Status(ctx context.Context, logger logr.Logger, cluster *kubernetes.Cluster, ...) (helmrelease.Status, error)
• func ValidateField(key, value string, spec models.AppChartSetting) (interface{}, error)
• func Values(cluster *kubernetes.Cluster, logger logr.Logger, app models.AppRef) ([]byte, error)
• type ChartParameters
• type ConfigParameter
• type ServiceParameters

Functions

func Deploy

func Deploy(logger logr.Logger, parameters ChartParameters) error

func DeployService

func DeployService(logger logr.Logger, parameters ServiceParameters) error

func GetHelmClient

func GetHelmClient(restConfig *rest.Config, logger logr.Logger, namespace string) (hc.Client, error)

func Remove

func Remove(cluster *kubernetes.Cluster, logger logr.Logger, app models.AppRef) error

func RemoveService

func RemoveService(logger logr.Logger, cluster *kubernetes.Cluster, app models.AppRef) error

func Status

func Status(ctx context.Context, logger logr.Logger, cluster *kubernetes.Cluster, namespace, releaseName string) (helmrelease.Status, error)

func ValidateField

func ValidateField(key, value string, spec models.AppChartSetting) (interface{}, error)

validateField checks a single custom value against its declaration.

func Values

func Values(cluster *kubernetes.Cluster, logger logr.Logger, app models.AppRef) ([]byte, error)

Types

type ChartParameters

type ChartParameters struct {
	models.AppRef                        // Application: name & namespace
	Context        context.Context       // Operation context
	Cluster        *kubernetes.Cluster   // Cluster to talk to.
	Chart          string                // Name of Chart CR to use for deployment
	ImageURL       string                // Application Image
	Username       string                // User causing the (re)deployment
	Instances      int32                 // Number Of Desired Replicas
	StageID        string                // Stage ID that produced ImageURL
	Environment    models.EnvVariableMap // App Environment
	Configurations []ConfigParameter     // Bound Configurations (list of names and paths)
	Routes         []string              // Desired application routes
	Domains        domain.DomainMap      // Map of domains with secrets covering them
	Start          *int64                // Nano-epoch of deployment. Optional. Used to force a restart, even when nothing else has changed.
	Settings       models.AppSettings
}

type ConfigParameter

type ConfigParameter struct {
	Name string `yaml:"name"` // Configuration name
	Path string `yaml:"path"` // Mounting path for configuration
}

type ServiceParameters

type ServiceParameters struct {
	models.AppRef                     // Service: name & namespace
	Context       context.Context     // Operation context
	Cluster       *kubernetes.Cluster // Cluster to talk to.
	Chart         string              // Name of helm chart to deploy
	Version       string              // Version of helm chart to deploy
	Repository    string              // Helm repository holding the chart to deploy
	Values        string              // Chart customization (YAML-formatted string)
}