config

Documentation

Index

• Variables
• type Asset
• type Config
  • func New() *Config
• type Debug
• type HTTP
• type Log
• type MigrationSelectorConf
• type OIDC
• type Policy
• type PolicySelector
• type Route
• type RouteType
• type StaticSelectorConf
• type Tracing

Variables

var (
	// RouteTypes is an array of the available route types
	RouteTypes []RouteType = []RouteType{QueryRoute, RegexRoute, PrefixRoute}
)

Types

type Asset

type Asset struct {
	Path string
}

Asset defines the available asset configuration.

type Config

type Config struct {
	File           string
	Log            Log
	Debug          Debug
	HTTP           HTTP
	Tracing        Tracing
	Asset          Asset
	Policies       []Policy
	OIDC           *OIDC
	PolicySelector *PolicySelector `mapstructure:"policy_selector"`
}

Config combines all available configuration parts.

func New

func New() *Config

New initializes a new configuration

type Debug

type Debug struct {
	Addr   string
	Token  string
	Pprof  bool
	Zpages bool
}

Debug defines the available debug configuration.

type HTTP

type HTTP struct {
	Addr      string
	Namespace string
	Root      string
	TLSCert   string
	TLSKey    string
}

HTTP defines the available http configuration.

type Log

type Log struct {
	Level  string
	Pretty bool
	Color  bool
}

Log defines the available logging configuration.

type MigrationSelectorConf

type MigrationSelectorConf struct {
	AccFoundPolicy        string `mapstructure:"acc_found_policy"`
	AccNotFoundPolicy     string `mapstructure:"acc_not_found_policy"`
	UnauthenticatedPolicy string `mapstructure:"unauthenticated_policy"`
}

MigrationSelectorConf is the config for the migration-selector

type OIDC

type OIDC struct {
	Endpoint    string
	Realm       string
	SigningAlgs []string
	Insecure    bool
}

OIDC is the config for the OpenID-Connect middleware. If set the proxy will try to authenticate every request with the configured oidc-provider

type Policy

type Policy struct {
	Name   string
	Routes []Route
}

Policy enables us to use multiple directors.

type PolicySelector

type PolicySelector struct {
	Static    *StaticSelectorConf
	Migration *MigrationSelectorConf
}

PolicySelector is the toplevel-configuration for different selectors

type Route

type Route struct {
	Type        RouteType
	Endpoint    string
	Backend     string
	ApacheVHost bool `mapstructure:"apache-vhost"`
}

Route define forwarding routes

type RouteType

type RouteType string

RouteType defines the type of a route

const (
	// PrefixRoute are routes matched by a prefix
	PrefixRoute RouteType = "prefix"
	// QueryRoute are routes machted by a prefix and query parameters
	QueryRoute RouteType = "query"
	// RegexRoute are routes matched by a pattern
	RegexRoute RouteType = "regex"
	// DefaultRouteType is the PrefixRoute
	DefaultRouteType RouteType = PrefixRoute
)

type StaticSelectorConf

type StaticSelectorConf struct {
	Policy string
}

StaticSelectorConf is the config for the static-policy-selector

type Tracing

type Tracing struct {
	Enabled   bool
	Type      string
	Endpoint  string
	Collector string
	Service   string
}

Tracing defines the available tracing configuration.