kf

Documentation

Overview

Package kf contains shared code for all versions of Kf dealing with the underlying Kubernetes infrastructure it uses.

It is above any versioned directory so multiple versions can be upgraded simultaneously as back-end definitions change.

Index

• Constants
• func ErrDuplicateValue(value interface{}, fieldPaths ...string) *apis.FieldError
• func ValidateContainer(container corev1.Container) *apis.FieldError
• func ValidateContainerEnv(env corev1.EnvVar) *apis.FieldError
• func ValidateContainerPort(port corev1.ContainerPort) *apis.FieldError
• func ValidateContainerPortsArray(ports []corev1.ContainerPort) (errs *apis.FieldError)
• func ValidateContainerProbe(probe *corev1.Probe) *apis.FieldError
• func ValidateContainerResources(requirements corev1.ResourceRequirements) *apis.FieldError
• func ValidatePodSpec(podSpec corev1.PodSpec) *apis.FieldError
• func ValidatePortNumberBounds(port int32, fieldName string) *apis.FieldError

Constants

const (
	GroupName = "kf.dev"
)

GroupName is the group name used in this package

Functions

func ErrDuplicateValue

func ErrDuplicateValue(value interface{}, fieldPaths ...string) *apis.FieldError

ErrDuplicateValue creates a FieldError that indicates a value must not be duplicated.

func ValidateContainer

func ValidateContainer(container corev1.Container) *apis.FieldError

ValidateContainer performs a deep validation that the Container matches Kf's expectations.

func ValidateContainerEnv

func ValidateContainerEnv(env corev1.EnvVar) *apis.FieldError

ValidateContainerEnv performs a deep validation that the Environment Variable matches Kf's expectations.

func ValidateContainerPort

func ValidateContainerPort(port corev1.ContainerPort) *apis.FieldError

ValidateContainerPort validates a specific port.

func ValidateContainerPortsArray

func ValidateContainerPortsArray(ports []corev1.ContainerPort) (errs *apis.FieldError)

ValidateContainerPortsArray performs a deep validation that the Port matches Kf's expectations.

func ValidateContainerProbe

func ValidateContainerProbe(probe *corev1.Probe) *apis.FieldError

ValidateContainerProbe performs a deep validation that the probe matches Kf's expectations.

func ValidateContainerResources

func ValidateContainerResources(requirements corev1.ResourceRequirements) *apis.FieldError

ValidateContainerResources performs a deep validation that the quota matches Kf's expectations.

func ValidatePodSpec

func ValidatePodSpec(podSpec corev1.PodSpec) *apis.FieldError

ValidatePodSpec performs a deep validation that the PodSpec matches Kf's expectations.

func ValidatePortNumberBounds

func ValidatePortNumberBounds(port int32, fieldName string) *apis.FieldError

ValidatePortNumberBounds checks that the given port number is within acceptable ranges for a port.