parser

Documentation

Index

• Constants
• Variables
• func AnnotationsReferencesConfigmap(obj client.Object) bool
• func GetAnnotationWithPrefix(suffix string) string
• func GetBoolAnnotation(name string, obj client.Object) (bool, error)
• func GetFloatAnnotation(name string, obj client.Object) (float32, error)
• func GetIntAnnotation(name string, obj client.Object) (int, error)
• func GetStringAnnotation(name string, obj client.Object) (string, error)
• func GetStringMapAnnotation(name string, obj client.Object) (map[string]string, error)
• func GetStringSliceAnnotation(name string, obj client.Object) ([]string, error)
• func StringToURL(input string) (*url.URL, error)
• type Annotation

Constants

const DefaultAnnotationsPrefix = "k8s.ngrok.com"

DefaultAnnotationsPrefix defines the common prefix used in the nginx ingress controller

Variables

var (
	// AnnotationsPrefix is the mutable attribute that the controller explicitly refers to
	AnnotationsPrefix = DefaultAnnotationsPrefix
)

Functions

func AnnotationsReferencesConfigmap

func AnnotationsReferencesConfigmap(obj client.Object) bool

AnnotationsReferencesConfigmap checks if at least one annotation in the Ingress rule references a configmap.

func GetAnnotationWithPrefix

func GetAnnotationWithPrefix(suffix string) string

GetAnnotationWithPrefix returns the annotation prefixed with the AnnotationsPrefix

func GetBoolAnnotation

func GetBoolAnnotation(name string, obj client.Object) (bool, error)

GetBoolAnnotation extracts a boolean from a client.Object annotation

func GetFloatAnnotation

func GetFloatAnnotation(name string, obj client.Object) (float32, error)

GetFloatAnnotation extracts a float32 from a client.Object annotation

func GetIntAnnotation

func GetIntAnnotation(name string, obj client.Object) (int, error)

GetIntAnnotation extracts an int from a client.Object annotation

func GetStringAnnotation

func GetStringAnnotation(name string, obj client.Object) (string, error)

GetStringAnnotation extracts a string from an client.Object annotation

func GetStringMapAnnotation

func GetStringMapAnnotation(name string, obj client.Object) (map[string]string, error)

func GetStringSliceAnnotation

func GetStringSliceAnnotation(name string, obj client.Object) ([]string, error)

func StringToURL

func StringToURL(input string) (*url.URL, error)

StringToURL parses the provided string into URL and returns error message in case of failure

Types

type Annotation

type Annotation interface {
	Parse(obj client.Object) (interface{}, error)
}

Annotation has a method to parse annotations located in client.Object