check

Documentation

Index

• type Check
  • func PreinstallChecks() []Check
• type Checker
  • func NewChecker(settings *cli.EnvSettings) *Checker
  • func (c *Checker) Run(checks []Check, cb func(*Result)) bool
• type Result

Types

type Check

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

Check encapsulates a single check against k8s/osm.

func PreinstallChecks

func PreinstallChecks() []Check

PreinstallChecks validate that a Kubernetes clsuter is configured properly to allow a successful installation of OSM.

type Checker

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

Checker encapsulates all the data needed to run Checks against a Kubernetes cluster.

func NewChecker

func NewChecker(settings *cli.EnvSettings) *Checker

NewChecker initializes a new *Checker.

func (*Checker) Run

func (c *Checker) Run(checks []Check, cb func(*Result)) bool

Run runs all the checks, calling the callback function cb after each completes. It returns a boolean representing the overall success.

type Result

type Result struct {
	Name string
	Err  error
}

Result is the result of running a Check.