norm

Documentation

Overview

Package norm provides normalization routines for making arbitrary text compatible with Kubernetes's field requirements.

Index

• func AnyDNSLabelName(raw string) string
• func AnyDNSLabelNameSuffixed(prefix, suffix string) string
• func AnyDNSSubdomainName(raw string) string
• func MetaGenerateName(raw string) string
• func MetaName(raw string) string
• func MetaNameSuffixed(prefix, suffix string) string

Functions

func AnyDNSLabelName

func AnyDNSLabelName(raw string) string

AnyDNSLabelName normalizes a raw string so that it conforms to the structure of a DNS label: it must be all lowercase, contain only alphanumeric characters and dashes, and the first and last characters must be alphameric.

func AnyDNSLabelNameSuffixed

func AnyDNSLabelNameSuffixed(prefix, suffix string) string

AnyDNSLabelNameSuffixed calls AnyDNSLabelName ensuring that the entirety of the given suffix is retained if possible.

func AnyDNSSubdomainName

func AnyDNSSubdomainName(raw string) string

AnyDNSSubdomainName normalizes a raw string so that it conforms to the structure of a DNS domain: it must be all lowercase; contain only alphanumeric characters, dashes, and dots; and the first and last characters must be alphameric.

func MetaGenerateName

func MetaGenerateName(raw string) string

MetaGenerateName normalizes a Kubernetes metadata generateName field. It is opinionated in that it also forces a dash before the five characters generated by the Kubernetes API.

func MetaName

func MetaName(raw string) string

MetaName normalizes a Kubernetes metadata name field.

func MetaNameSuffixed

func MetaNameSuffixed(prefix, suffix string) string

MetaNameSuffixed normalizes a Kubernetes metadata name field ensuring that the entirety of the given suffix is retained if possible.