helm

Documentation

Index

• type ChartProvenance
• type HelmConfig
• type VerrazzanoHelmConfig
  • func NewHelmConfig(vzHelper helpers.VZHelper) (*VerrazzanoHelmConfig, error)
  • func (h VerrazzanoHelmConfig) AddAndUpdateChartRepo(chart string, repoURL string) (string, error)
  • func (h VerrazzanoHelmConfig) DownloadChart(chart string, repo string, version string, targetVersion string, ...) error
  • func (h VerrazzanoHelmConfig) GetChartProvenance(chart string, repo string, version string) (*ChartProvenance, error)

Types

type ChartProvenance

type ChartProvenance struct {
	// UpstreamVersion is version of the upstream chart.
	UpstreamVersion string `yaml:"upstreamVersion"`
	// UpstreamChartLocalPath contains relative path to upstream chart directory.
	UpstreamChartLocalPath string `yaml:"upstreamChartLocalPath"`
	// UpstreamIndexEntry is the index.yaml entry for the upstream chart.
	UpstreamIndexEntry *helmrepo.ChartVersion `yaml:"upstreamIndexEntry"`
}

ChartProvenance represents the upstream provenance information about a chart version by reading/creating the helm repository config and cache.

type HelmConfig

type HelmConfig interface {
	AddAndUpdateChartRepo(string, string) (string, error)
	DownloadChart(string, string, string, string, string) error
	GetChartProvenance(string, string, string) (*ChartProvenance, error)
}

HelmConfig represents any helm and related operations done for a helm chart.

type VerrazzanoHelmConfig

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

VerrazzanoHelmConfig is default implementation of HelmConfig.

func NewHelmConfig

func NewHelmConfig(vzHelper helpers.VZHelper) (*VerrazzanoHelmConfig, error)

NewHelmConfig initializes the default HelmConfig instance.

func (VerrazzanoHelmConfig) AddAndUpdateChartRepo

func (h VerrazzanoHelmConfig) AddAndUpdateChartRepo(chart string, repoURL string) (string, error)

AddAndUpdateChartRepo creates/updates the local helm repo for the given repoURL and downloads the index file.

func (VerrazzanoHelmConfig) DownloadChart

func (h VerrazzanoHelmConfig) DownloadChart(chart string, repo string, version string, targetVersion string, chartDir string) error

DownloadChart pulls a chart from the remote helm repo and untars into the chart ditrectory.

func (VerrazzanoHelmConfig) GetChartProvenance

func (h VerrazzanoHelmConfig) GetChartProvenance(chart string, repo string, version string) (*ChartProvenance, error)

GetChartProvenance creates the provenance data for a chart version against its upstream.