installer

Documentation

Index

• func Install(ctx context.Context, eventBus *v1alpha1.EventBus, client client.Client, ...) error
• func Uninstall(ctx context.Context, eventBus *v1alpha1.EventBus, client client.Client, ...) error
• type Installer
  • func NewExoticNATSInstaller(eventBus *v1alpha1.EventBus, logger *zap.SugaredLogger) Installer
  • func NewJetStreamInstaller(client client.Client, eventBus *v1alpha1.EventBus, ...) Installer
  • func NewNATSInstaller(client client.Client, eventBus *v1alpha1.EventBus, ...) Installer

Functions

func Install

func Install(ctx context.Context, eventBus *v1alpha1.EventBus, client client.Client, config *controllers.GlobalConfig, logger *zap.SugaredLogger) error

Install function installs the event bus

func Uninstall

func Uninstall(ctx context.Context, eventBus *v1alpha1.EventBus, client client.Client, config *controllers.GlobalConfig, logger *zap.SugaredLogger) error

Uninstall function will be run before the EventBus object is deleted, usually it could be used to uninstall the extra resources who would not be cleaned up when an EventBus is deleted. Most of the time this is not needed as all the dependency resources should have been deleted by owner references cascade deletion, but things like PVC created by StatefulSet need to be cleaned up separately.

It could also be used to check if the EventBus object can be safely deleted.

Types

type Installer

type Installer interface {
	Install(ctx context.Context) (*v1alpha1.BusConfig, error)
	// Uninsall only needs to handle those resources not cascade deleted.
	// For example, undeleted PVCs not automatically deleted when deleting a StatefulSet
	Uninstall(ctx context.Context) error
}

Installer is an interface for event bus installation

func NewExoticNATSInstaller

func NewExoticNATSInstaller(eventBus *v1alpha1.EventBus, logger *zap.SugaredLogger) Installer

NewExoticNATSInstaller return a new exoticNATSInstaller

func NewJetStreamInstaller

func NewJetStreamInstaller(client client.Client, eventBus *v1alpha1.EventBus, config *controllers.GlobalConfig, labels map[string]string, logger *zap.SugaredLogger) Installer

func NewNATSInstaller

func NewNATSInstaller(client client.Client, eventBus *v1alpha1.EventBus, config *controllers.GlobalConfig, labels map[string]string, logger *zap.SugaredLogger) Installer

NewNATSInstaller returns a new NATS installer