helm

Documentation

Index

• type Client
  • func NewClient(namespace string, helmRepoData *config.HelmRepositoryData, debug bool, ...) (*Client, error)
  • func (c *Client) GetChartSpecValues(spec *client.ChartSpec) (map[string]interface{}, error)
  • func (c *Client) GetDeployedReleaseVersion(ctx context.Context, name string) (string, error)
  • func (c *Client) GetReleaseValues(name string, allValues bool) (map[string]interface{}, error)
  • func (c *Client) InstallOrUpgrade(ctx context.Context, chart *client.ChartSpec) error
  • func (c *Client) ListDeployedReleases() ([]*release.Release, error)
  • func (c *Client) SatisfiesDependencies(ctx context.Context, chart *client.ChartSpec) error
  • func (c *Client) Uninstall(releaseName string) error
• type Dependency
• type HelmClient

Types

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) (*Client, error)

NewClient create a new instance of the helm client.

func (*Client) GetChartSpecValues

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

GetChartSpecValues returns the additional values for the specified ChartSpec.

func (*Client) GetDeployedReleaseVersion

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) GetReleaseValues

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) SatisfiesDependencies

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 Dependency

type Dependency struct {
	Name    string
	Version string
}

type HelmClient

type HelmClient interface {
	client.Client
}

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