local

Documentation

Index

• type Check
  • func NewCheck(name string, checker Checker, logger *log.Entry, conf *config.Config, ...) *Check
  • func (c *Check) RunAndServe()
  • func (c *Check) Shutdown() error
• type Checker
• type State

Types

type Check

type Check struct {
	Logger *log.Entry
	Name   string
	// contains filtered or unexported fields
}

Check stores all the information needed to run a check locally.

func NewCheck

func NewCheck(name string, checker Checker, logger *log.Entry, conf *config.Config, json bool) *Check

NewCheck creates new check to be run from the command line without having an agent.

func (*Check) RunAndServe

func (c *Check) RunAndServe()

RunAndServe implements the behavior needed by the sdk for a check runner to execute a check.

func (*Check) Shutdown

func (c *Check) Shutdown() error

Shutdown is needed to fullfil the check interface but we don't need to do anything in this case.

type Checker

type Checker interface {
	Run(ctx context.Context, target, assetType, opts string, state astate.State) error
	CleanUp(ctx context.Context, target, assetType, opts string)
}

Checker defines the shape a checker must have in order to be executed as vulcan-check.

type State

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

State holds the state for a local check.