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 ¶
- Constants
- Variables
- func AccumulateUniqueHostPorts(containers []api.Container, accumulator *sets.String) validation.ErrorList
- func IntervalErrorMsg(lo, hi int) string
- func IsSecretKey(value string) bool
- func IsValidPathSegmentName(name string) (bool, string)
- func IsValidPathSegmentPrefix(name string) (bool, string)
- func NameIsDNS952Label(name string, prefix bool) (bool, string)
- func NameIsDNSLabel(name string, prefix bool) (bool, string)
- func NameIsDNSSubdomain(name string, prefix bool) (bool, string)
- func NewInvalidTypeError(expected reflect.Kind, observed reflect.Kind, fieldName string) error
- func ValidateAnnotations(annotations map[string]string, field string) validation.ErrorList
- func ValidateEndpoints(endpoints *api.Endpoints) validation.ErrorList
- func ValidateEndpointsName(name string, prefix bool) (bool, string)
- func ValidateEndpointsUpdate(newEndpoints, oldEndpoints *api.Endpoints) validation.ErrorList
- func ValidateEvent(event *api.Event) validation.ErrorList
- func ValidateImmutableField(new, old interface{}, fieldName string) validation.ErrorList
- func ValidateLabelName(labelName, fieldName string) validation.ErrorList
- func ValidateLabels(labels map[string]string, field string) validation.ErrorList
- func ValidateLimitRange(limitRange *api.LimitRange) validation.ErrorList
- func ValidateLimitRangeName(name string, prefix bool) (bool, string)
- func ValidateLoadBalancerStatus(status *api.LoadBalancerStatus) validation.ErrorList
- func ValidateNamespace(namespace *api.Namespace) validation.ErrorList
- func ValidateNamespaceFinalizeUpdate(newNamespace, oldNamespace *api.Namespace) validation.ErrorList
- func ValidateNamespaceName(name string, prefix bool) (bool, string)
- func ValidateNamespaceStatusUpdate(newNamespace, oldNamespace *api.Namespace) validation.ErrorList
- func ValidateNamespaceUpdate(newNamespace *api.Namespace, oldNamespace *api.Namespace) validation.ErrorList
- func ValidateNode(node *api.Node) validation.ErrorList
- func ValidateNodeName(name string, prefix bool) (bool, string)
- func ValidateNodeUpdate(node, oldNode *api.Node) validation.ErrorList
- func ValidateNonEmptySelector(selectorMap map[string]string, fieldName string) validation.ErrorList
- func ValidateObjectMeta(meta *api.ObjectMeta, requiresNamespace bool, nameFn ValidateNameFunc) validation.ErrorList
- func ValidateObjectMetaUpdate(new, old *api.ObjectMeta) validation.ErrorList
- func ValidatePathSegmentName(name string, prefix bool) (bool, string)
- func ValidatePersistentVolume(pv *api.PersistentVolume) validation.ErrorList
- func ValidatePersistentVolumeClaim(pvc *api.PersistentVolumeClaim) validation.ErrorList
- func ValidatePersistentVolumeClaimStatusUpdate(newPvc, oldPvc *api.PersistentVolumeClaim) validation.ErrorList
- func ValidatePersistentVolumeClaimUpdate(newPvc, oldPvc *api.PersistentVolumeClaim) validation.ErrorList
- func ValidatePersistentVolumeName(name string, prefix bool) (bool, string)
- func ValidatePersistentVolumeStatusUpdate(newPv, oldPv *api.PersistentVolume) validation.ErrorList
- func ValidatePersistentVolumeUpdate(newPv, oldPv *api.PersistentVolume) validation.ErrorList
- func ValidatePod(pod *api.Pod) validation.ErrorList
- func ValidatePodLogOptions(opts *api.PodLogOptions) validation.ErrorList
- func ValidatePodName(name string, prefix bool) (bool, string)
- func ValidatePodSecurityContext(securityContext *api.PodSecurityContext, spec *api.PodSpec) validation.ErrorList
- func ValidatePodSpec(spec *api.PodSpec) validation.ErrorList
- func ValidatePodStatusUpdate(newPod, oldPod *api.Pod) validation.ErrorList
- func ValidatePodTemplate(pod *api.PodTemplate) validation.ErrorList
- func ValidatePodTemplateSpec(spec *api.PodTemplateSpec) validation.ErrorList
- func ValidatePodTemplateSpecForRC(template *api.PodTemplateSpec, selectorMap map[string]string, replicas int, ...) validation.ErrorList
- func ValidatePodTemplateUpdate(newPod, oldPod *api.PodTemplate) validation.ErrorList
- func ValidatePodUpdate(newPod, oldPod *api.Pod) validation.ErrorList
- func ValidatePositiveField(value int64, fieldName string) validation.ErrorList
- func ValidatePositiveQuantity(value resource.Quantity, fieldName string) validation.ErrorList
- func ValidateReadOnlyPersistentDisks(volumes []api.Volume) validation.ErrorList
- func ValidateReplicationController(controller *api.ReplicationController) validation.ErrorList
- func ValidateReplicationControllerName(name string, prefix bool) (bool, string)
- func ValidateReplicationControllerSpec(spec *api.ReplicationControllerSpec) validation.ErrorList
- func ValidateReplicationControllerStatusUpdate(controller, oldController *api.ReplicationController) validation.ErrorList
- func ValidateReplicationControllerUpdate(controller, oldController *api.ReplicationController) validation.ErrorList
- func ValidateResourceQuota(resourceQuota *api.ResourceQuota) validation.ErrorList
- func ValidateResourceQuotaName(name string, prefix bool) (bool, string)
- func ValidateResourceQuotaStatusUpdate(newResourceQuota, oldResourceQuota *api.ResourceQuota) validation.ErrorList
- func ValidateResourceQuotaUpdate(newResourceQuota, oldResourceQuota *api.ResourceQuota) validation.ErrorList
- func ValidateResourceRequirements(requirements *api.ResourceRequirements) validation.ErrorList
- func ValidateSecret(secret *api.Secret) validation.ErrorList
- func ValidateSecretName(name string, prefix bool) (bool, string)
- func ValidateSecretUpdate(newSecret, oldSecret *api.Secret) validation.ErrorList
- func ValidateSecurityContext(sc *api.SecurityContext) validation.ErrorList
- func ValidateService(service *api.Service) validation.ErrorList
- func ValidateServiceAccount(serviceAccount *api.ServiceAccount) validation.ErrorList
- func ValidateServiceAccountName(name string, prefix bool) (bool, string)
- func ValidateServiceAccountUpdate(newServiceAccount, oldServiceAccount *api.ServiceAccount) validation.ErrorList
- func ValidateServiceName(name string, prefix bool) (bool, string)
- func ValidateServiceUpdate(service, oldService *api.Service) validation.ErrorList
- type InvalidTypeError
- type NullSchema
- type Schema
- type SwaggerSchema
- type ValidateNameFunc
Constants ¶
const SecretKeyFmt string = "\\.?" + validation.DNS1123LabelFmt + "(\\." + validation.DNS1123LabelFmt + ")*"
Variables ¶
var DNS1123LabelErrorMsg string = fmt.Sprintf(`must be a DNS label (at most %d characters, matching regex %s): e.g. "my-name"`, validation.DNS1123LabelMaxLength, validation.DNS1123LabelFmt)
var DNS952LabelErrorMsg string = fmt.Sprintf(`must be a DNS 952 label (at most %d characters, matching regex %s): e.g. "my-name"`, validation.DNS952LabelMaxLength, validation.DNS952LabelFmt)
var DNSSubdomainErrorMsg string = fmt.Sprintf(`must be a DNS subdomain (at most %d characters, matching regex %s): e.g. "example.com"`, validation.DNS1123SubdomainMaxLength, validation.DNS1123SubdomainFmt)
var NameMayNotBe = []string{".", ".."}
NameMayNotBe specifies strings that cannot be used as names specified as path segments (like the REST API or etcd store)
var NameMayNotContain = []string{"/", "%"}
NameMayNotContain specifies substrings that cannot be used in names specified as path segments (like the REST API or etcd store)
var PortNameErrorMsg string = fmt.Sprintf(`must be an IANA_SVC_NAME (at most 15 characters, matching regex %s, it must contain at least one letter [a-z], and hyphens cannot be adjacent to other hyphens): e.g. "http"`, validation.IdentifierNoHyphensBeginEndFmt)
var PortRangeErrorMsg string = IntervalErrorMsg(0, 65536)
var RepairMalformedUpdates bool = true
TODO: delete this global variable when we enable the validation of common fields by default.
Functions ¶
func AccumulateUniqueHostPorts ¶
func AccumulateUniqueHostPorts(containers []api.Container, accumulator *sets.String) validation.ErrorList
AccumulateUniqueHostPorts extracts each HostPort of each Container, accumulating the results and returning an error if any ports conflict.
func IntervalErrorMsg ¶
func IsSecretKey ¶
IsSecretKey tests for a string that conforms to the definition of a subdomain in DNS (RFC 1123), except that a leading dot is allowed
func IsValidPathSegmentName ¶
IsValidPathSegmentName validates the name can be safely encoded as a path segment
func IsValidPathSegmentPrefix ¶
IsValidPathSegmentPrefix validates the name can be used as a prefix for a name which will be encoded as a path segment It does not check for exact matches with disallowed names, since an arbitrary suffix might make the name valid
func NameIsDNS952Label ¶
NameIsDNS952Label is a ValidateNameFunc for names that must be a DNS 952 label.
func NameIsDNSLabel ¶
NameIsDNSLabel is a ValidateNameFunc for names that must be a DNS 1123 label.
func NameIsDNSSubdomain ¶
NameIsDNSSubdomain is a ValidateNameFunc for names that must be a DNS subdomain.
func NewInvalidTypeError ¶
func ValidateAnnotations ¶
func ValidateAnnotations(annotations map[string]string, field string) validation.ErrorList
ValidateAnnotations validates that a set of annotations are correctly defined.
func ValidateEndpoints ¶
func ValidateEndpoints(endpoints *api.Endpoints) validation.ErrorList
ValidateEndpoints tests if required fields are set.
func ValidateEndpointsName ¶
ValidateEndpointsName can be used to check whether the given endpoints name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateEndpointsUpdate ¶
func ValidateEndpointsUpdate(newEndpoints, oldEndpoints *api.Endpoints) validation.ErrorList
ValidateEndpointsUpdate tests to make sure an endpoints update can be applied.
func ValidateEvent ¶
func ValidateEvent(event *api.Event) validation.ErrorList
ValidateEvent makes sure that the event makes sense.
func ValidateImmutableField ¶
func ValidateImmutableField(new, old interface{}, fieldName string) validation.ErrorList
func ValidateLabelName ¶
func ValidateLabelName(labelName, fieldName string) validation.ErrorList
func ValidateLabels ¶
func ValidateLabels(labels map[string]string, field string) validation.ErrorList
ValidateLabels validates that a set of labels are correctly defined.
func ValidateLimitRange ¶
func ValidateLimitRange(limitRange *api.LimitRange) validation.ErrorList
ValidateLimitRange tests if required fields in the LimitRange are set.
func ValidateLimitRangeName ¶
ValidateLimitRangeName can be used to check whether the given limit range name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateLoadBalancerStatus ¶
func ValidateLoadBalancerStatus(status *api.LoadBalancerStatus) validation.ErrorList
ValidateLoadBalancerStatus validates required fields on a LoadBalancerStatus
func ValidateNamespace ¶
func ValidateNamespace(namespace *api.Namespace) validation.ErrorList
ValidateNamespace tests if required fields are set.
func ValidateNamespaceFinalizeUpdate ¶
func ValidateNamespaceFinalizeUpdate(newNamespace, oldNamespace *api.Namespace) validation.ErrorList
ValidateNamespaceFinalizeUpdate tests to see if the update is legal for an end user to make. newNamespace is updated with fields that cannot be changed.
func ValidateNamespaceName ¶
ValidateNamespaceName can be used to check whether the given namespace name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateNamespaceStatusUpdate ¶
func ValidateNamespaceStatusUpdate(newNamespace, oldNamespace *api.Namespace) validation.ErrorList
ValidateNamespaceStatusUpdate tests to see if the update is legal for an end user to make. newNamespace is updated with fields that cannot be changed.
func ValidateNamespaceUpdate ¶
func ValidateNamespaceUpdate(newNamespace *api.Namespace, oldNamespace *api.Namespace) validation.ErrorList
ValidateNamespaceUpdate tests to make sure a namespace update can be applied. newNamespace is updated with fields that cannot be changed
func ValidateNode ¶
func ValidateNode(node *api.Node) validation.ErrorList
ValidateNode tests if required fields in the node are set.
func ValidateNodeName ¶
ValidateNodeName can be used to check whether the given node name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateNodeUpdate ¶
func ValidateNodeUpdate(node, oldNode *api.Node) validation.ErrorList
ValidateNodeUpdate tests to make sure a node update can be applied. Modifies oldNode.
func ValidateNonEmptySelector ¶
func ValidateNonEmptySelector(selectorMap map[string]string, fieldName string) validation.ErrorList
Validates that the given selector is non-empty.
func ValidateObjectMeta ¶
func ValidateObjectMeta(meta *api.ObjectMeta, requiresNamespace bool, nameFn ValidateNameFunc) validation.ErrorList
ValidateObjectMeta validates an object's metadata on creation. It expects that name generation has already been performed. It doesn't return an error for rootscoped resources with namespace, because namespace should already be cleared before. TODO: Remove calls to this method scattered in validations of specific resources, e.g., ValidatePodUpdate.
func ValidateObjectMetaUpdate ¶
func ValidateObjectMetaUpdate(new, old *api.ObjectMeta) validation.ErrorList
ValidateObjectMetaUpdate validates an object's metadata when updated
func ValidatePathSegmentName ¶
ValidatePathSegmentName validates the name can be safely encoded as a path segment
func ValidatePersistentVolume ¶
func ValidatePersistentVolume(pv *api.PersistentVolume) validation.ErrorList
func ValidatePersistentVolumeClaim ¶
func ValidatePersistentVolumeClaim(pvc *api.PersistentVolumeClaim) validation.ErrorList
func ValidatePersistentVolumeClaimStatusUpdate ¶
func ValidatePersistentVolumeClaimStatusUpdate(newPvc, oldPvc *api.PersistentVolumeClaim) validation.ErrorList
func ValidatePersistentVolumeClaimUpdate ¶
func ValidatePersistentVolumeClaimUpdate(newPvc, oldPvc *api.PersistentVolumeClaim) validation.ErrorList
func ValidatePersistentVolumeStatusUpdate ¶
func ValidatePersistentVolumeStatusUpdate(newPv, oldPv *api.PersistentVolume) validation.ErrorList
ValidatePersistentVolumeStatusUpdate tests to see if the status update is legal for an end user to make. newPv is updated with fields that cannot be changed.
func ValidatePersistentVolumeUpdate ¶
func ValidatePersistentVolumeUpdate(newPv, oldPv *api.PersistentVolume) validation.ErrorList
ValidatePersistentVolumeUpdate tests to see if the update is legal for an end user to make. newPv is updated with fields that cannot be changed.
func ValidatePod ¶
func ValidatePod(pod *api.Pod) validation.ErrorList
ValidatePod tests if required fields in the pod are set.
func ValidatePodLogOptions ¶
func ValidatePodLogOptions(opts *api.PodLogOptions) validation.ErrorList
func ValidatePodName ¶
ValidatePodName can be used to check whether the given pod name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidatePodSecurityContext ¶
func ValidatePodSecurityContext(securityContext *api.PodSecurityContext, spec *api.PodSpec) validation.ErrorList
ValidatePodSecurityContext test that the specified PodSecurityContext has valid data.
func ValidatePodSpec ¶
func ValidatePodSpec(spec *api.PodSpec) validation.ErrorList
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 ValidatePodStatusUpdate ¶
func ValidatePodStatusUpdate(newPod, oldPod *api.Pod) validation.ErrorList
ValidatePodStatusUpdate tests to see if the update is legal for an end user to make. newPod is updated with fields that cannot be changed.
func ValidatePodTemplate ¶
func ValidatePodTemplate(pod *api.PodTemplate) validation.ErrorList
ValidatePodTemplate tests if required fields in the pod template are set.
func ValidatePodTemplateSpec ¶
func ValidatePodTemplateSpec(spec *api.PodTemplateSpec) validation.ErrorList
ValidatePodTemplateSpec validates the spec of a pod template
func ValidatePodTemplateSpecForRC ¶
func ValidatePodTemplateSpecForRC(template *api.PodTemplateSpec, selectorMap map[string]string, replicas int, fieldName string) validation.ErrorList
Validates the given template and ensures that it is in accordance with the desrired selector and replicas.
func ValidatePodTemplateUpdate ¶
func ValidatePodTemplateUpdate(newPod, oldPod *api.PodTemplate) validation.ErrorList
ValidatePodTemplateUpdate tests to see if the update is legal for an end user to make. newPod is updated with fields that cannot be changed.
func ValidatePodUpdate ¶
func ValidatePodUpdate(newPod, oldPod *api.Pod) validation.ErrorList
ValidatePodUpdate tests to see if the update is legal for an end user to make. newPod is updated with fields that cannot be changed.
func ValidatePositiveField ¶
func ValidatePositiveField(value int64, fieldName string) validation.ErrorList
Validates that given value is not negative.
func ValidatePositiveQuantity ¶
func ValidatePositiveQuantity(value resource.Quantity, fieldName string) validation.ErrorList
Validates that a Quantity is not negative
func ValidateReadOnlyPersistentDisks ¶
func ValidateReadOnlyPersistentDisks(volumes []api.Volume) validation.ErrorList
func ValidateReplicationController ¶
func ValidateReplicationController(controller *api.ReplicationController) validation.ErrorList
ValidateReplicationController tests if required fields in the replication controller are set.
func ValidateReplicationControllerName ¶
ValidateReplicationControllerName can be used to check whether the given replication controller name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateReplicationControllerSpec ¶
func ValidateReplicationControllerSpec(spec *api.ReplicationControllerSpec) validation.ErrorList
ValidateReplicationControllerSpec tests if required fields in the replication controller spec are set.
func ValidateReplicationControllerStatusUpdate ¶
func ValidateReplicationControllerStatusUpdate(controller, oldController *api.ReplicationController) validation.ErrorList
ValidateReplicationControllerStatusUpdate tests if required fields in the replication controller are set.
func ValidateReplicationControllerUpdate ¶
func ValidateReplicationControllerUpdate(controller, oldController *api.ReplicationController) validation.ErrorList
ValidateReplicationControllerUpdate tests if required fields in the replication controller are set.
func ValidateResourceQuota ¶
func ValidateResourceQuota(resourceQuota *api.ResourceQuota) validation.ErrorList
ValidateResourceQuota tests if required fields in the ResourceQuota are set.
func ValidateResourceQuotaName ¶
ValidateResourceQuotaName can be used to check whether the given resource quota name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateResourceQuotaStatusUpdate ¶
func ValidateResourceQuotaStatusUpdate(newResourceQuota, oldResourceQuota *api.ResourceQuota) validation.ErrorList
ValidateResourceQuotaStatusUpdate tests to see if the status update is legal for an end user to make. newResourceQuota is updated with fields that cannot be changed.
func ValidateResourceQuotaUpdate ¶
func ValidateResourceQuotaUpdate(newResourceQuota, oldResourceQuota *api.ResourceQuota) validation.ErrorList
ValidateResourceQuotaUpdate tests to see if the update is legal for an end user to make. newResourceQuota is updated with fields that cannot be changed.
func ValidateResourceRequirements ¶
func ValidateResourceRequirements(requirements *api.ResourceRequirements) validation.ErrorList
Validates resource requirement spec.
func ValidateSecret ¶
func ValidateSecret(secret *api.Secret) validation.ErrorList
ValidateSecret tests if required fields in the Secret are set.
func ValidateSecretName ¶
ValidateSecretName can be used to check whether the given secret name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateSecretUpdate ¶
func ValidateSecretUpdate(newSecret, oldSecret *api.Secret) validation.ErrorList
ValidateSecretUpdate tests if required fields in the Secret are set.
func ValidateSecurityContext ¶
func ValidateSecurityContext(sc *api.SecurityContext) validation.ErrorList
ValidateSecurityContext ensure the security context contains valid settings
func ValidateService ¶
func ValidateService(service *api.Service) validation.ErrorList
ValidateService tests if required fields in the service are set.
func ValidateServiceAccount ¶
func ValidateServiceAccount(serviceAccount *api.ServiceAccount) validation.ErrorList
ValidateServiceAccount tests if required fields in the ServiceAccount are set.
func ValidateServiceAccountName ¶
ValidateServiceAccountName can be used to check whether the given service account name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateServiceAccountUpdate ¶
func ValidateServiceAccountUpdate(newServiceAccount, oldServiceAccount *api.ServiceAccount) validation.ErrorList
ValidateServiceAccountUpdate tests if required fields in the ServiceAccount are set.
func ValidateServiceName ¶
ValidateServiceName can be used to check whether the given service name is valid. Prefix indicates this name will be used as part of generation, in which case trailing dashes are allowed.
func ValidateServiceUpdate ¶
func ValidateServiceUpdate(service, oldService *api.Service) validation.ErrorList
ValidateServiceUpdate tests if required fields in the service are set during an update
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 ¶
Schema is an interface that knows how to validate an API object serialized to a byte array.
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{}, fieldName, typeName string) validation.ErrorList