checks

Documentation

Index

• type Category
• type Check
  • func NewDeploymentsCheck() Check
  • func NewNetworkingCrdCheck() Check
• type Failure

Types

type Category

type Category struct {
	Name   string
	Checks []Check
}

type Check

type Check interface {
	// description of what is being checked
	GetDescription() string

	// Execute the check, pass in the namespace that Gloo Mesh is installed in
	Run(ctx context.Context, client client.Client, installNamespace string) *Failure
}

func NewDeploymentsCheck

func NewDeploymentsCheck() Check

func NewNetworkingCrdCheck

func NewNetworkingCrdCheck() Check

type Failure

type Failure struct {
	// user-facing error message describing failed check
	Errors []error

	// optionally provide a link to a docs page that a user should consult to resolve the error
	DocsLink *url.URL

	// an optional suggestion for a next action for the user to take for resolving a failed check
	Hint string
}