install

Documentation

Index

• Constants
• Variables
• func InstallCmd(opts *options.Options, optionsFunc ...cliutils.OptionsFunc) *cobra.Command
• func RenderKnativeManifests(opts options.Knative) (string, error)
• func RenderKnativeValues(version string) (string, error)
• func UninstallCmd(opts *options.Options, optionsFunc ...cliutils.OptionsFunc) *cobra.Command
• func UninstallGloo(opts *options.Options, cli install.KubeCli) error
• type HelmClient
  • func DefaultHelmClient() HelmClient
• type HelmInstallation
• type HelmReleaseListRunner
• type HelmUninstallation
• type Installer
  • func NewInstaller(helmClient HelmClient) Installer
  • func NewInstallerWithWriter(helmClient HelmClient, outputWriter io.Writer) Installer
• type InstallerConfig
• type Uninstaller
  • func NewUninstaller(helmClient HelmClient, kubeCli install.KubeCli) Uninstaller
  • func NewUninstallerWithOutput(helmClient HelmClient, kubeCli install.KubeCli, output io.Writer) Uninstaller

Constants

const (
	GlooEHelmRepoTemplate = "https://storage.googleapis.com/gloo-ee-helm/charts/gloo-ee-%s.tgz"
)

Variables

var (
	GlooAlreadyInstalled = func(namespace string) error {
		return errors.Errorf("Gloo has already been installed to namespace %s", namespace)
	}
	NoReleaseForCRDs        = errors.New("Could not find a release from which to pull CRDs")
	MultipleReleasesForCRDs = errors.New("Found multiple releases from which to pull CRDs")
)

var (
	// These will get cleaned up by uninstall always
	GlooSystemKinds []string
	// These will get cleaned up only if uninstall all is chosen
	GlooRbacKinds []string
	// These will get cleaned up by uninstall if delete-crds or all is chosen
	GlooCrdNames []string

	// Set up during pre-install (for OS gloo, namespace only)
	GlooPreInstallKinds     []string
	GlooInstallKinds        []string
	GlooGatewayUpgradeKinds []string
	ExpectedLabels          map[string]string

	KnativeCrdNames []string
)

Functions

func InstallCmd

func InstallCmd(opts *options.Options, optionsFunc ...cliutils.OptionsFunc) *cobra.Command

func RenderKnativeManifests

func RenderKnativeManifests(opts options.Knative) (string, error)

used by e2e test

func RenderKnativeValues

func RenderKnativeValues(version string) (string, error)

func UninstallCmd

func UninstallCmd(opts *options.Options, optionsFunc ...cliutils.OptionsFunc) *cobra.Command

func UninstallGloo

func UninstallGloo(opts *options.Options, cli install.KubeCli) error

Types

type HelmClient

type HelmClient interface {
	// Prepare an installation object that can then be .Run() with a chart object
	NewInstall(namespace, releaseName string, dryRun bool) (HelmInstallation, *cli.EnvSettings, error)

	// Prepare an un-installation object that can then be .Run() with a release name
	NewUninstall(namespace string) (HelmUninstallation, error)

	// List the already-existing releases in the given namespace
	ReleaseList(namespace string) (HelmReleaseListRunner, error)

	// Returns the Helm chart archive located at the given URI (can be either an http(s) address or a file path)
	DownloadChart(chartArchiveUri string) (*chart.Chart, error)

	// Returns true if the release with the given name exists in the given namespace
	ReleaseExists(namespace, releaseName string) (releaseExists bool, err error)
}

This interface implements the Helm CLI actions. The implementation relies on the Helm 3 libraries.

func DefaultHelmClient

func DefaultHelmClient() HelmClient

a HelmClient that talks to the kube api server and creates resources

type HelmInstallation

type HelmInstallation interface {
	Run(chrt *chart.Chart, vals map[string]interface{}) (*release.Release, error)
}

an interface around Helm's action.Install struct

type HelmReleaseListRunner

type HelmReleaseListRunner interface {
	Run() ([]*release.Release, error)
	SetFilter(filter string)
}

an interface around Helm's action.List struct

type HelmUninstallation

type HelmUninstallation interface {
	Run(name string) (*release.UninstallReleaseResponse, error)
}

an interface around Helm's action.Uninstall struct

type Installer

type Installer interface {
	Install(installerConfig *InstallerConfig) error
}

func NewInstaller

func NewInstaller(helmClient HelmClient) Installer

func NewInstallerWithWriter

func NewInstallerWithWriter(helmClient HelmClient, outputWriter io.Writer) Installer

visible for testing

type InstallerConfig

type InstallerConfig struct {
	InstallCliArgs *options.Install
	ExtraValues    map[string]interface{}
	Enterprise     bool
	Verbose        bool
}

type Uninstaller

type Uninstaller interface {
	Uninstall(cliArgs *options.Options) error
}

func NewUninstaller

func NewUninstaller(helmClient HelmClient, kubeCli install.KubeCli) Uninstaller

func NewUninstallerWithOutput

func NewUninstallerWithOutput(helmClient HelmClient, kubeCli install.KubeCli, output io.Writer) Uninstaller

visible for testing