helm

Documentation

Index

• Constants
• func GetCRDFromChart(chart *chart.Chart) []*crdv1.CustomResourceDefinition
• func GetDeploymentsFromManifest(helmManifest string) []*appsv1.Deployment
• func GetHelmRelease(ns string) ([]*release.Release, error)
• func LoadRepoIndex(ctx context.Context, u string, cred *RepoCredential) (*helmrepo.IndexFile, error)
• func SetHTTPOption(ctx context.Context, k8sClient client.Client, secretRef types2.NamespacedName) (*common.HTTPOption, error)
• type ChartValues
• type Helper
  • func NewHelper() *Helper
  • func NewHelperWithCache() *Helper
  • func (h *Helper) GetIndexInfo(repoURL string, skipCache bool, opts *common.HTTPOption) (*repo.IndexFile, error)
  • func (h *Helper) GetValuesFromChart(repoURL string, chartName string, version string, skipCache bool, ...) (*ChartValues, error)
  • func (h *Helper) ListChartsFromRepo(repoURL string, skipCache bool, opts *common.HTTPOption) ([]string, error)
  • func (h *Helper) ListVersions(repoURL string, chartName string, skipCache bool, opts *common.HTTPOption) (repo.ChartVersions, error)
  • func (h *Helper) LoadCharts(chartRepoURL string, opts *common.HTTPOption) (*chart.Chart, error)
  • func (h *Helper) UninstallRelease(releaseName, namespace string, config *rest.Config, showDetail bool, ...) error
  • func (h *Helper) UpgradeChart(ch *chart.Chart, releaseName, namespace string, values map[string]interface{}, ...) (*release.Release, error)
  • func (h *Helper) ValidateRepo(ctx context.Context, repo *Repository) (bool, error)
• type RepoCredential
• type Repository
• type UpgradeChartOptions

Constants

const IndexYaml = "index.yaml"

IndexYaml is the index.yaml of helm repo

Functions

func GetCRDFromChart

func GetCRDFromChart(chart *chart.Chart) []*crdv1.CustomResourceDefinition

GetCRDFromChart get crd from helm chart

func GetDeploymentsFromManifest

func GetDeploymentsFromManifest(helmManifest string) []*appsv1.Deployment

GetDeploymentsFromManifest get deployment from helm manifest

func GetHelmRelease

func GetHelmRelease(ns string) ([]*release.Release, error)

GetHelmRelease will get helm release

func LoadRepoIndex

func LoadRepoIndex(ctx context.Context, u string, cred *RepoCredential) (*helmrepo.IndexFile, error)

LoadRepoIndex load helm repo index

func SetHTTPOption

func SetHTTPOption(ctx context.Context, k8sClient client.Client, secretRef types2.NamespacedName) (*common.HTTPOption, error)

SetHTTPOption will read username and password from secret return a httpOption that contain these info.

Types

type ChartValues

type ChartValues struct {
	Data   map[string]string
	Values map[string]interface{}
}

ChartValues contain all values files in chart and default chart values

type Helper

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

Helper provides helper functions for common Helm operations

func NewHelper

func NewHelper() *Helper

NewHelper creates a Helper

func NewHelperWithCache

func NewHelperWithCache() *Helper

NewHelperWithCache creates a Helper with cache usually used by apiserver

func (*Helper) GetIndexInfo

func (h *Helper) GetIndexInfo(repoURL string, skipCache bool, opts *common.HTTPOption) (*repo.IndexFile, error)

GetIndexInfo get index.yaml form given repo url

func (*Helper) GetValuesFromChart

func (h *Helper) GetValuesFromChart(repoURL string, chartName string, version string, skipCache bool, repoType string, opts *common.HTTPOption) (*ChartValues, error)

GetValuesFromChart will extract the parameter from a helm chart

func (*Helper) ListChartsFromRepo

func (h *Helper) ListChartsFromRepo(repoURL string, skipCache bool, opts *common.HTTPOption) ([]string, error)

ListChartsFromRepo list available helm charts in a repo

func (*Helper) ListVersions

func (h *Helper) ListVersions(repoURL string, chartName string, skipCache bool, opts *common.HTTPOption) (repo.ChartVersions, error)

ListVersions list available versions from repo

func (*Helper) LoadCharts

func (h *Helper) LoadCharts(chartRepoURL string, opts *common.HTTPOption) (*chart.Chart, error)

LoadCharts load helm chart from local or remote

func (*Helper) UninstallRelease

func (h *Helper) UninstallRelease(releaseName, namespace string, config *rest.Config, showDetail bool, logging cmdutil.IOStreams) error

UninstallRelease uninstalls the provided release

func (*Helper) UpgradeChart

func (h *Helper) UpgradeChart(ch *chart.Chart, releaseName, namespace string, values map[string]interface{}, config UpgradeChartOptions) (*release.Release, error)

UpgradeChart install or upgrade helm chart

func (*Helper) ValidateRepo

func (h *Helper) ValidateRepo(ctx context.Context, repo *Repository) (bool, error)

ValidateRepo will validate the helm repository

type RepoCredential

type RepoCredential struct {
	// chart repository username
	Username string `json:"username,omitempty"`
	// chart repository password
	Password string `json:"password,omitempty"`
	// identify HTTPS client using this SSL certificate file
	CertFile string `json:"certFile,omitempty"`
	// identify HTTPS client using this SSL key file
	KeyFile string `json:"keyFile,omitempty"`
	// verify certificates of HTTPS-enabled servers using this CA bundle
	CAFile string `json:"caFile,omitempty"`
	// skip tls certificate checks for the repository, default is ture
	InsecureSkipTLSVerify *bool `json:"insecureSkipTLSVerify,omitempty"`
}

RepoCredential is the helm repo credential

type Repository

type Repository struct {
	URL      string `json:"url"`
	Username string `json:"username"`
	Password string `json:"password"`
	CAFile   string `json:"caFile"`
}

Repository is the helm repository

type UpgradeChartOptions

type UpgradeChartOptions struct {
	Config      *rest.Config
	Detail      bool
	Logging     cmdutil.IOStreams
	Wait        bool
	ReuseValues bool
}

UpgradeChartOptions options for upgrade chart