helm

package

v1.15.0 Latest Latest Go to latest Published: Sep 10, 2026 License: AGPL-3.0 Imports: 21 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudogu/k8s-component-operator

Links

Open Source Insights

Documentation ¶

Index ¶

func GetHelmChartName(c *componentV1.Component) string
func GetHelmChartSpec(ctx context.Context, c *componentV1.Component, opts ...HelmChartCreationOpts) (*client.ChartSpec, error)
type ChartGetter
type Client
- func NewClient(namespace string, helmRepoData *config.HelmRepositoryData, debug bool, ...) (*Client, error)
type ClientFactory
- func NewClientFactory(namespace string, helmRepoData *config.HelmRepositoryData, debug bool, ...) *ClientFactory
- func (f *ClientFactory) NewHelmClient() (*Client, error)
type Dependency
type HelmChartCreationOpts
type HelmClient
type Mapping
type MetaValue
type MetadataMapping

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetHelmChartName ¶ added in v1.11.0

func GetHelmChartName(c *componentV1.Component) string

func GetHelmChartSpec ¶ added in v1.11.0

func GetHelmChartSpec(ctx context.Context, c *componentV1.Component, opts ...HelmChartCreationOpts) (*client.ChartSpec, error)

GetHelmChartSpec returns the helm chart for the component cr without custom values.

Types ¶

type ChartGetter ¶ added in v1.11.0

type ChartGetter interface {
	GetChart(ctx context.Context, spec *client.ChartSpec) (*chart.Chart, error)
}

type Client ¶

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

Client wraps the HelmClient with config.HelmRepositoryData

func NewClient ¶

func NewClient(namespace string, helmRepoData *config.HelmRepositoryData, debug bool, debugLog action.DebugLog, chartCache client.ChartCache) (*Client, error)

NewClient create a new instance of the helm client.

func (*Client) GetChart ¶ added in v1.10.0

func (c *Client) GetChart(ctx context.Context, spec *client.ChartSpec) (*chart.Chart, error)

func (*Client) GetChartSpecValues ¶ added in v0.6.0

func (c *Client) GetChartSpecValues(spec *client.ChartSpec) (map[string]interface{}, error)

GetChartSpecValues returns the additional values for the specified ChartSpec.

func (*Client) GetDeployedReleaseVersion ¶ added in v1.0.0

func (c *Client) GetDeployedReleaseVersion(ctx context.Context, name string) (string, error)

GetDeployedReleaseVersion returns the version for the specified release (if the release exists).

func (*Client) GetLatestVersion ¶ added in v1.6.0

func (c *Client) GetLatestVersion(chartName string) (string, error)

func (*Client) GetRelease ¶ added in v1.14.1

func (c *Client) GetRelease(name string) (*release.Release, error)

func (*Client) GetReleaseValues ¶ added in v0.6.0

func (c *Client) GetReleaseValues(name string, allValues bool) (map[string]interface{}, error)

GetReleaseValues returns the (optionally, all computed) values for the specified release.

func (*Client) InstallOrUpgrade ¶

func (c *Client) InstallOrUpgrade(ctx context.Context, chart *client.ChartSpec) error

InstallOrUpgrade takes a helmChart and applies it.

func (*Client) ListDeployedReleases ¶

func (c *Client) ListDeployedReleases() ([]*release.Release, error)

ListDeployedReleases returns all deployed helm releases

func (*Client) ListReleasesByStateMask ¶ added in v1.14.1

func (c *Client) ListReleasesByStateMask(states action.ListStates) ([]*release.Release, error)

func (*Client) MarkReleaseAsFailed ¶ added in v1.14.1

func (c *Client) MarkReleaseAsFailed(name string, reason string) error

func (*Client) SatisfiesDependencies ¶ added in v0.1.0

func (c *Client) SatisfiesDependencies(ctx context.Context, chart *client.ChartSpec) error

SatisfiesDependencies checks if all dependencies are satisfied in terms of installation and version.

func (*Client) Uninstall ¶

func (c *Client) Uninstall(releaseName string) error

Uninstall removes the helmRelease for the given name

type ClientFactory ¶ added in v1.13.1

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

func NewClientFactory ¶ added in v1.13.1

func NewClientFactory(namespace string, helmRepoData *config.HelmRepositoryData, debug bool, debugLog action.DebugLog, chartCacheSize int) *ClientFactory

NewClientFactory creates a ClientFactory. The chartCacheSize is the maximum number of chart:version entries kept in the shared in-memory chart cache; if it is not positive, chart caching is disabled.

func (*ClientFactory) NewHelmClient ¶ added in v1.13.1

func (f *ClientFactory) NewHelmClient() (*Client, error)

type Dependency ¶ added in v0.3.0

type Dependency struct {
	Name    string
	Version string
}

type HelmChartCreationOpts ¶ added in v1.11.0

type HelmChartCreationOpts struct {
	HelmClient     ChartGetter
	Timeout        time.Duration
	YamlSerializer yaml.Serializer
	Reader         configMapRefReader
}

type HelmClient ¶

type HelmClient interface {
	client.Client
}

HelmClient embeds the client.Client interface for usage in this package.

type Mapping ¶ added in v1.11.0

type Mapping struct {
	Path    string            `yaml:"path"`
	Mapping map[string]string `yaml:"Mapping"`
}

type MetaValue ¶ added in v1.11.0

type MetaValue struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Keys        []Mapping
}

type MetadataMapping ¶ added in v1.11.0

type MetadataMapping struct {
	ApiVersion string               `yaml:"apiVersion"`
	Metavalues map[string]MetaValue `yaml:"metavalues"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
client
values

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