installer

package

v5.5.7 Latest Latest Go to latest Published: Dec 21, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/devantler-tech/ksail

Links

Open Source Insights

Documentation ¶

Overview ¶

Package installer provides functionality for installing and uninstalling components.

This package defines the Installer interface and provides implementations for installing various Kubernetes components (Flux, Cilium, metrics-server) on Kubernetes clusters.

Index ¶

Constants
func GetInstallTimeout(clusterCfg *v1alpha1.Cluster) time.Duration
func WaitForResourceReadiness(ctx context.Context, kubeconfig, context string, checks []k8s.ReadinessCheck, ...) error
type Installer
type MockInstaller
- func NewMockInstaller(t interface{ ... }) *MockInstaller
type MockInstaller_Expecter
- func (_e *MockInstaller_Expecter) Install(ctx interface{}) *MockInstaller_Install_Call
- func (_e *MockInstaller_Expecter) Uninstall(ctx interface{}) *MockInstaller_Uninstall_Call
type MockInstaller_Install_Call
type MockInstaller_Uninstall_Call

Constants ¶

View Source

const (
	// DefaultInstallTimeout is the default timeout for component installation.
	DefaultInstallTimeout = 5 * time.Minute
)

Variables ¶

This section is empty.

Functions ¶

func GetInstallTimeout ¶

func GetInstallTimeout(clusterCfg *v1alpha1.Cluster) time.Duration

GetInstallTimeout determines the timeout for component installation. Uses cluster connection timeout if configured, otherwise defaults to DefaultInstallTimeout. Returns DefaultInstallTimeout if clusterCfg is nil.

func WaitForResourceReadiness ¶

func WaitForResourceReadiness(
	ctx context.Context,
	kubeconfig, context string,
	checks []k8s.ReadinessCheck,
	timeout time.Duration,
	componentName string,
) error

WaitForResourceReadiness waits for multiple Kubernetes resources to become ready.

Types ¶

type Installer ¶

type Installer interface {
	// Install installs the component.
	Install(ctx context.Context) error

	// Uninstall uninstalls the component.
	Uninstall(ctx context.Context) error
}

Installer defines methods for installing and uninstalling components.

type MockInstaller ¶

type MockInstaller struct {
	mock.Mock
}

MockInstaller is an autogenerated mock type for the Installer type

func NewMockInstaller ¶

func NewMockInstaller(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockInstaller

NewMockInstaller creates a new instance of MockInstaller. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockInstaller) EXPECT ¶

func (_m *MockInstaller) EXPECT() *MockInstaller_Expecter

func (*MockInstaller) Install ¶

func (_mock *MockInstaller) Install(ctx context.Context) error

Install provides a mock function for the type MockInstaller

func (*MockInstaller) Uninstall ¶

func (_mock *MockInstaller) Uninstall(ctx context.Context) error

Uninstall provides a mock function for the type MockInstaller

type MockInstaller_Expecter ¶

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

func (*MockInstaller_Expecter) Install ¶

func (_e *MockInstaller_Expecter) Install(ctx interface{}) *MockInstaller_Install_Call

Install is a helper method to define mock.On call

ctx context.Context

func (*MockInstaller_Expecter) Uninstall ¶

func (_e *MockInstaller_Expecter) Uninstall(ctx interface{}) *MockInstaller_Uninstall_Call

Uninstall is a helper method to define mock.On call

ctx context.Context

type MockInstaller_Install_Call ¶

type MockInstaller_Install_Call struct {
	*mock.Call
}

MockInstaller_Install_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Install'

func (*MockInstaller_Install_Call) Return ¶

func (_c *MockInstaller_Install_Call) Return(err error) *MockInstaller_Install_Call

func (*MockInstaller_Install_Call) Run ¶

func (_c *MockInstaller_Install_Call) Run(run func(ctx context.Context)) *MockInstaller_Install_Call

func (*MockInstaller_Install_Call) RunAndReturn ¶

func (_c *MockInstaller_Install_Call) RunAndReturn(run func(ctx context.Context) error) *MockInstaller_Install_Call

type MockInstaller_Uninstall_Call ¶

type MockInstaller_Uninstall_Call struct {
	*mock.Call
}

MockInstaller_Uninstall_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Uninstall'

func (*MockInstaller_Uninstall_Call) Return ¶

func (_c *MockInstaller_Uninstall_Call) Return(err error) *MockInstaller_Uninstall_Call

func (*MockInstaller_Uninstall_Call) Run ¶

func (_c *MockInstaller_Uninstall_Call) Run(run func(ctx context.Context)) *MockInstaller_Uninstall_Call

func (*MockInstaller_Uninstall_Call) RunAndReturn ¶

func (_c *MockInstaller_Uninstall_Call) RunAndReturn(run func(ctx context.Context) error) *MockInstaller_Uninstall_Call

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
applyset
argocd Package argocdinstaller installs Argo CD via Helm.	Package argocdinstaller installs Argo CD via Helm.
cert-manager Package certmanagerinstaller installs cert-manager via Helm.	Package certmanagerinstaller installs cert-manager via Helm.
cni Package cni provides unified CNI installer implementations and shared utilities for managing CNI providers on Kubernetes clusters.	Package cni provides unified CNI installer implementations and shared utilities for managing CNI providers on Kubernetes clusters.
calico Package calicoinstaller provides an installer for installing Calico CNI on a Kubernetes cluster.	Package calicoinstaller provides an installer for installing Calico CNI on a Kubernetes cluster.
cilium Package ciliuminstaller provides an installer for installing Cilium CNI on a Kubernetes cluster.	Package ciliuminstaller provides an installer for installing Cilium CNI on a Kubernetes cluster.
flux Package fluxinstaller provides an installer for installing Flux on a Kubernetes cluster.	Package fluxinstaller provides an installer for installing Flux on a Kubernetes cluster.
localpathstorage Package localpathstorageinstaller provides installation of Rancher Local Path Provisioner for Kind clusters.	Package localpathstorageinstaller provides installation of Rancher Local Path Provisioner for Kind clusters.
metrics-server Package metricsserverinstaller provides an installer for installing metrics-server on a Kubernetes cluster.	Package metricsserverinstaller provides an installer for installing metrics-server on a Kubernetes cluster.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL