controller

Documentation

Index

• type AnalyticsReporter
• type Controller
  • func New(log logrus.FieldLogger, conf *config.Config, notifiers []notifier.Notifier, ...) *Controller
  • func (c *Controller) Start(ctx context.Context) error
• type GitHubRepoClient
• type RecommendationFactory
• type UpgradeChecker
  • func NewUpgradeChecker(log logrus.FieldLogger, notifiers []notifier.Notifier, ghCli GitHubRepoClient) *UpgradeChecker
  • func (c *UpgradeChecker) Run(ctx context.Context) error

Types

type AnalyticsReporter

type AnalyticsReporter interface {
	// ReportHandledEventSuccess reports a successfully handled event using a given communication platform.
	ReportHandledEventSuccess(integrationType config.IntegrationType, platform config.CommPlatformIntegration, eventDetails analytics.EventDetails) error

	// ReportHandledEventError reports a failure while handling event using a given communication platform.
	ReportHandledEventError(integrationType config.IntegrationType, platform config.CommPlatformIntegration, eventDetails analytics.EventDetails, err error) error

	// ReportFatalError reports a fatal app error.
	ReportFatalError(err error) error

	// Close cleans up the reporter resources.
	Close() error
}

AnalyticsReporter defines a reporter that collects analytics data.

type Controller

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

Controller watches Kubernetes resources and send events to notifiers.

func New

func New(log logrus.FieldLogger,
	conf *config.Config,
	notifiers []notifier.Notifier,
	recommFactory RecommendationFactory,
	filterEngine filterengine.FilterEngine,
	dynamicCli dynamic.Interface,
	mapper meta.RESTMapper,
	informersResyncPeriod time.Duration,
	router *sources.Router,
	reporter AnalyticsReporter,
) *Controller

New create a new Controller instance.

func (*Controller) Start

func (c *Controller) Start(ctx context.Context) error

Start creates new informer controllers to watch k8s resources

type GitHubRepoClient

type GitHubRepoClient interface {
	GetLatestRelease(ctx context.Context, owner, repo string) (*github.RepositoryRelease, *github.Response, error)
}

GitHubRepoClient describes the client for getting latest release for a given repository.

type RecommendationFactory

type RecommendationFactory interface {
	NewForSources(sources map[string]config.Sources, mapKeyOrder []string) (recommendation.AggregatedRunner, config.Recommendations)
}

RecommendationFactory defines a factory that creates recommendations.

type UpgradeChecker

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

UpgradeChecker checks for new BotKube releases.

func NewUpgradeChecker

func NewUpgradeChecker(log logrus.FieldLogger, notifiers []notifier.Notifier, ghCli GitHubRepoClient) *UpgradeChecker

NewUpgradeChecker creates a new instance of the Upgrade Checker.

func (*UpgradeChecker) Run

func (c *UpgradeChecker) Run(ctx context.Context) error

Run runs the Upgrade Checker and checks for new BotKube releases periodically.