ingress

Documentation

Index

• func GlobalApply() reactive.Pipe
• func GlobalCustomTLS() reactive.Pipe
• func GlobalDiffuser(pipeline reactive.Subjectable) reactive.Pipe
• func GlobalPipe(f func(ctx *GlobalContext, errs []error) []error) reactive.Pipe
• func GlobalStatus() reactive.Pipe
• func SpecificBasicAuth() reactive.Pipe
• func SpecificHeaders() reactive.Pipe
• func SpecificMarker() reactive.Pipe
• func SpecificMatcher() reactive.Pipe
• func SpecificPipe(f func(ctx *SpecificContext, errs []error) []error) reactive.Pipe
• func SpecificReverseProxy() reactive.Pipe
• func SpecificRewriteTarget() reactive.Pipe
• type Authentication
• type AuthenticationHttpBasic
• type AuthenticationHttpBasicAccount
• type AuthenticationProviders
• type Context
  • func (s Context) IsNewer(routeIdentifier string) bool
  • func (s Context) RouteIdentifier() string
• type ContextMode
• type GlobalContext
• type SpecificContext
• type SupportedBackend
• type Uri
• type UriRegexp

Functions

func GlobalApply

func GlobalApply() reactive.Pipe

GlobalApply applies the routes to the caddy server

func GlobalCustomTLS

func GlobalCustomTLS() reactive.Pipe

func GlobalDiffuser

func GlobalDiffuser(pipeline reactive.Subjectable) reactive.Pipe

GlobalDiffuser is a reactive pipe that generates routes by executing the specified pipeline for each ingress path in each rule.

func GlobalPipe

func GlobalPipe(f func(ctx *GlobalContext, errs []error) []error) reactive.Pipe

GlobalPipe is a pipe which takes the output of a previous GlobalPipe, works with received input and then again produces an output for the next GlobalPipe

func GlobalStatus

func GlobalStatus() reactive.Pipe

GlobalStatus adds the LB status to the ingress objects

func SpecificBasicAuth

func SpecificBasicAuth() reactive.Pipe

SpecificBasicAuth configures a route to authenticate requests using basic auth

func SpecificHeaders

func SpecificHeaders() reactive.Pipe

SpecificHeaders applies custom headers to the response. For example caching directives, CORS, etc.

func SpecificMarker

func SpecificMarker() reactive.Pipe

SpecificMarker marks the route generated with the ingress uid and generation

func SpecificMatcher

func SpecificMatcher() reactive.Pipe

SpecificMatcher configures the route's matcher to only match the given ingress route and path

func SpecificPipe

func SpecificPipe(f func(ctx *SpecificContext, errs []error) []error) reactive.Pipe

SpecificPipe is a pipe which takes the output of a previous SpecificPipe, works with received input and then again produces an output for the next SpecificPipe

func SpecificReverseProxy

func SpecificReverseProxy() reactive.Pipe

SpecificReverseProxy configures the route's backend to be a reverse proxy to the configured ingress service

func SpecificRewriteTarget

func SpecificRewriteTarget() reactive.Pipe

SpecificRewriteTarget configures the route to rewrite the backend's path

Types

type Authentication

type Authentication struct {
	Providers AuthenticationProviders `json:"providers,omitempty"`
}

type AuthenticationHttpBasic

type AuthenticationHttpBasic struct {
	Accounts []AuthenticationHttpBasicAccount `json:"accounts,omitempty"`
}

type AuthenticationHttpBasicAccount

type AuthenticationHttpBasicAccount struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	Salt     string `json:"salt,omitempty"`
}

type AuthenticationProviders

type AuthenticationProviders struct {
	HttpBasic AuthenticationHttpBasic `json:"http_basic,omitempty"`
}

type Context

type Context struct {
	Ingress *networkingv1.Ingress
	Mode    ContextMode
}

func (Context) IsNewer

func (s Context) IsNewer(routeIdentifier string) bool

func (Context) RouteIdentifier

func (s Context) RouteIdentifier() string

type ContextMode

type ContextMode int

const (
	// ContextModeConfigure is the context mode for adding or updating an ingress
	ContextModeConfigure ContextMode = iota
	// ContextModeDelete is the context mode for removing an ingress
	ContextModeDelete
)

type GlobalContext

type GlobalContext struct {
	Context
	Hosts  []string
	Routes []*caddyhttp.Route
}

type SpecificContext

type SpecificContext struct {
	Context
	Path  networkingv1.HTTPIngressPath
	Route *caddyhttp.Route
	Rule  networkingv1.IngressRule
}

type SupportedBackend

type SupportedBackend string

const (
	BackendHTTP  SupportedBackend = "http"
	BackendHTTPS SupportedBackend = "https"
)

type Uri

type Uri struct {
	Regexp []UriRegexp `json:"path_regexp"`
}

type UriRegexp

type UriRegexp struct {
	Find    string `json:"find"`
	Replace string `json:"replace"`
}