validation

Documentation

Overview

Package validation has functions for validating the correctness of api objects and explaining what is wrong with them when they aren't valid.

Index

• func AccumulateUniquePorts(containers []api.Container, accumulator map[int]bool, ...) errs.ValidationErrorList
• func NewInvalidTypeError(expected reflect.Kind, observed reflect.Kind, fieldName string) error
• func ValidateBoundPod(pod *api.BoundPod) (errors []error)
• func ValidateEvent(event *api.Event) errs.ValidationErrorList
• func ValidateManifest(manifest *api.ContainerManifest) errs.ValidationErrorList
• func ValidateMinion(minion *api.Node) errs.ValidationErrorList
• func ValidateMinionUpdate(oldMinion *api.Node, minion *api.Node) errs.ValidationErrorList
• func ValidatePod(pod *api.Pod) errs.ValidationErrorList
• func ValidatePodSpec(spec *api.PodSpec) errs.ValidationErrorList
• func ValidatePodTemplateSpec(spec *api.PodTemplateSpec) errs.ValidationErrorList
• func ValidatePodUpdate(newPod, oldPod *api.Pod) errs.ValidationErrorList
• func ValidateReadOnlyPersistentDisks(volumes []api.Volume) errs.ValidationErrorList
• func ValidateReplicationController(controller *api.ReplicationController) errs.ValidationErrorList
• func ValidateReplicationControllerSpec(spec *api.ReplicationControllerSpec) errs.ValidationErrorList
• func ValidateService(service *api.Service, lister ServiceLister, ctx api.Context) errs.ValidationErrorList
• type InvalidTypeError
  • func (i *InvalidTypeError) Error() string
• type NullSchema
  • func (NullSchema) ValidateBytes(data []byte) error
• type Schema
  • func NewSwaggerSchemaFromBytes(data []byte) (Schema, error)
• type ServiceLister
• type SwaggerSchema
  • func (s *SwaggerSchema) ValidateBytes(data []byte) error
  • func (s *SwaggerSchema) ValidateObject(obj interface{}, apiVersion, fieldName, typeName string) error

Functions

func AccumulateUniquePorts

func AccumulateUniquePorts(containers []api.Container, accumulator map[int]bool, extract func(*api.Port) int) errs.ValidationErrorList

AccumulateUniquePorts runs an extraction function on each Port of each Container, accumulating the results and returning an error if any ports conflict.

func NewInvalidTypeError

func NewInvalidTypeError(expected reflect.Kind, observed reflect.Kind, fieldName string) error

func ValidateBoundPod

func ValidateBoundPod(pod *api.BoundPod) (errors []error)

ValidateBoundPod tests if required fields on a bound pod are set.

func ValidateEvent

func ValidateEvent(event *api.Event) errs.ValidationErrorList

ValidateEvent makes sure that the event makes sense.

func ValidateManifest

func ValidateManifest(manifest *api.ContainerManifest) errs.ValidationErrorList

ValidateManifest tests that the specified ContainerManifest has valid data. This includes checking formatting and uniqueness. It also canonicalizes the structure by setting default values and implementing any backwards-compatibility tricks. TODO: replaced by ValidatePodSpec

func ValidateMinion

func ValidateMinion(minion *api.Node) errs.ValidationErrorList

ValidateMinion tests if required fields in the minion are set.

func ValidateMinionUpdate

func ValidateMinionUpdate(oldMinion *api.Node, minion *api.Node) errs.ValidationErrorList

ValidateMinionUpdate tests to make sure a minion update can be applied. Modifies oldMinion.

func ValidatePod

func ValidatePod(pod *api.Pod) errs.ValidationErrorList

ValidatePod tests if required fields in the pod are set.

func ValidatePodSpec

func ValidatePodSpec(spec *api.PodSpec) errs.ValidationErrorList

ValidatePodSpec tests that the specified PodSpec has valid data. This includes checking formatting and uniqueness. It also canonicalizes the structure by setting default values and implementing any backwards-compatibility tricks.

func ValidatePodTemplateSpec

func ValidatePodTemplateSpec(spec *api.PodTemplateSpec) errs.ValidationErrorList

ValidatePodTemplateSpec validates the spec of a pod template

func ValidatePodUpdate

func ValidatePodUpdate(newPod, oldPod *api.Pod) errs.ValidationErrorList

ValidatePodUpdate tests to see if the update is legal

func ValidateReadOnlyPersistentDisks

func ValidateReadOnlyPersistentDisks(volumes []api.Volume) errs.ValidationErrorList

func ValidateReplicationController

func ValidateReplicationController(controller *api.ReplicationController) errs.ValidationErrorList

ValidateReplicationController tests if required fields in the replication controller are set.

func ValidateReplicationControllerSpec

func ValidateReplicationControllerSpec(spec *api.ReplicationControllerSpec) errs.ValidationErrorList

ValidateReplicationControllerSpec tests if required fields in the replication controller spec are set.

func ValidateService

func ValidateService(service *api.Service, lister ServiceLister, ctx api.Context) errs.ValidationErrorList

ValidateService tests if required fields in the service are set.

Types

type InvalidTypeError

type InvalidTypeError struct {
	ExpectedKind reflect.Kind
	ObservedKind reflect.Kind
	FieldName    string
}

func (*InvalidTypeError) Error

func (i *InvalidTypeError) Error() string

type NullSchema

type NullSchema struct{}

func (NullSchema) ValidateBytes

func (NullSchema) ValidateBytes(data []byte) error

type Schema

type Schema interface {
	ValidateBytes(data []byte) error
}

Schema is an interface that knows how to validate an API object serialized to a byte array.

func NewSwaggerSchemaFromBytes

func NewSwaggerSchemaFromBytes(data []byte) (Schema, error)

type ServiceLister

type ServiceLister interface {
	ListServices(api.Context) (*api.ServiceList, error)
}

ServiceLister is an abstract interface for testing.

type SwaggerSchema

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

func (*SwaggerSchema) ValidateBytes

func (s *SwaggerSchema) ValidateBytes(data []byte) error

func (*SwaggerSchema) ValidateObject

func (s *SwaggerSchema) ValidateObject(obj interface{}, apiVersion, fieldName, typeName string) error