providers

Documentation

Overview

Package providers provide the different implementations to download the application's source and install / uninstall the application into the user-cluster.

There are 2 types of providers:

• source provider: which handles the download of application's sources. For example, the GitSource provider downloads sources from a git repository.
• template provider: which handles installation, update, or uninstallation of an application.

Index

• type SourceProvider
  • func NewSourceProvider(ctx context.Context, log *zap.SugaredLogger, client ctrlruntimeclient.Client, ...) (SourceProvider, error)
• type TemplateProvider
  • func NewTemplateProvider(ctx context.Context, seedClient ctrlruntimeclient.Client, kubeconfig string, ...) (TemplateProvider, error)

Types

type SourceProvider

type SourceProvider interface {

	// DownloadSource into the destination and return the full path to the source.
	// destination must exist.
	DownloadSource(destination string) (string, error)
}

SourceProvider is an interface for downloading the application's sources.

func NewSourceProvider

func NewSourceProvider(ctx context.Context, log *zap.SugaredLogger, client ctrlruntimeclient.Client, kubeconfig string, cacheDir string, appSource *appskubermaticv1.ApplicationSource, secretNamespace string) (SourceProvider, error)

NewSourceProvider returns the concrete implementation of SourceProvider according to source defined in appSource.

type TemplateProvider

type TemplateProvider interface {

	// InstallOrUpgrade the application from the source.
	InstallOrUpgrade(source string, appDefinition *appskubermaticv1.ApplicationDefinition, applicationInstallation *appskubermaticv1.ApplicationInstallation) (util.StatusUpdater, error)

	// Uninstall the application.
	Uninstall(applicationInstallation *appskubermaticv1.ApplicationInstallation) (util.StatusUpdater, error)

	// Check if a release is stuck
	IsStuck(applicationInstallation *appskubermaticv1.ApplicationInstallation) (bool, error)

	// Rollback the Application to the previous release
	Rollback(applicationInstallation *appskubermaticv1.ApplicationInstallation) error
}

TemplateProvider is an interface to install, upgrade or uninstall application.

func NewTemplateProvider

func NewTemplateProvider(ctx context.Context, seedClient ctrlruntimeclient.Client, kubeconfig string, cacheDir string, log *zap.SugaredLogger, appInstallation *appskubermaticv1.ApplicationInstallation, secretNamespace string) (TemplateProvider, error)

NewTemplateProvider return the concrete implementation of TemplateProvider according to the templateMethod.