norm

Documentation

Overview

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

Index

• func AnyDNSLabelName(raw string, opts ...AnyDNSLabelNameOption) string
• func AnyDNSLabelNameSuffixed(prefix, suffix string) string
• func AnyDNSSubdomainName(raw string) string
• func AnyQualifiedName(raw string) string
• func MetaGenerateName(raw string) string
• func MetaName(raw string) string
• func MetaNameSuffixed(prefix, suffix string) string
• type AnyDNSLabelNameOption
• type AnyDNSLabelNameOptions
  • func (o *AnyDNSLabelNameOptions) ApplyOptions(opts []AnyDNSLabelNameOption)
• type DNSNameRFC
• type WithDNSNameRFC
  • func (wdnr WithDNSNameRFC) ApplyToAnyDNSLabelNameOptions(target *AnyDNSLabelNameOptions)

Functions

func AnyDNSLabelName

func AnyDNSLabelName(raw string, opts ...AnyDNSLabelNameOption) 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 last character must be alphanumeric. In the case of RFC 1035, the first character must be alphabetical, while in the case of RFC 1123, the first character must be alphanumeric.

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 (RFC 1123): it must be all lowercase; contain only alphanumeric characters and dashes; and the first and last characters must be alphanumeric.

func AnyQualifiedName

func AnyQualifiedName(raw string) string

AnyQualifiedName normalizes a raw string so that it conforms to the structure of a Kubernetes qualified name.

Qualified names optionally start with a DNS subdomain followed by a slash. They always begin and end with an alphanumeric character, and internally may contain alphanumeric characters, dashes, underscores, and dots up to 63 characters.

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.

Types

type AnyDNSLabelNameOption

type AnyDNSLabelNameOption interface {
	ApplyToAnyDNSLabelNameOptions(target *AnyDNSLabelNameOptions)
}

type AnyDNSLabelNameOptions

type AnyDNSLabelNameOptions struct {
	DNSNameRFC DNSNameRFC
}

func (*AnyDNSLabelNameOptions) ApplyOptions

func (o *AnyDNSLabelNameOptions) ApplyOptions(opts []AnyDNSLabelNameOption)

type DNSNameRFC

type DNSNameRFC string

const (
	DNSNameRFC1035 DNSNameRFC = "1035"
	DNSNameRFC1123 DNSNameRFC = "1123"
)

type WithDNSNameRFC

type WithDNSNameRFC DNSNameRFC

func (WithDNSNameRFC) ApplyToAnyDNSLabelNameOptions

func (wdnr WithDNSNameRFC) ApplyToAnyDNSLabelNameOptions(target *AnyDNSLabelNameOptions)