types

package
v0.17.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 15, 2026 License: Apache-2.0 Imports: 15 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	MatchBegin  = MatchType("begin")
	MatchExact  = MatchType("exact")
	MatchPrefix = MatchType("prefix")
	MatchRegex  = MatchType("regex")
)

...

View Source 
const DefaultHost = "<default>"

DefaultHost ...

View Source 
const HTTPResponseGlobalID = "global"
View Source 
const PeersGroupNameGlobal = "global"
View Source 
const PeersTableNamePrefix = "_peers_"

Variables

View Source 
var DefaultMatchOrder = []MatchType{MatchExact, MatchPrefix, MatchBegin, MatchRegex}

DefaultMatchOrder ...

Functions

This section is empty.

Types

type AccessConfig added in v0.12.1 

type AccessConfig struct {
	Rule         []string
	Exception    []string
	SourceHeader string
}

AccessConfig ...

type Acme added in v0.9.1 

type Acme struct {
	Enabled bool
	Prefix  string
	Shared  bool
	Socket  string
}

Acme ...

type AcmeCerts added in v0.11.1 

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

AcmeCerts ...

func (*AcmeCerts) AddDomains added in v0.11.1 

func (c *AcmeCerts) AddDomains(domains []string)

AddDomains ...

func (*AcmeCerts) AssignPreferredChain added in v0.13.5 

func (c *AcmeCerts) AssignPreferredChain(preferredChain string) error

AssignPreferredChain ...

type AcmeData added in v0.9.1 

type AcmeData struct {
	Emails      string
	Endpoint    string
	Expiring    time.Duration
	TermsAgreed bool
	// contains filtered or unexported fields
}

AcmeData ...

func (*AcmeData) Storages added in v0.11.1 

func (acme *AcmeData) Storages() *AcmeStorages

Storages ...

type AcmeStorages added in v0.11.1 

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

AcmeStorages ...

func (*AcmeStorages) Acquire added in v0.11.1 

func (c *AcmeStorages) Acquire(name string) *AcmeCerts

Acquire ...

func (*AcmeStorages) BuildAcmeStorages added in v0.11.1 

func (c *AcmeStorages) BuildAcmeStorages() []string

BuildAcmeStorages ...

func (*AcmeStorages) BuildAcmeStoragesAdd added in v0.11.1 

func (c *AcmeStorages) BuildAcmeStoragesAdd() []string

BuildAcmeStoragesAdd ...

func (*AcmeStorages) BuildAcmeStoragesDel added in v0.11.1 

func (c *AcmeStorages) BuildAcmeStoragesDel() []string

BuildAcmeStoragesDel ...

func (*AcmeStorages) Commit added in v0.11.1 

func (c *AcmeStorages) Commit()

Commit ...

func (*AcmeStorages) RemoveAll added in v0.11.1 

func (c *AcmeStorages) RemoveAll(names []string)

RemoveAll ...

func (*AcmeStorages) Updated added in v0.11.1 

func (c *AcmeStorages) Updated() bool

Updated ...

type AgentCheck 

type AgentCheck struct {
	Addr     string
	Interval string
	Port     int
	Send     string
}

AgentCheck ...

type AuthExternal added in v0.13.0 

type AuthExternal struct {
	AllowedPath     string
	AlwaysDeny      bool
	AuthBackendName string
	AuthPath        string
	HeadersFail     []string
	HeadersRequest  []string
	HeadersSucceed  []string
	HeadersVars     map[string]string
	Method          string
	RedirectOnFail  string
}

AuthExternal ...

type AuthHTTP added in v0.12.1 

type AuthHTTP struct {
	UserlistName string
	Realm        string
}

AuthHTTP ...

type AuthProxy added in v0.13.0 

type AuthProxy struct {
	BindList   []*AuthProxyBind
	Name       string
	RangeEnd   int
	RangeStart int
	// contains filtered or unexported fields
}

AuthProxy ...

func (*AuthProxy) AcquireAuthBackendName 

func (proxy *AuthProxy) AcquireAuthBackendName(backend BackendID) (authBackendName string, err error)

AcquireAuthBackendName ...

func (*AuthProxy) RemoveAuthBackendByTarget 

func (proxy *AuthProxy) RemoveAuthBackendByTarget(backends []string)

RemoveAuthBackendByTarget ...

func (*AuthProxy) RemoveAuthBackendExcept 

func (proxy *AuthProxy) RemoveAuthBackendExcept(used map[string]bool)

RemoveAuthBackendExcept ...

type AuthProxyBind added in v0.13.0 

type AuthProxyBind struct {
	AuthBackendName string
	Backend         BackendID
	LocalPort       int
	SocketID        int
}

AuthProxyBind ...

type Backend 

type Backend struct {
	ID        string
	Code      int
	Namespace string
	Name      string
	Port      string
	DNSPort   string
	SourceIPs []net.IP
	Endpoints []*Endpoint
	EpNaming  EndpointNaming
	//
	// Paths
	//
	Paths []*Path

	//
	// per backend config
	//
	AgentCheck          AgentCheck
	AllowedIPTCP        AccessConfig
	BalanceAlgorithm    string
	BlueGreen           BlueGreenConfig
	Cookie              Cookie
	CustomConfigEarly   []string
	CustomConfigLate    []string
	CustomHTTPResponses HTTPResponses
	DeniedIPTCP         AccessConfig
	Dynamic             DynBackendConfig
	EpCookieStrategy    EndpointCookieStrategy
	HealthCheck         HealthCheck
	Limit               BackendLimit
	ModeTCP             bool
	PeersTable          string
	Redirect            BackendRedirect
	RequestHeadersAdd   []HTTPHeader
	RequestHeadersSet   []HTTPHeader
	RequestHeadersDel   []string
	ResponseHeadersAdd  []HTTPHeader
	ResponseHeadersSet  []HTTPHeader
	ResponseHeadersDel  []string
	Resolver            string
	Server              ServerConfig
	Timeout             BackendTimeoutConfig
	TLS                 BackendTLSConfig
	// contains filtered or unexported fields
}

Backend ...

func (*Backend) AcquireEndpoint 

func (b *Backend) AcquireEndpoint(ip string, port int, targetRef string) *Endpoint

AcquireEndpoint ...

func (*Backend) AddEmptyEndpoint 

func (b *Backend) AddEmptyEndpoint() *Endpoint

AddEmptyEndpoint ...

func (*Backend) AddEndpoint added in v0.14.8 

func (b *Backend) AddEndpoint(ip string, port int, targetRef string) *Endpoint

func (*Backend) AddPath 

func (b *Backend) AddPath(path *Path)

func (*Backend) BackendID added in v0.11.1 

func (b *Backend) BackendID() BackendID

BackendID ...

func (*Backend) CookieAffinity added in v0.12.1 

func (b *Backend) CookieAffinity() bool

CookieAffinity ...

func (*Backend) Equals 

func (b *Backend) Equals(other *Backend) bool

func (*Backend) FindEndpoint 

func (b *Backend) FindEndpoint(target string) *Endpoint

FindEndpoint ...

func (*Backend) HasCorsEnabled 

func (b *Backend) HasCorsEnabled() bool

HasCorsEnabled ...

func (*Backend) HasHSTS added in v0.12.1 

func (b *Backend) HasHSTS() bool

HasHSTS ...

func (*Backend) HasHTTPPassUseProto 

func (b *Backend) HasHTTPPassUseProto() Has

func (*Backend) HasHTTPPassthrough 

func (b *Backend) HasHTTPPassthrough() Has

func (*Backend) HasHTTPRequests 

func (b *Backend) HasHTTPRequests() bool

func (*Backend) HasModsec 

func (b *Backend) HasModsec() bool

HasModsec is a method to verify if a Backend has ModSecurity Enabled

func (*Backend) HasSSLRedirect 

func (b *Backend) HasSSLRedirect() bool

HasSSLRedirect ...

func (*Backend) HasSSLRedirectPaths 

func (b *Backend) HasSSLRedirectPaths(paths []*Path) bool

HasSSLRedirectPaths ...

func (*Backend) HasTLSAuth 

func (b *Backend) HasTLSAuth() bool

func (*Backend) Hostnames 

func (b *Backend) Hostnames() []string

Hostnames ...

func (*Backend) NeedACL 

func (b *Backend) NeedACL() bool

NeedACL ...

func (*Backend) NeedFrontendACL 

func (b *Backend) NeedFrontendACL() bool

func (*Backend) PathConfig added in v0.12.1 

func (b *Backend) PathConfig(attr string) *BackendPathConfig

PathConfig ...

func (*Backend) PathConfigs 

func (b *Backend) PathConfigs() map[string]*BackendPathConfig

func (*Backend) PathsMaps 

func (b *Backend) PathsMaps() []*BackendPathsMaps

type BackendID added in v0.11.1 

type BackendID struct {
	Namespace string
	Name      string
	Port      string
	// contains filtered or unexported fields
}

BackendID ...

func (BackendID) IsEmpty added in v0.13.0 

func (b BackendID) IsEmpty() bool

IsEmpty ...

func (BackendID) String added in v0.11.1 

func (b BackendID) String() string

type BackendLimit 

type BackendLimit struct {
	Connections int
	RPS         int
	Whitelist   []string
}

BackendLimit ...

type BackendPathConfig added in v0.12.1 

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

BackendPathConfig ...

func (*BackendPathConfig) Items added in v0.12.1 

func (b *BackendPathConfig) Items() []interface{}

Items ...

func (*BackendPathConfig) NeedACL added in v0.12.1 

func (b *BackendPathConfig) NeedACL() bool

NeedACL ...

func (*BackendPathConfig) PathIDs added in v0.12.1 

func (b *BackendPathConfig) PathIDs(index int) []string

PathIDs ...

func (*BackendPathConfig) Paths added in v0.12.1 

func (b *BackendPathConfig) Paths(index int) []*Path

Paths ...

type BackendPathItem added in v0.12.1 

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

BackendPathItem ...

type BackendPathsMaps 

type BackendPathsMaps struct {
	Frontends []string
	ReqMap    *HostsMap
	DefMap    *HostsMap
	Paths     []*Path
}

type BackendRedirect 

type BackendRedirect struct {
	Scheme   string
	Hostname string
	Path     string
	Port     int
	Code     int
}

type BackendTLSConfig 

type BackendTLSConfig struct {
	AddCertHeader    bool
	FingerprintLower bool
	Sha2Bits         int
}

BackendTLSConfig ...

type BackendTimeoutConfig 

type BackendTimeoutConfig struct {
	Connect     string
	HTTPRequest string
	KeepAlive   string
	Queue       string
	Server      string
	ServerFin   string
	Tunnel      string
}

BackendTimeoutConfig ...

type Backends added in v0.11.1 

type Backends struct {
	DefaultBackend *Backend
	// contains filtered or unexported fields
}

Backends ...

func CreateBackends added in v0.11.1 

func CreateBackends(shardCount int) *Backends

CreateBackends ...

func (*Backends) AcquireAuthBackend added in v0.13.0 

func (b *Backends) AcquireAuthBackend(ipList []string, port int, hostname string) *Backend

AcquireAuthBackend ...

func (*Backends) AcquireBackend added in v0.11.1 

func (b *Backends) AcquireBackend(namespace, name, port string) *Backend

AcquireBackend ...

func (*Backends) AcquireNotFoundBackend 

func (b *Backends) AcquireNotFoundBackend() *Backend

AcquireNotFoundBackend ...

func (*Backends) AcquireRedirectHTTPSBackend 

func (b *Backends) AcquireRedirectHTTPSBackend() *Backend

AcquireHTTPSRedirectBackend ...

func (*Backends) AcquireStatusCodeBackend 

func (b *Backends) AcquireStatusCodeBackend(code int) *Backend

AcquireStatusCodeBackend ...

TODO: It currently supports only the following codes: 200, 400, 403, 404, 405, 408, 410, 413, 425, 429, 500, 501, 502, 503, 504 Need to improve the template to support others.

func (*Backends) AcquireTCPRejectBackend 

func (b *Backends) AcquireTCPRejectBackend() *Backend

func (*Backends) BackendChanged added in v0.11.9 

func (b *Backends) BackendChanged(backend *Backend)

BackendChanged ...

func (*Backends) BuildHTTPResponses added in v0.16.0 

func (b *Backends) BuildHTTPResponses() (responses []HTTPResponses)

func (*Backends) BuildSortedItems added in v0.11.1 

func (b *Backends) BuildSortedItems() []*Backend

BuildSortedItems ...

func (*Backends) BuildSortedShard added in v0.11.1 

func (b *Backends) BuildSortedShard(shardRef int) []*Backend

BuildSortedShard ...

func (*Backends) BuildSupportBackendItems 

func (b *Backends) BuildSupportBackendItems() []*Backend

func (*Backends) BuildUsedAuthBackends added in v0.13.0 

func (b *Backends) BuildUsedAuthBackends() map[string]bool

BuildUsedAuthBackends ...

func (*Backends) Changed added in v0.11.1 

func (b *Backends) Changed() bool

Changed ...

func (*Backends) ChangedShards added in v0.11.1 

func (b *Backends) ChangedShards() []int

ChangedShards ...

func (*Backends) Clear added in v0.12.18 

func (b *Backends) Clear()

func (*Backends) Commit added in v0.11.1 

func (b *Backends) Commit()

Commit ...

func (*Backends) FillSourceIPs added in v0.13.0 

func (b *Backends) FillSourceIPs()

FillSourceIPs ...

func (*Backends) FindBackend added in v0.11.1 

func (b *Backends) FindBackend(namespace, name, port string) *Backend

FindBackend ...

func (*Backends) FindBackendID added in v0.11.1 

func (b *Backends) FindBackendID(backendID BackendID) *Backend

FindBackendID ...

func (*Backends) HasBackend 

func (b *Backends) HasBackend(name string) bool

func (*Backends) Items added in v0.11.1 

func (b *Backends) Items() map[string]*Backend

Items ...

func (*Backends) ItemsAdd added in v0.11.1 

func (b *Backends) ItemsAdd() map[string]*Backend

ItemsAdd ...

func (*Backends) ItemsDel added in v0.11.1 

func (b *Backends) ItemsDel() map[string]*Backend

ItemsDel ...

func (*Backends) RemoveAll added in v0.11.1 

func (b *Backends) RemoveAll(backendID []string)

RemoveAll ...

func (*Backends) Shrink added in v0.11.1 

func (b *Backends) Shrink()

Shrink compares deleted and added backends with the same name - ie changed objects - and remove both from the changing hashmap tracker when they match.

func (*Backends) ShuffleAllEndpoints added in v0.11.1 

func (b *Backends) ShuffleAllEndpoints()

ShuffleAllEndpoints ...

func (*Backends) SortChangedEndpoints added in v0.11.1 

func (b *Backends) SortChangedEndpoints(sortBy string)

SortChangedEndpoints ...

type BlueGreenConfig added in v0.9.1 

type BlueGreenConfig struct {
	CookieName string
	HeaderName string
}

BlueGreenConfig ...

type CAVerify added in v0.14.0 

type CAVerify string

CAVerify ... 

const (
	CAVerifySkipCheck CAVerify = "skip-check"
	CAVerifyOptional  CAVerify = "optional"
	CAVerifyAlways    CAVerify = "always"
)

... 

type Cookie struct {
	Name     string
	Domain   string
	Dynamic  bool
	Preserve bool
	SameSite bool
	Shared   bool
	Strategy string
	Keywords string
}

Cookie ...

type CookieConfig 

type CookieConfig struct {
	Key string
}

CookieConfig ...

type Cors 

type Cors struct {
	Enabled bool
	//
	AllowCredentials bool
	AllowHeaders     string
	AllowMethods     string
	AllowOrigin      []string
	AllowOriginRegex []string
	ExposeHeaders    string
	MaxAge           int
}

Cors ...

type DHParamConfig 

type DHParamConfig struct {
	Filename       string
	DefaultMaxSize int
}

DHParamConfig ...

type DNSConfig 

type DNSConfig struct {
	ClusterDomain string
	Resolvers     []*DNSResolver
}

DNSConfig ...

func (*DNSConfig) String 

func (dns *DNSConfig) String() string

type DNSNameserver 

type DNSNameserver struct {
	Name     string
	Endpoint string
}

DNSNameserver ...

func (*DNSNameserver) String 

func (dns *DNSNameserver) String() string

type DNSResolver 

type DNSResolver struct {
	Name                string
	Nameservers         []*DNSNameserver
	AcceptedPayloadSize int
	HoldObsolete        string
	HoldValid           string
	TimeoutRetry        string
}

DNSResolver ...

func (*DNSResolver) String 

func (dns *DNSResolver) String() string

type DrainConfig 

type DrainConfig struct {
	Drain      bool
	Redispatch bool
}

DrainConfig ...

type DynBackendConfig 

type DynBackendConfig struct {
	BlockSize    int
	DynScaling   DynScaling
	MinFreeSlots int
}

DynBackendConfig ...

type DynScaling 

type DynScaling string
const (
	DynScalingNone  DynScaling = "None"
	DynScalingSlots DynScaling = "Slots"
	DynScalingAdd   DynScaling = "Add"
)

type Endpoint 

type Endpoint struct {
	// revisit dynupdate.go/checkEndpointPair() whenever need to update these fields
	Enabled     bool
	Label       string
	IP          string
	Name        string
	Port        int
	SourceIP    string
	Target      string
	TargetRef   string
	Weight      int
	CookieValue string
	PUID        int32 // Proxy Unique ID, referenced as "id" in haproxy server lines
}

Endpoint ...

func (*Endpoint) IsEmpty 

func (ep *Endpoint) IsEmpty() bool

IsEmpty ...

type EndpointCookieStrategy added in v0.12.1 

type EndpointCookieStrategy int

EndpointCookieStrategy ... 

const (
	EpCookieName EndpointCookieStrategy = iota
	EpCookiePodUID
)

...

type EndpointNaming 

type EndpointNaming int

EndpointNaming ... 

const (
	EpSequence EndpointNaming = iota
	EpIPPort
	EpTargetRef
)

...

type ExternalConfig added in v0.12.1 

type ExternalConfig struct {
	HasLua     bool
	IsExternal bool
}

ExternalConfig ...

type Frontend 

type Frontend struct {
	HTTPMaps  *FrontendHTTPMaps
	HTTPSMaps *FrontendHTTPSMaps
	Name      string
	IsHTTPS   bool
	//
	// Bind related
	Bind        string
	AcceptProxy bool
	//
	// HTTPS related
	CrtListFile string
	StrictTLS   bool
	//
	// Passthrough related
	TLSProxyName string
	HTTPSSocket  string
	HTTPSProxy   bool
	//
	HTTPPassthrough  bool
	HTTPPassUseProto bool
	RedirectFromCode int
	RedirectToCode   int
	// contains filtered or unexported fields
}

Frontend ...

func (*Frontend) AcquireHost 

func (f *Frontend) AcquireHost(hostname string) *Host

AcquireHost ...

func (*Frontend) BuildSortedHosts 

func (f *Frontend) BuildSortedHosts() []*Host

BuildSortedHosts ...

func (*Frontend) Commit added in v0.13.0 

func (f *Frontend) Commit()

Commit ...

func (*Frontend) DefaultHost 

func (f *Frontend) DefaultHost() *Host

DefaultHost ...

func (*Frontend) FindHost 

func (f *Frontend) FindHost(hostname string) *Host

FindHost ...

func (*Frontend) FindTargetRedirect 

func (f *Frontend) FindTargetRedirect(redirfrom string, isRegex bool) *Host

FindTargetRedirect ...

func (*Frontend) HasCommit 

func (f *Frontend) HasCommit() bool

HasCommit ...

func (*Frontend) HasSSLPassthrough 

func (f *Frontend) HasSSLPassthrough() bool

HasSSLPassthrough ...

func (*Frontend) HasTLSAuth 

func (f *Frontend) HasTLSAuth() bool

HasTLSAuth ...

func (*Frontend) HasVarNamespace 

func (f *Frontend) HasVarNamespace() bool

HasVarNamespace ...

func (*Frontend) Hosts 

func (f *Frontend) Hosts() map[string]*Host

Hosts ...

func (*Frontend) HostsAdd 

func (f *Frontend) HostsAdd() map[string]*Host

HostsAdd ...

func (*Frontend) HostsChanged 

func (f *Frontend) HostsChanged() bool

HostsChanged ...

func (*Frontend) HostsDel 

func (f *Frontend) HostsDel() map[string]*Host

HostsDel ...

func (*Frontend) Port 

func (f *Frontend) Port() int32

func (*Frontend) RemoveAllHosts 

func (f *Frontend) RemoveAllHosts(hostnames []string)

RemoveAllHosts ...

func (*Frontend) ShrinkHosts 

func (f *Frontend) ShrinkHosts()

ShrinkHosts removes matching added and deleted hosts from the changing hashmap tracker that has the same content. A matching added+deleted pair means that a hostname was reparsed but its content wasn't changed.

func (*Frontend) String 

func (f *Frontend) String() string

String ...

type FrontendCommonMaps 

type FrontendCommonMaps struct {
	DefaultHostMap   *HostsMap
	RedirFromMap     *HostsMap
	RedirFromRootMap *HostsMap
	RedirToMap       *HostsMap
	VarNamespaceMap  *HostsMap
}

FrontendCommonMaps ...

type FrontendHTTPMaps 

type FrontendHTTPMaps struct {
	FrontendCommonMaps
	HTTPHostMap     *HostsMap
	RedirRootSSLMap *HostsMap
}

FrontendHTTPMaps ...

type FrontendHTTPSMaps 

type FrontendHTTPSMaps struct {
	FrontendCommonMaps
	HTTPSHostMap          *HostsMap
	SSLPassthroughMap     *HostsMap
	TLSOffloadMap         *HostsMap
	TLSAuthList           *HostsMap
	TLSInvalidCrtPagesMap *HostsMap
	TLSMissingCrtPagesMap *HostsMap
	TLSNeedCrtList        *HostsMap
}

FrontendHTTPSMaps ...

type Frontends 

type Frontends struct {
	AuthProxy      AuthProxy
	DefaultCrtFile string
	DefaultCrtHash string
	// contains filtered or unexported fields
}

Frontends ...

func (*Frontends) AcquireFrontend 

func (f *Frontends) AcquireFrontend(port int32, isHTTPS bool) *Frontend

func (*Frontends) BuildHTTPResponses 

func (f *Frontends) BuildHTTPResponses() (responses []HTTPResponses)

func (*Frontends) Changed 

func (f *Frontends) Changed() bool

func (*Frontends) Commit 

func (f *Frontends) Commit()

func (*Frontends) FindFrontend 

func (f *Frontends) FindFrontend(port int32) *Frontend

func (*Frontends) HasCommit 

func (f *Frontends) HasCommit() bool

func (*Frontends) HasHTTPResponses 

func (f *Frontends) HasHTTPResponses() bool

func (*Frontends) HasSomeHTTPPassUseProto 

func (f *Frontends) HasSomeHTTPPassUseProto() bool

func (*Frontends) HasSomeHTTPPassthrough 

func (f *Frontends) HasSomeHTTPPassthrough() bool

func (*Frontends) Items 

func (f *Frontends) Items() []*Frontend

func (*Frontends) RemoveAllHosts 

func (f *Frontends) RemoveAllHosts(hostnames []string)

func (*Frontends) RemoveEmptyFrontends 

func (f *Frontends) RemoveEmptyFrontends()

func (*Frontends) Shrink 

func (f *Frontends) Shrink()

type Global 

type Global struct {
	Procs                   ProcsConfig
	Syslog                  SyslogConfig
	MaxConn                 int
	Timeout                 TimeoutConfig
	SSL                     SSLConfig
	DNS                     DNSConfig
	ModSecurity             ModSecurityConfig
	Cookie                  CookieConfig
	DrainSupport            DrainConfig
	Acme                    Acme
	ForwardFor              string
	OriginalForwardedForHdr string
	RealIPHdr               string
	LoadServerState         bool
	AdminSocket             string
	LocalFSPrefix           string
	External                ExternalConfig
	Healthz                 HealthzConfig
	Master                  MasterConfig
	MatchOrder              []MatchType
	Peers                   PeersConfig
	Prometheus              PromConfig
	Security                SecurityConfig
	Stats                   StatsConfig
	TCPBindIP               string
	CloseSessionsDuration   time.Duration
	TimeoutStopDuration     time.Duration
	StrictHost              bool
	FastCGIApps             []string
	DefaultBackendRedir     string
	DefaultBackendRedirCode int
	NoRedirects             []string
	CustomConfig            []string
	CustomDefaults          []string
	CustomFrontendEarly     []string
	CustomFrontendLate      []string
	CustomPeers             []string
	CustomProxy             map[string][]string
	CustomHTTPResponses     HTTPResponses
	CustomSections          []string
	CustomTCP               []string
}

Global ...

type HSTS 

type HSTS struct {
	Enabled    bool
	MaxAge     int
	Subdomains bool
	Preload    bool
}

HSTS ...

type HTTPHeader added in v0.14.0 

type HTTPHeader struct {
	Name  string
	Value string
}

HTTPHeader ...

type HTTPHeaderMatch added in v0.15.0 

type HTTPHeaderMatch []HTTPMatch

HTTPHeaderMatch ...

type HTTPMatch added in v0.15.0 

type HTTPMatch struct {
	// Each HTTPMatch uses 16 + len(Name) + len(Value) + 7 (if Regex) bytes.
	// Keyword and converter uses about 120 bytes.
	//
	// Three HTTPMatch whose Name has 24 bytes and Value has 256 bytes will consume:
	//   3 * (16 + 24 + 256) + 120 = 1008, or 1029 if Regex is true
	//
	// This should be below 2048.
	Regex bool
	Name  string
	Value string
}

HTTPMatch ...

type HTTPResponse added in v0.14.0 

type HTTPResponse struct {
	Name         string
	Headers      []HTTPHeader
	Body         []string
	StatusCode   int
	StatusReason string
}

HTTPResponse ...

type HTTPResponses added in v0.16.0 

type HTTPResponses struct {
	ID      string
	HAProxy []HTTPResponse
	Lua     []HTTPResponse
}

HTTPResponses ...

type Has 

type Has int
const (
	HasNone Has = iota
	HasSome
	HasOnly
)

these same consts are also used in haproxy.tmpl, change there if changing here.

type HealthCheck 

type HealthCheck struct {
	Addr      string
	FallCount int
	Interval  string
	Port      int
	RiseCount int
	URI       string
}

HealthCheck ...

type HealthzConfig 

type HealthzConfig struct {
	BindIP string
	Port   int
}

HealthzConfig ...

type Host 

type Host struct {
	ID       string
	Frontend *Frontend
	Hostname string
	Paths    []*Path
	//
	Alias               HostAliasConfig
	CustomHTTPResponses HTTPResponses
	DefaultBackend      *Backend
	ExtendedWildcard    bool
	Redirect            HostRedirectConfig
	RootRedirect        string
	SSLPassthrough      bool
	TLS                 HostTLSConfig
	VarNamespace        bool
}

Host ...

Wildcard `*` hostname is a catch all and will be used if no other hostname, alias or regex matches the request. If wildcard hostname is not declared, the default backend will be used. If the default backend is empty, a default 404 page generated by HAProxy will be used. 

func (h *Host) AddLink(backend *Backend, link *PathLink) *Path

AddLink ...

func (*Host) AddLinkRedirect added in v0.15.0 

func (h *Host) AddLinkRedirect(link *PathLink, redirTo string) *Path

AddLinkRedirect ...

func (*Host) AddPath 

func (h *Host) AddPath(backend *Backend, path string, match MatchType) *Path

AddPath ...

func (*Host) AddRedirect added in v0.13.0 

func (h *Host) AddRedirect(path string, match MatchType, redirTo string) *Path

AddRedirect ...

func (*Host) Equals 

func (h *Host) Equals(other *Host) bool

func (*Host) FindPath 

func (h *Host) FindPath(path string, match ...MatchType) (paths []*Path)

FindPath ... 

func (h *Host) FindPathWithLink(link *PathLink) (path *Path)

FindPathWithLink ...

func (*Host) HasTLSAuth 

func (h *Host) HasTLSAuth() bool

HasTLSAuth ...

func (*Host) RemovePath added in v0.13.0 

func (h *Host) RemovePath(hpath *Path)

RemovePath ...

func (*Host) String 

func (h *Host) String() string

String ...

type HostAliasConfig 

type HostAliasConfig struct {
	AliasName  string
	AliasRegex string
}

HostAliasConfig ...

type HostRedirectConfig added in v0.13.0 

type HostRedirectConfig struct {
	RedirectHost      string
	RedirectHostRegex string
}

HostRedirectConfig ...

type HostTLSConfig 

type HostTLSConfig struct {
	TLSConfig
	CAErrorPage string
}

HostTLSConfig ...

func (*HostTLSConfig) HasTLS 

func (h *HostTLSConfig) HasTLS() bool

HasTLS ...

type HostsMap 

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

HostsMap ...

func (*HostsMap) AddAliasPathMapping added in v0.11.1 

func (hm *HostsMap) AddAliasPathMapping(alias HostAliasConfig, path *Path, target string)

AddAliasPathMapping ...

func (*HostsMap) AddHostnameMapping added in v0.11.1 

func (hm *HostsMap) AddHostnameMapping(hostname string, extendedWildcard bool, target string)

AddHostnameMapping ...

func (*HostsMap) AddHostnameMappingRegex added in v0.13.0 

func (hm *HostsMap) AddHostnameMappingRegex(hostname, target string)

AddHostnameMappingRegex ...

func (*HostsMap) AddHostnamePathMapping added in v0.11.1 

func (hm *HostsMap) AddHostnamePathMapping(hostname string, path *Path, target string)

AddHostnamePathMapping ...

func (*HostsMap) AddTargetIfMissing 

func (hm *HostsMap) AddTargetIfMissing(hostname, path string, target string, match MatchType)

AddTargetIfMissing ...

func (*HostsMap) HasHost 

func (hm *HostsMap) HasHost() bool

HasHost ...

func (*HostsMap) MatchFiles added in v0.11.2 

func (hm *HostsMap) MatchFiles() []*MatchFile

MatchFiles ...

type HostsMapEntry 

type HostsMapEntry struct {
	Key   string
	Value string
	// contains filtered or unexported fields
}

HostsMapEntry ...

func (*HostsMapEntry) String added in v0.11.1 

func (he *HostsMapEntry) String() string

type HostsMaps 

type HostsMaps struct {
	Items []*HostsMap
	// contains filtered or unexported fields
}

HostsMaps ...

func CreateMaps 

func CreateMaps(matchOrder []MatchType) *HostsMaps

CreateMaps ...

func (*HostsMaps) AddMap 

func (hm *HostsMaps) AddMap(basename string) *HostsMap

AddMap ...

type MasterConfig added in v0.12.1 

type MasterConfig struct {
	ExitOnFailure    bool
	IsMasterWorker   bool
	WorkerMaxReloads int
}

MasterConfig ...

type MatchFile added in v0.11.2 

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

MatchFile ...

func (MatchFile) Filename added in v0.11.2 

func (m MatchFile) Filename() string

Filename ...

func (MatchFile) First added in v0.11.2 

func (m MatchFile) First() bool

First ...

func (MatchFile) Headers added in v0.15.0 

func (m MatchFile) Headers() HTTPHeaderMatch

Headers ...

func (MatchFile) Last added in v0.13.0 

func (m MatchFile) Last() bool

Last ...

func (MatchFile) Lower added in v0.11.2 

func (m MatchFile) Lower() bool

Lower ...

func (MatchFile) Method added in v0.11.2 

func (m MatchFile) Method() string

Method ...

func (MatchFile) Values added in v0.11.2 

func (m MatchFile) Values() []*HostsMapEntry

Values ...

type MatchType added in v0.11.1 

type MatchType string

MatchType ...

type ModSecurityConfig 

type ModSecurityConfig struct {
	Endpoints []string
	Timeout   ModSecurityTimeoutConfig
	Args      []string
	UseCoraza bool
}

ModSecurityConfig ...

type ModSecurityTimeoutConfig 

type ModSecurityTimeoutConfig struct {
	// Backend
	Connect string
	Server  string
	// SPOE
	Hello      string
	Idle       string
	Processing string
}

ModSecurityTimeoutConfig ...

type Path 

type Path struct {
	ID       string    `class:"core"`
	Link     *PathLink `class:"core"`
	Host     *Host     `class:"core"`
	Backend  *Backend  `class:"core"`
	HasHTTPS bool      `class:"core"`
	//
	// config fields
	//
	AllowedIPHTTP AccessConfig
	AuthHTTP      AuthHTTP
	AuthExtFront  AuthExternal
	AuthExtBack   AuthExternal
	Cors          Cors
	DeniedIPHTTP  AccessConfig
	HSTS          HSTS
	MaxBodySize   int64
	RedirTo       string
	Rewrite       RewriteConfig
	SSLRedirect   bool
	WAF           WAF
	// contains filtered or unexported fields
}

BackendPath ...

func (*Path) Headers 

func (h *Path) Headers() HTTPHeaderMatch

Headers ...

func (*Path) Hostname 

func (p *Path) Hostname() string

Hostname ...

func (*Path) IsDefaultHost 

func (p *Path) IsDefaultHost() bool

IsDefaultHost ...

func (*Path) Match 

func (p *Path) Match() MatchType

Match ...

func (*Path) Path 

func (p *Path) Path() string

Path ...

func (*Path) String 

func (p *Path) String() string

String ... 

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

PathLink is a unique identifier of a request configuration. Several request based configurations uses this identifier to distinguish if an acl should or should not be applied. 

func CreatePathLink(path string, match MatchType) *PathLink

func (*PathLink) AddHeadersMatch added in v0.15.0 

func (l *PathLink) AddHeadersMatch(headers HTTPHeaderMatch) *PathLink

AddHeadersMatch ...

func (*PathLink) Equals added in v0.15.0 

func (l *PathLink) Equals(other *PathLink) bool

Equals ...

func (*PathLink) HAMatch added in v0.15.0 

func (l *PathLink) HAMatch() string

HAMatch ...

func (*PathLink) Hash added in v0.15.0 

func (l *PathLink) Hash() PathLinkHash

Hash ...

func (*PathLink) Hostname added in v0.13.0 

func (l *PathLink) Hostname() string

Hostname ...

func (*PathLink) IsComposeMatch 

func (l *PathLink) IsComposeMatch() bool

IsComposeMatch returns true if the pathLink has composing match, by adding method, header or cookie match.

func (*PathLink) IsDefaultHost added in v0.12.4 

func (l *PathLink) IsDefaultHost() bool

IsDefaultHost ...

func (*PathLink) IsEmpty added in v0.11.1 

func (l *PathLink) IsEmpty() bool

IsEmpty ...

func (*PathLink) Key added in v0.15.0 

func (l *PathLink) Key() string

Key ...

func (*PathLink) Less added in v0.11.1 

func (l *PathLink) Less(other *PathLink, reversePath bool) bool

Less ...

func (*PathLink) WithHTTPFront 

func (l *PathLink) WithHTTPFront(front *Frontend) *PathLink

WithHTTPFront ...

func (*PathLink) WithHTTPHost 

func (l *PathLink) WithHTTPHost(host *Host) *PathLink

WithHTTPHost ...

func (*PathLink) WithHeadersMatch added in v0.15.0 

func (l *PathLink) WithHeadersMatch(headers HTTPHeaderMatch) *PathLink

WithHeadersMatch ...

func (*PathLink) WithTCPHost 

func (l *PathLink) WithTCPHost(tcphost *TCPServiceHost) *PathLink

WithTCPHost ...

type PathLinkHash added in v0.15.0 

type PathLinkHash string

PathLinkHash ...

type PeersConfig added in v0.16.0 

type PeersConfig struct {
	SectionName string
	LocalPeer   PeersServer
	GlobalTable string // used by global updater
	Servers     []PeersServer
	Tables      []PeersTable // updated on config.SyncConfig(), including global and backend tables
}

PeersConfig ...

type PeersServer added in v0.16.0 

type PeersServer struct {
	BESuffix string
	Name     string
	Endpoint string
}

PeersServer ...

type PeersTable added in v0.16.0 

type PeersTable struct {
	GroupName string
	Table     string
}

PeersTable ...

type ProcsConfig 

type ProcsConfig struct {
	Nbthread int
	CPUMap   string
}

ProcsConfig ...

type PromConfig added in v0.10.1 

type PromConfig struct {
	BindIP string
	Port   int
}

PromConfig ...

type RewriteConfig added in v0.14.12 

type RewriteConfig struct {
	Match  string
	Target string
}

RewriteConfig ...

type SSLConfig 

type SSLConfig struct {
	ALPN                string
	BackendCiphers      string
	BackendCipherSuites string
	Ciphers             string // TLS up to 1.2
	CipherSuites        string // TLS 1.3
	DefaultCAFilename   string
	DefaultCAHash       string
	DefaultCRLFilename  string
	DefaultCRLHash      string
	DHParam             DHParamConfig
	Engine              string
	HeadersPrefix       string
	ModeAsync           bool
	Options             string
	RedirectCode        int
	SSLRedirect         bool
}

SSLConfig ...

type SecurityConfig added in v0.12.1 

type SecurityConfig struct {
	Groupname string
	UseChroot bool
	Username  string
}

SecurityConfig ...

type ServerConfig 

type ServerConfig struct {
	CAFilename    string
	CAHash        string
	Ciphers       string // TLS up to 1.2
	CipherSuites  string // TLS 1.3
	CRLFilename   string
	CRLHash       string
	CrtFilename   string
	CrtHash       string
	FastCGIApp    string
	InitialWeight int
	MaxConn       int
	MaxQueue      int
	Options       string
	Protocol      string
	Secure        bool
	SendProxy     string
	SNI           string
	VerifyHost    string
}

ServerConfig ...

type StatsConfig 

type StatsConfig struct {
	AcceptProxy bool
	Auth        string
	BindIP      string
	Port        int
	TLSFilename string
	TLSHash     string
}

StatsConfig ...

type SyslogConfig 

type SyslogConfig struct {
	Endpoint string
	Format   string
	Length   int
	Tag      string
	//
	AuthLogFormat  string
	HTTPLogFormat  string
	HTTPSLogFormat string
	TCPLogFormat   string
}

SyslogConfig ...

type TCPBackend 

type TCPBackend struct {
	Name          string
	Port          int
	Endpoints     []*TCPEndpoint
	CheckInterval string
	SSL           TCPSSL
	ProxyProt     TCPProxyProt
}

TCPBackend ...

func (*TCPBackend) AddEndpoint 

func (b *TCPBackend) AddEndpoint(ip string, port int) *TCPEndpoint

AddEndpoint ...

func (*TCPBackend) String 

func (b *TCPBackend) String() string

String ...

type TCPBackends added in v0.11.1 

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

TCPBackends ...

func CreateTCPBackends added in v0.11.1 

func CreateTCPBackends() *TCPBackends

CreateTCPBackends ...

func (*TCPBackends) Acquire added in v0.11.1 

func (b *TCPBackends) Acquire(servicename string, port int) *TCPBackend

Acquire ...

func (*TCPBackends) BuildSortedItems added in v0.11.1 

func (b *TCPBackends) BuildSortedItems() []*TCPBackend

BuildSortedItems ...

func (*TCPBackends) Changed added in v0.11.1 

func (b *TCPBackends) Changed() bool

Changed ...

func (*TCPBackends) Commit added in v0.11.1 

func (b *TCPBackends) Commit()

Commit ...

func (*TCPBackends) RemoveAll added in v0.11.1 

func (b *TCPBackends) RemoveAll()

RemoveAll ...

type TCPEndpoint 

type TCPEndpoint struct {
	Name   string
	IP     string
	Port   int
	Target string
}

TCPEndpoint ...

func (*TCPEndpoint) String 

func (ep *TCPEndpoint) String() string

String ...

type TCPProxyProt 

type TCPProxyProt struct {
	Decode        bool
	EncodeVersion string
}

TCPProxyProt ...

type TCPSSL 

type TCPSSL struct {
	Filename    string
	CAFilename  string
	CRLFilename string
}

TCPSSL ...

type TCPServiceHost added in v0.13.0 

type TCPServiceHost struct {
	Backend BackendID
	// contains filtered or unexported fields
}

TCPServiceHost ...

func (*TCPServiceHost) Hostname added in v0.13.0 

func (s *TCPServiceHost) Hostname() string

Hostname ...

type TCPServicePort added in v0.13.0 

type TCPServicePort struct {
	CustomConfig []string
	LogFormat    string
	ProxyProt    bool
	TLS          map[string]*TCPServiceTLSConfig
	//
	SNIMap *HostsMap
	// contains filtered or unexported fields
}

TCPServicePort ...

func (*TCPServicePort) AcquireDefaultHost 

func (s *TCPServicePort) AcquireDefaultHost() *TCPServiceHost

func (*TCPServicePort) AcquireTLSHost 

func (s *TCPServicePort) AcquireTLSHost(hostname string) *TCPServiceHost

func (*TCPServicePort) BuildSortedItems added in v0.13.0 

func (s *TCPServicePort) BuildSortedItems() []*TCPServiceHost

BuildSortedItems ...

func (*TCPServicePort) BuildSortedTLSConfig added in v0.14.8 

func (s *TCPServicePort) BuildSortedTLSConfig() []*TCPServiceTLSConfig

BuildSortedTLSConfig ...

func (*TCPServicePort) DefaultHost added in v0.13.0 

func (s *TCPServicePort) DefaultHost() *TCPServiceHost

DefaultHost ...

func (*TCPServicePort) HasTLS added in v0.14.8 

func (s *TCPServicePort) HasTLS() bool

HasTLS ...

func (*TCPServicePort) Hosts added in v0.13.0 

func (s *TCPServicePort) Hosts() map[string]*TCPServiceHost

Hosts ...

func (*TCPServicePort) Port added in v0.13.0 

func (s *TCPServicePort) Port() int

Port ...

type TCPServiceTLSConfig added in v0.14.8 

type TCPServiceTLSConfig struct {
	TLSConfig
	Hostname string
}

type TCPServices added in v0.13.0 

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

TCPServices ...

func CreateTCPServices added in v0.13.0 

func CreateTCPServices() *TCPServices

CreateTCPServices ...

func (*TCPServices) AcquireTCPPort 

func (s *TCPServices) AcquireTCPPort(port int) *TCPServicePort

func (*TCPServices) AcquireTCPService added in v0.13.0 

func (s *TCPServices) AcquireTCPService(service string) (*TCPServicePort, *TCPServiceHost)

AcquireTCPService ...

func (*TCPServices) BuildSortedItems added in v0.13.0 

func (s *TCPServices) BuildSortedItems() []*TCPServicePort

BuildSortedItems ...

func (*TCPServices) Changed added in v0.13.0 

func (s *TCPServices) Changed() bool

Changed ...

func (*TCPServices) Commit added in v0.13.0 

func (s *TCPServices) Commit()

Commit ...

func (*TCPServices) FindTCPPort added in v0.13.0 

func (s *TCPServices) FindTCPPort(port int) *TCPServicePort

FindTCPPort ...

func (*TCPServices) Items added in v0.13.0 

func (s *TCPServices) Items() map[int]*TCPServicePort

Items ...

func (*TCPServices) RemoveAll added in v0.13.0 

func (s *TCPServices) RemoveAll(services []string)

RemoveAll removes services declared as a slice of <hostname>:<port> 

func (s *TCPServices) RemoveAllLinks(pathlinks ...*PathLink)

func (*TCPServices) RemoveService added in v0.13.0 

func (s *TCPServices) RemoveService(service string)

RemoveService ...

type TLSConfig added in v0.13.0 

type TLSConfig struct {
	ALPN          string
	CAFilename    string
	CAHash        string
	CAVerify      CAVerify
	Ciphers       string
	CipherSuites  string
	CRLFilename   string
	CRLHash       string
	Options       string
	TLSCommonName string
	TLSFilename   string
	TLSHash       string
	TLSNotAfter   time.Time
}

TLSConfig ...

func (*TLSConfig) CAVerifyOptional added in v0.13.0 

func (tls *TLSConfig) CAVerifyOptional() bool

CAVerifyOptional ...

type TimeoutConfig 

type TimeoutConfig struct {
	BackendTimeoutConfig
	Client    string
	ClientFin string
	Stats     string
	Stop      string
}

TimeoutConfig ...

type User 

type User struct {
	Name      string
	Passwd    string
	Encrypted bool
}

User ...

type Userlist 

type Userlist struct {
	Name  string
	Users []User
}

Userlist ...

func (*Userlist) String 

func (u *Userlist) String() string

type UserlistConfig 

type UserlistConfig struct {
	Name  string
	Realm string
}

UserlistConfig ...

type Userlists added in v0.11.1 

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

Userlists ...

func CreateUserlists added in v0.11.1 

func CreateUserlists() *Userlists

CreateUserlists ...

func (*Userlists) BuildSortedItems added in v0.11.1 

func (u *Userlists) BuildSortedItems() []*Userlist

BuildSortedItems ...

func (*Userlists) Changed added in v0.11.1 

func (u *Userlists) Changed() bool

Changed ...

func (*Userlists) Commit added in v0.11.1 

func (u *Userlists) Commit()

Commit ...

func (*Userlists) Find added in v0.11.1 

func (u *Userlists) Find(name string) *Userlist

Find ...

func (*Userlists) RemoveAll added in v0.11.1 

func (u *Userlists) RemoveAll(userlists []string)

RemoveAll ...

func (*Userlists) Replace added in v0.11.1 

func (u *Userlists) Replace(name string, users []User) *Userlist

Replace ...

type WAF added in v0.9.1 

type WAF struct {
	// Mode defines On or DetectionOnly
	Mode string
	// Which WAF Module should be used
	Module string
}

WAF Defines the WAF Config structure for the Backend

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.