version2

Documentation

Index

• type Distribution
• type HealthCheck
• type InternalRedirectLocation
• type Location
• type Map
• type Parameter
• type Queue
• type Return
• type SSL
• type Server
• type SessionCookie
• type SplitClient
• type StatusMatch
• type TLSRedirect
• type TemplateExecutor
  • func NewTemplateExecutor(virtualServerTemplatePath string) (*TemplateExecutor, error)
  • func (te *TemplateExecutor) ExecuteVirtualServerTemplate(cfg *VirtualServerConfig) ([]byte, error)
• type Upstream
• type UpstreamServer
• type VirtualServerConfig

Types

type Distribution

type Distribution struct {
	Weight string
	Value  string
}

Distribution maps weight to a value in a SplitClient.

type HealthCheck

type HealthCheck struct {
	Name                string
	URI                 string
	Interval            string
	Jitter              string
	Fails               int
	Passes              int
	Port                int
	ProxyPass           string
	ProxyConnectTimeout string
	ProxyReadTimeout    string
	ProxySendTimeout    string
	Headers             map[string]string
	Match               string
}

HealthCheck defines a HealthCheck for an upstream in a Server.

type InternalRedirectLocation

type InternalRedirectLocation struct {
	Path        string
	Destination string
}

InternalRedirectLocation defines a location for internally redirecting requests to named locations.

type Location

type Location struct {
	Path                     string
	Snippets                 []string
	ProxyConnectTimeout      string
	ProxyReadTimeout         string
	ProxySendTimeout         string
	ClientMaxBodySize        string
	ProxyMaxTempFileSize     string
	ProxyBuffering           bool
	ProxyBuffers             string
	ProxyBufferSize          string
	ProxyPass                string
	ProxyNextUpstream        string
	ProxyNextUpstreamTimeout string
	ProxyNextUpstreamTries   int
	HasKeepalive             bool
	DefaultType              string
	Return                   *Return
}

Location defines a location.

type Map

type Map struct {
	Source     string
	Variable   string
	Parameters []Parameter
}

Map defines a map.

type Parameter

type Parameter struct {
	Value  string
	Result string
}

Parameter defines a Parameter in a Map.

type Queue

type Queue struct {
	Size    int
	Timeout string
}

Queue defines a queue in upstream.

type Return

type Return struct {
	Code int
	Text string
}

Return defines a Return directive used for redirects and canned responses.

type SSL

type SSL struct {
	HTTP2          bool
	Certificate    string
	CertificateKey string
	Ciphers        string
}

SSL defines SSL configuration for a server.

type Server

type Server struct {
	ServerName                string
	StatusZone                string
	ProxyProtocol             bool
	SSL                       *SSL
	ServerTokens              string
	RealIPHeader              string
	SetRealIPFrom             []string
	RealIPRecursive           bool
	Snippets                  []string
	InternalRedirectLocations []InternalRedirectLocation
	Locations                 []Location
	HealthChecks              []HealthCheck
	TLSRedirect               *TLSRedirect
}

Server defines a server.

type SessionCookie

type SessionCookie struct {
	Enable   bool
	Name     string
	Path     string
	Expires  string
	Domain   string
	HTTPOnly bool
	Secure   bool
}

SessionCookie defines a session cookie for an upstream.

type SplitClient

type SplitClient struct {
	Source        string
	Variable      string
	Distributions []Distribution
}

SplitClient defines a split_clients.

type StatusMatch

type StatusMatch struct {
	Name string
	Code string
}

StatusMatch defines a Match block for status codes.

type TLSRedirect

type TLSRedirect struct {
	Code    int
	BasedOn string
}

TLSRedirect defines a redirect in a Server.

type TemplateExecutor

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

TemplateExecutor executes NGINX configuration templates.

func NewTemplateExecutor

func NewTemplateExecutor(virtualServerTemplatePath string) (*TemplateExecutor, error)

NewTemplateExecutor creates a TemplateExecutor.

func (*TemplateExecutor) ExecuteVirtualServerTemplate

func (te *TemplateExecutor) ExecuteVirtualServerTemplate(cfg *VirtualServerConfig) ([]byte, error)

ExecuteVirtualServerTemplate generates the content of an NGINX configuration file for a VirtualServer resource.

type Upstream

type Upstream struct {
	Name             string
	Servers          []UpstreamServer
	LBMethod         string
	Resolve          bool
	Keepalive        int
	MaxFails         int
	MaxConns         int
	SlowStart        string
	FailTimeout      string
	UpstreamZoneSize string
	Queue            *Queue
	SessionCookie    *SessionCookie
}

Upstream defines an upstream.

type UpstreamServer

type UpstreamServer struct {
	Address string
}

UpstreamServer defines an upstream server.

type VirtualServerConfig

type VirtualServerConfig struct {
	Server        Server
	Upstreams     []Upstream
	SplitClients  []SplitClient
	Maps          []Map
	StatusMatches []StatusMatch
}

VirtualServerConfig holds NGINX configuration for a VirtualServer.