runner

Documentation

Overview

Package runner provides a basic interface to run various processes within Evergreen. Its primary job is to expose the basic Run method of such process in an abstraction that allows them to be executed outside of their main functions.

Index

• Variables
• type ProcessRunner

Variables

var (
	Runners = []ProcessRunner{
		&hostinit.Runner{},
		&monitor.Runner{},
		&notify.Runner{},
		&repotracker.Runner{},
		&scheduler.Runner{},
		&taskrunner.Runner{},
		&alerts.QueueProcessor{},
	}
)

Runners is a slice of all Evergreen processes that implement the ProcessRunner interface.

Types

type ProcessRunner

type ProcessRunner interface {
	// Name returns the id of the process runner.
	Name() string
	// Description returns a description of the runner for use in -help text.
	Description() string
	// Run executes the process runner with the supplied configuration.
	Run(*evergreen.Settings) error
}

ProcessRunner wraps a basic Run method that allows various processes in Evergreen to be executed outside of their main methods.