checks

package
v1.0.0-beta11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 17, 2021 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL