install

Documentation

Index

• Constants
• func Install(ctx context.Context, w io.Writer, k8sCfg *kubex.ConfigWithMeta, opts Config) (err error)
• type Config

Constants

const (
	// StableVersionTag tag used to select stable Helm chart repository.
	StableVersionTag = "@stable"
	// LocalVersionTag tag used to select local Helm chart repository.
	LocalVersionTag = "@local"
	// LatestVersionTag tag used to select the latest version from the Helm chart repository.
	LatestVersionTag = "@latest"
	// Namespace in which Botkube is installed.
	Namespace = "botkube"
	// ReleaseName defines Botkube Helm chart release name.
	ReleaseName = "botkube"
	// HelmRepoStable URL of the stable Botkube Helm charts repository.
	HelmRepoStable = "https://charts.botkube.io/"
	// HelmChartName represents Botkube Helm chart name in a given Helm repository.
	HelmChartName = "botkube"
	// LocalChartsPath path to Helm charts in botkube repository.
	LocalChartsPath = "./helm/"
)

Functions

func Install

func Install(ctx context.Context, w io.Writer, k8sCfg *kubex.ConfigWithMeta, opts Config) (err error)

Install installs Botkube Helm chart into cluster.

Types

type Config

type Config struct {
	Kubeconfig string
	HelmParams helm.Config
	Watch      bool
	Timeout    time.Duration
}

Config holds parameters for Botkube installation on cluster.