annotations

Documentation

Index

• Constants
• type Extractor
  • func NewAnnotationExtractor(cfg resolver.Resolver) Extractor
  • func (e Extractor) Extract(ing *networking.Ingress) *Ingress
• type Ingress

Constants

const DeniedKeyName = "Denied"

DeniedKeyName name of the key that contains the reason to deny a location

Types

type Extractor

type Extractor struct {
	// contains filtered or unexported fields
}

Extractor defines the annotation parsers to be used in the extraction of annotations

func NewAnnotationExtractor

func NewAnnotationExtractor(cfg resolver.Resolver) Extractor

NewAnnotationExtractor creates a new annotations extractor

func (Extractor) Extract

func (e Extractor) Extract(ing *networking.Ingress) *Ingress

Extract extracts the annotations from an Ingress

type Ingress

type Ingress struct {
	metav1.ObjectMeta
	BackendProtocol      string
	Aliases              []string
	BasicDigestAuth      auth.Config
	Canary               canary.Config
	CertificateAuth      authtls.Config
	ClientBodyBufferSize string
	ConfigurationSnippet string
	Connection           connection.Config
	CorsConfig           cors.Config
	CustomHTTPErrors     []int
	DefaultBackend       *apiv1.Service
	//TODO: Change this back into an error when https://github.com/imdario/mergo/issues/100 is resolved
	FastCGI            fastcgi.Config
	Denied             *string
	ExternalAuth       authreq.Config
	EnableGlobalAuth   bool
	HTTP2PushPreload   bool
	Opentracing        opentracing.Config
	Proxy              proxy.Config
	ProxySSL           proxyssl.Config
	RateLimit          ratelimit.Config
	GlobalRateLimit    globalratelimit.Config
	Redirect           redirect.Config
	Rewrite            rewrite.Config
	Satisfy            string
	SecureUpstream     secureupstream.Config
	ServerSnippet      string
	ServiceUpstream    bool
	SessionAffinity    sessionaffinity.Config
	SSLPassthrough     bool
	UsePortInRedirects bool
	UpstreamHashBy     upstreamhashby.Config
	LoadBalancing      string
	UpstreamVhost      string
	Whitelist          ipwhitelist.SourceRange
	XForwardedPrefix   string
	SSLCipher          sslcipher.Config
	Logs               log.Config
	InfluxDB           influxdb.Config
	ModSecurity        modsecurity.Config
	Mirror             mirror.Config
}

Ingress defines the valid annotations present in one NGINX Ingress rule