helm

package
v1.31.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 30, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package helm provides a Helm chart deployer implementation.

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrNotHelmDeployer is returned when attempting to operate on a non-Helm deployer.
	ErrNotHelmDeployer = errors.New("deployer is not a Helm deployer")

	// ErrRepositoryNotFound is returned when a repository referenced by a deployer is not found.
	ErrRepositoryNotFound = errors.New("repository not found")

	// ErrValuesFileNotFound is returned when a referenced values file doesn't exist.
	ErrValuesFileNotFound = errors.New("values file not found")

	// ErrDynamicOverridesNotImplemented is returned when dynamic overrides are configured but not yet supported.
	ErrDynamicOverridesNotImplemented = errors.New("dynamic overrides are not yet implemented")

	// ErrUnknownDynamicOverrideType is returned when an unknown dynamic override type is encountered.
	ErrUnknownDynamicOverrideType = errors.New("unknown dynamic override type")

	// ErrMissingGitLabSourceRepo is returned when gitlab_source_repo is missing or doesn't exist.
	ErrMissingGitLabSourceRepo = errors.New("gitlab_source_repo is required or not found")

	// ErrMissingVersionMap is returned when version_map is missing or doesn't exist.
	ErrMissingVersionMap = errors.New("version_map is required or not found")

	// ErrEmptyVersionMap is returned when the version_map is empty.
	ErrEmptyVersionMap = errors.New("version_map is empty")
)

Functions

This section is empty.

Types

type DynamicOverrider added in v1.29.0

type DynamicOverrider interface {
	GetArgs(override v2.DynamicOverrideConfig, caproniConfig *v2.CaproniConfig) ([]string, error)
}

type Manager

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

Manager implements deployer.Manager for Helm chart deployers.

func NewManager

func NewManager(backend helm.Backend) *Manager

NewManager creates a new Helm deployer manager.

func (*Manager) Deploy

func (m *Manager) Deploy(ctx context.Context, deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) error

Deploy deploys the Helm chart to the cluster. If the chart is already deployed, this upgrades it to match the current configuration.

func (*Manager) Status

func (m *Manager) Status(ctx context.Context, deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) (*deployer.Status, error)

Status returns the current status of the Helm chart deployment.

func (*Manager) Type

func (m *Manager) Type() string

Type returns the deployer type that this manager handles.

func (*Manager) Undeploy

func (m *Manager) Undeploy(ctx context.Context, deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) error

Undeploy removes the Helm chart from the cluster.

func (*Manager) Validate

func (m *Manager) Validate(deployerConfig *v2.DeployerConfig, caproniConfig *v2.CaproniConfig) error

Validate validates the helm deployer configuration and referenced files.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL