ingress

Documentation

Index

• type Configuration
• type Location
• type LocationByPath
  • func (c LocationByPath) Len() int
  • func (c LocationByPath) Less(i, j int) bool
  • func (c LocationByPath) Swap(i, j int)
• type SSLCert
• type Server
• type ServerByName
  • func (c ServerByName) Len() int
  • func (c ServerByName) Less(i, j int) bool
  • func (c ServerByName) Swap(i, j int)
• type Upstream
• type UpstreamByNameServers
  • func (c UpstreamByNameServers) Len() int
  • func (c UpstreamByNameServers) Less(i, j int) bool
  • func (c UpstreamByNameServers) Swap(i, j int)
• type UpstreamServer
• type UpstreamServerByAddrPort
  • func (c UpstreamServerByAddrPort) Len() int
  • func (c UpstreamServerByAddrPort) Less(i, j int) bool
  • func (c UpstreamServerByAddrPort) Swap(i, j int)

Types

type Configuration

type Configuration struct {
	Upstreams    []*Upstream
	Servers      []*Server
	TCPUpstreams []*Location
	UDPUpstreams []*Location
}

Configuration describes an NGINX configuration

type Location

type Location struct {
	Path            string
	IsDefBackend    bool
	Upstream        Upstream
	Auth            auth.Nginx
	RateLimit       ratelimit.RateLimit
	Redirect        rewrite.Redirect
	SecureUpstream  bool
	Whitelist       ipwhitelist.SourceRange
	EnableCORS      bool
	ExternalAuthURL authreq.Auth
}

Location describes an NGINX location

type LocationByPath

type LocationByPath []*Location

LocationByPath sorts location by path Location / is the last one

func (LocationByPath) Len

func (c LocationByPath) Len() int

func (LocationByPath) Less

func (c LocationByPath) Less(i, j int) bool

func (LocationByPath) Swap

func (c LocationByPath) Swap(i, j int)

type SSLCert

type SSLCert struct {
	CertFileName string
	KeyFileName  string
	// PemFileName contains the path to the file with the certificate and key concatenated
	PemFileName string
	// PemSHA contains the sha1 of the pem file.
	// This is used to detect changes in the secret that contains the certificates
	PemSHA string
	// CN contains all the common names defined in the SSL certificate
	CN []string
}

SSLCert describes a SSL certificate to be used in NGINX

type Server

type Server struct {
	Name              string
	Locations         []*Location
	SSL               bool
	SSLCertificate    string
	SSLCertificateKey string
	SSLPemChecksum    string
}

Server describes an NGINX server

type ServerByName

type ServerByName []*Server

ServerByName sorts server by name

func (ServerByName) Len

func (c ServerByName) Len() int

func (ServerByName) Less

func (c ServerByName) Less(i, j int) bool

func (ServerByName) Swap

func (c ServerByName) Swap(i, j int)

type Upstream

type Upstream struct {
	Name     string
	Backends []UpstreamServer
	Secure   bool
}

Upstream describes an NGINX upstream

type UpstreamByNameServers

type UpstreamByNameServers []*Upstream

UpstreamByNameServers sorts upstreams by name

func (UpstreamByNameServers) Len

func (c UpstreamByNameServers) Len() int

func (UpstreamByNameServers) Less

func (c UpstreamByNameServers) Less(i, j int) bool

func (UpstreamByNameServers) Swap

func (c UpstreamByNameServers) Swap(i, j int)

type UpstreamServer

type UpstreamServer struct {
	Address     string
	Port        string
	MaxFails    int
	FailTimeout int
}

UpstreamServer describes a server in an NGINX upstream

type UpstreamServerByAddrPort

type UpstreamServerByAddrPort []UpstreamServer

UpstreamServerByAddrPort sorts upstream servers by address and port

func (UpstreamServerByAddrPort) Len

func (c UpstreamServerByAddrPort) Len() int

func (UpstreamServerByAddrPort) Less

func (c UpstreamServerByAddrPort) Less(i, j int) bool

func (UpstreamServerByAddrPort) Swap

func (c UpstreamServerByAddrPort) Swap(i, j int)