validation

README

When creating a new resource Group extend the Validator.go methodModificationIsSupported() and DeletionIsSupported().

We will also have to update the Webhook Validator helm values as well in install/helm/gloo/templates/5-gateway-validation-webhook-configuration.yaml

Documentation

Index

• Constants
• Variables
• func MakeNotificationChannel(ctx context.Context, client validation.GlooValidationServiceClient) (<-chan struct{}, error)
• func NewConnectionRefreshingValidationClient(...) (*connectionRefreshingValidationClient, error)
• func NewValidator(cfg ValidatorConfig) *validator
• func UnmarshalResource(kubeJson []byte, resource resources.Resource) error
• type ClientConstructor
  • func RetryOnUnavailableClientConstructor(ctx context.Context, serverAddress string) ClientConstructor
• type GlooValidationResponseLengthError
  • func (e GlooValidationResponseLengthError) Error() string
• type GlooValidatorFunc
• type ProxyReports
• type Reports
  • func (r *Reports) GetProxies() []*gloov1.Proxy
• type SyncNotYetRunError
  • func (e SyncNotYetRunError) Error() string
• type UpstreamReports
• type Validator
• type ValidatorConfig

Constants

const GatewayGroup = "gateway.solo.io"

const (
	InvalidSnapshotErrMessage = "validation is disabled due to an invalid resource which has been written to storage. " +
		"Please correct any Rejected resources to re-enable validation."
)

Variables

var (
	NotReadyErr             = errors.Errorf("validation is not yet available. Waiting for first snapshot")
	HasNotReceivedFirstSync = errors.New("proxy validation called before the validation server received its first sync of resources")

	WrappedUnmarshalErr = func(err error) error {
		return errors.Wrapf(err, unmarshalErrMsg)
	}

	BreakingErrorLogMsg = "Breaking errors found, not revalidating against original snapshot"
)

Functions

func MakeNotificationChannel

func MakeNotificationChannel(ctx context.Context, client validation.GlooValidationServiceClient) (<-chan struct{}, error)

func NewConnectionRefreshingValidationClient

func NewConnectionRefreshingValidationClient(constructValidationClient func() (validation.GlooValidationServiceClient, error)) (*connectionRefreshingValidationClient, error)

func NewValidator

func NewValidator(cfg ValidatorConfig) *validator

func UnmarshalResource

func UnmarshalResource(kubeJson []byte, resource resources.Resource) error

UnmarshalResource is the same as the solo-kit pkg/utils/protoutils.Unmarshal() except it does not set the status of the resource since validation does not write the resources, this is ok. Validation will only store the state of a resource to the copy of the snapshot.

Types

type ClientConstructor

type ClientConstructor func() (client validation.GlooValidationServiceClient, e error)

func RetryOnUnavailableClientConstructor

func RetryOnUnavailableClientConstructor(ctx context.Context, serverAddress string) ClientConstructor

the constructor returned here is not threadsafe; call from a lock

type GlooValidationResponseLengthError

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

This error is a struct so it can be checked with errors.As

func (GlooValidationResponseLengthError) Error

func (e GlooValidationResponseLengthError) Error() string

type GlooValidatorFunc

type GlooValidatorFunc = func(ctx context.Context, proxy *gloov1.Proxy,
	resource resources.Resource, shouldDelete bool,
) ([]*gloovalidation.GlooValidationReport, error)

type ProxyReports

type ProxyReports []*validation.ProxyReport

type Reports

type Reports struct {
	Proxies      []*gloov1.Proxy
	ProxyReports *ProxyReports
}

func (*Reports) GetProxies

func (r *Reports) GetProxies() []*gloov1.Proxy

type SyncNotYetRunError

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

This error is a struct so it can be checked with errors.As

func (SyncNotYetRunError) Error

func (e SyncNotYetRunError) Error() string

type UpstreamReports

type UpstreamReports []*validation.ResourceReport

type Validator

type Validator interface {
	gloov1snap.ApiSyncer
	// ValidateList will validate a list of resources
	ValidateList(ctx context.Context, ul *unstructured.UnstructuredList, dryRun bool) (*Reports, *multierror.Error)
	// ValidateModifiedGvk validate the creation or update of a resource.
	ValidateModifiedGvk(ctx context.Context, gvk schema.GroupVersionKind, resource resources.Resource, dryRun bool) (*Reports, error)
	// ValidateDeletedGvk validate the deletion of a resource.
	ValidateDeletedGvk(ctx context.Context, gvk schema.GroupVersionKind, resource resources.Resource, dryRun bool) error
}

type ValidatorConfig

type ValidatorConfig struct {
	Translator                            translator.Translator
	GlooValidator                         GlooValidatorFunc
	ExtensionValidator                    syncerValidation.Validator
	AllowWarnings                         bool
	DisableValidationAgainstPreviousState bool
}