helm

Documentation

Index

• type PackageOptions
• type PackageTool
  • func NewPackageTool() *PackageTool
  • func (pt *PackageTool) RunInstall(opts *PackageOptions) error
  • func (pt *PackageTool) RunUninstall(opts *PackageOptions) error
  • func (pt *PackageTool) SetInstallEnvSettings(installCmd *cobra.Command, opts *PackageOptions)
  • func (pt *PackageTool) SetPreRun(cmd *cobra.Command)
  • func (pt *PackageTool) SetUninstallEnvSetting(uninstallCmd *cobra.Command, opts *PackageOptions)
  • func (pt *PackageTool) Setup() error
• type Printer
  • func NewPrinterForWriter(w io.Writer, debug bool) Printer

Types

type PackageOptions

type PackageOptions struct {
	DryRun           bool
	SkipCRD          bool
	Wait             bool
	Version          string
	Timeout          time.Duration
	ReleaseName      string
	ReleaseNamespace string
	OnlyCRD          bool
	WithCRD          bool
	Output           string
}

type PackageTool

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

func NewPackageTool

func NewPackageTool() *PackageTool

func (*PackageTool) RunInstall

func (pt *PackageTool) RunInstall(opts *PackageOptions) error

RunInstall The default installation strategy we adopt is to first install Custom Resource Definitions (CRDs) separately, not as part of the Helm release. Subsequently, we install the Helm release without including CRDs. This approach ensures that when uninstalling with Helm or egctl later on, CRDs are not deleted. We intend for cluster administrators who understand the consequences of uninstalling CRDs to be responsible for their uninstallation. This is done to avoid garbage collection on CRs in the cluster during uninstallation, preventing the potential loss of crucial CR instances.

func (*PackageTool) RunUninstall

func (pt *PackageTool) RunUninstall(opts *PackageOptions) error

RunUninstall By default, we only uninstall instances of the Envoy Gateway resources.

func (*PackageTool) SetInstallEnvSettings

func (pt *PackageTool) SetInstallEnvSettings(installCmd *cobra.Command, opts *PackageOptions)

SetInstallEnvSettings set the installation flags we are interested in

func (*PackageTool) SetPreRun

func (pt *PackageTool) SetPreRun(cmd *cobra.Command)

SetPreRun This will perform the necessary preparations before initializing the PackageTool

func (*PackageTool) SetUninstallEnvSetting

func (pt *PackageTool) SetUninstallEnvSetting(uninstallCmd *cobra.Command, opts *PackageOptions)

SetUninstallEnvSetting set the uninstallation flags we are interested in

func (*PackageTool) Setup

func (pt *PackageTool) Setup() error

Setup Configuration required to initialize helm action.

type Printer

type Printer interface {
	Printf(format string, a ...any)
	Println(string)
}

func NewPrinterForWriter

func NewPrinterForWriter(w io.Writer, debug bool) Printer