2018-11-14 09:18:03 +00:00
package static
import (
2019-07-19 09:52:04 +00:00
"fmt"
2018-11-27 16:42:04 +00:00
"strings"
"time"
2020-09-04 08:52:03 +00:00
legolog "github.com/go-acme/lego/v4/log"
2022-11-21 17:36:05 +00:00
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
2020-08-17 16:04:03 +00:00
ptypes "github.com/traefik/paerser/types"
2023-02-03 14:24:05 +00:00
"github.com/traefik/traefik/v3/pkg/logs"
"github.com/traefik/traefik/v3/pkg/ping"
acmeprovider "github.com/traefik/traefik/v3/pkg/provider/acme"
"github.com/traefik/traefik/v3/pkg/provider/consulcatalog"
"github.com/traefik/traefik/v3/pkg/provider/docker"
"github.com/traefik/traefik/v3/pkg/provider/ecs"
"github.com/traefik/traefik/v3/pkg/provider/file"
"github.com/traefik/traefik/v3/pkg/provider/http"
"github.com/traefik/traefik/v3/pkg/provider/hub"
"github.com/traefik/traefik/v3/pkg/provider/kubernetes/crd"
"github.com/traefik/traefik/v3/pkg/provider/kubernetes/gateway"
"github.com/traefik/traefik/v3/pkg/provider/kubernetes/ingress"
"github.com/traefik/traefik/v3/pkg/provider/kv/consul"
"github.com/traefik/traefik/v3/pkg/provider/kv/etcd"
"github.com/traefik/traefik/v3/pkg/provider/kv/redis"
"github.com/traefik/traefik/v3/pkg/provider/kv/zk"
"github.com/traefik/traefik/v3/pkg/provider/nomad"
"github.com/traefik/traefik/v3/pkg/provider/rest"
"github.com/traefik/traefik/v3/pkg/tls"
"github.com/traefik/traefik/v3/pkg/tracing/datadog"
"github.com/traefik/traefik/v3/pkg/tracing/elastic"
"github.com/traefik/traefik/v3/pkg/tracing/haystack"
"github.com/traefik/traefik/v3/pkg/tracing/instana"
"github.com/traefik/traefik/v3/pkg/tracing/jaeger"
"github.com/traefik/traefik/v3/pkg/tracing/opentelemetry"
"github.com/traefik/traefik/v3/pkg/tracing/zipkin"
"github.com/traefik/traefik/v3/pkg/types"
2018-11-14 09:18:03 +00:00
)
2018-11-27 16:42:04 +00:00
const (
2020-08-21 09:12:04 +00:00
// DefaultInternalEntryPointName the name of the default internal entry point.
2018-11-27 16:42:04 +00:00
DefaultInternalEntryPointName = "traefik"
// DefaultGraceTimeout controls how long Traefik serves pending requests
// prior to shutting down.
DefaultGraceTimeout = 10 * time . Second
// DefaultIdleTimeout before closing an idle connection.
DefaultIdleTimeout = 180 * time . Second
2020-08-21 09:12:04 +00:00
// DefaultAcmeCAServer is the default ACME API endpoint.
2018-11-27 16:42:04 +00:00
DefaultAcmeCAServer = "https://acme-v02.api.letsencrypt.org/directory"
2021-01-07 16:16:03 +00:00
// DefaultUDPTimeout defines how long to wait by default on an idle session,
// before releasing all resources related to that session.
DefaultUDPTimeout = 3 * time . Second
2018-11-27 16:42:04 +00:00
)
2020-05-11 10:06:07 +00:00
// Configuration is the static configuration.
2018-11-14 09:18:03 +00:00
type Configuration struct {
2019-07-01 09:30:05 +00:00
Global * Global ` description:"Global configuration options" json:"global,omitempty" toml:"global,omitempty" yaml:"global,omitempty" export:"true" `
2018-11-27 16:42:04 +00:00
2022-12-09 08:58:05 +00:00
ServersTransport * ServersTransport ` description:"Servers default transport." json:"serversTransport,omitempty" toml:"serversTransport,omitempty" yaml:"serversTransport,omitempty" export:"true" `
TCPServersTransport * TCPServersTransport ` description:"TCP servers default transport." json:"tcpServersTransport,omitempty" toml:"tcpServersTransport,omitempty" yaml:"tcpServersTransport,omitempty" export:"true" `
EntryPoints EntryPoints ` description:"Entry points definition." json:"entryPoints,omitempty" toml:"entryPoints,omitempty" yaml:"entryPoints,omitempty" export:"true" `
Providers * Providers ` description:"Providers configuration." json:"providers,omitempty" toml:"providers,omitempty" yaml:"providers,omitempty" export:"true" `
2018-11-14 09:18:03 +00:00
2020-06-17 14:48:04 +00:00
API * API ` description:"Enable api/dashboard." json:"api,omitempty" toml:"api,omitempty" yaml:"api,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2019-07-01 09:30:05 +00:00
Metrics * types . Metrics ` description:"Enable a metrics exporter." json:"metrics,omitempty" toml:"metrics,omitempty" yaml:"metrics,omitempty" export:"true" `
2020-06-17 14:48:04 +00:00
Ping * ping . Handler ` description:"Enable ping." json:"ping,omitempty" toml:"ping,omitempty" yaml:"ping,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2018-11-14 09:18:03 +00:00
2020-06-17 14:48:04 +00:00
Log * types . TraefikLog ` description:"Traefik log settings." json:"log,omitempty" toml:"log,omitempty" yaml:"log,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
AccessLog * types . AccessLog ` description:"Access log settings." json:"accessLog,omitempty" toml:"accessLog,omitempty" yaml:"accessLog,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Tracing * Tracing ` description:"OpenTracing configuration." json:"tracing,omitempty" toml:"tracing,omitempty" yaml:"tracing,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2018-11-14 09:18:03 +00:00
2020-06-17 14:48:04 +00:00
HostResolver * types . HostResolverConfig ` description:"Enable CNAME Flattening." json:"hostResolver,omitempty" toml:"hostResolver,omitempty" yaml:"hostResolver,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2018-11-14 09:18:03 +00:00
2019-07-19 09:52:04 +00:00
CertificatesResolvers map [ string ] CertificateResolver ` description:"Certificates resolvers configuration." json:"certificatesResolvers,omitempty" toml:"certificatesResolvers,omitempty" yaml:"certificatesResolvers,omitempty" export:"true" `
2020-05-04 09:40:46 +00:00
2022-03-24 18:44:08 +00:00
Hub * hub . Provider ` description:"Traefik Hub configuration." json:"hub,omitempty" toml:"hub,omitempty" yaml:"hub,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2020-10-30 11:44:05 +00:00
Experimental * Experimental ` description:"experimental features." json:"experimental,omitempty" toml:"experimental,omitempty" yaml:"experimental,omitempty" export:"true" `
2022-10-14 15:16:08 +00:00
Spiffe * SpiffeClientConfig ` description:"SPIFFE integration configuration." json:"spiffe,omitempty" toml:"spiffe,omitempty" yaml:"spiffe,omitempty" export:"true" `
}
// SpiffeClientConfig defines the SPIFFE client configuration.
type SpiffeClientConfig struct {
WorkloadAPIAddr string ` description:"Defines the workload API address." json:"workloadAPIAddr,omitempty" toml:"workloadAPIAddr,omitempty" yaml:"workloadAPIAddr,omitempty" `
2020-05-04 09:40:46 +00:00
}
2019-07-19 09:52:04 +00:00
// CertificateResolver contains the configuration for the different types of certificates resolver.
type CertificateResolver struct {
2022-09-30 13:20:08 +00:00
ACME * acmeprovider . Configuration ` description:"Enables ACME (Let's Encrypt) automatic SSL." json:"acme,omitempty" toml:"acme,omitempty" yaml:"acme,omitempty" export:"true" `
Tailscale * struct { } ` description:"Enables Tailscale certificate resolution." json:"tailscale,omitempty" toml:"tailscale,omitempty" yaml:"tailscale,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2018-11-14 09:18:03 +00:00
}
// Global holds the global configuration.
type Global struct {
2020-06-17 14:48:04 +00:00
CheckNewVersion bool ` description:"Periodically check if a new version has been released." json:"checkNewVersion,omitempty" toml:"checkNewVersion,omitempty" yaml:"checkNewVersion,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
SendAnonymousUsage bool ` description:"Periodically send anonymous usage statistics. If the option is not specified, it will be enabled by default." json:"sendAnonymousUsage,omitempty" toml:"sendAnonymousUsage,omitempty" yaml:"sendAnonymousUsage,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2018-11-27 16:42:04 +00:00
}
2020-05-11 10:06:07 +00:00
// ServersTransport options to configure communication between Traefik and the servers.
2018-11-27 16:42:04 +00:00
type ServersTransport struct {
2019-07-01 09:30:05 +00:00
InsecureSkipVerify bool ` description:"Disable SSL certificate verification." json:"insecureSkipVerify,omitempty" toml:"insecureSkipVerify,omitempty" yaml:"insecureSkipVerify,omitempty" export:"true" `
RootCAs [ ] tls . FileOrContent ` description:"Add cert file for self-signed certificate." json:"rootCAs,omitempty" toml:"rootCAs,omitempty" yaml:"rootCAs,omitempty" `
MaxIdleConnsPerHost int ` description:"If non-zero, controls the maximum idle (keep-alive) to keep per-host. If zero, DefaultMaxIdleConnsPerHost is used" json:"maxIdleConnsPerHost,omitempty" toml:"maxIdleConnsPerHost,omitempty" yaml:"maxIdleConnsPerHost,omitempty" export:"true" `
ForwardingTimeouts * ForwardingTimeouts ` description:"Timeouts for requests forwarded to the backend servers." json:"forwardingTimeouts,omitempty" toml:"forwardingTimeouts,omitempty" yaml:"forwardingTimeouts,omitempty" export:"true" `
2022-10-14 15:16:08 +00:00
Spiffe * Spiffe ` description:"Defines the SPIFFE configuration." json:"spiffe,omitempty" toml:"spiffe,omitempty" yaml:"spiffe,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
}
// Spiffe holds the SPIFFE configuration.
type Spiffe struct {
IDs [ ] string ` description:"Defines the allowed SPIFFE IDs (takes precedence over the SPIFFE TrustDomain)." json:"ids,omitempty" toml:"ids,omitempty" yaml:"ids,omitempty" `
2023-04-17 09:34:00 +00:00
TrustDomain string ` description:"Defines the allowed SPIFFE trust domain." json:"trustDomain,omitempty" toml:"trustDomain,omitempty" yaml:"trustDomain,omitempty" `
2018-11-14 09:18:03 +00:00
}
2022-12-09 08:58:05 +00:00
// TCPServersTransport options to configure communication between Traefik and the servers.
type TCPServersTransport struct {
DialKeepAlive ptypes . Duration ` description:"Defines the interval between keep-alive probes for an active network connection. If zero, keep-alive probes are sent with a default value (currently 15 seconds), if supported by the protocol and operating system. Network protocols or operating systems that do not support keep-alives ignore this field. If negative, keep-alive probes are disabled" json:"dialKeepAlive,omitempty" toml:"dialKeepAlive,omitempty" yaml:"dialKeepAlive,omitempty" export:"true" `
DialTimeout ptypes . Duration ` description:"Defines the amount of time to wait until a connection to a backend server can be established. If zero, no timeout exists." json:"dialTimeout,omitempty" toml:"dialTimeout,omitempty" yaml:"dialTimeout,omitempty" export:"true" `
// TerminationDelay, corresponds to the deadline that the proxy sets, after one
// of its connected peers indicates it has closed the writing capability of its
// connection, to close the reading capability as well, hence fully terminating the
// connection. It is a duration in milliseconds, defaulting to 100. A negative value
// means an infinite deadline (i.e. the reading capability is never closed).
TerminationDelay ptypes . Duration ` description:"Defines the delay to wait before fully terminating the connection, after one connected peer has closed its writing capability." json:"terminationDelay,omitempty" toml:"terminationDelay,omitempty" yaml:"terminationDelay,omitempty" export:"true" `
TLS * TLSClientConfig ` description:"Defines the TLS configuration." json:"tls,omitempty" toml:"tls,omitempty" yaml:"tls,omitempty" label:"allowEmpty" file:"allowEmpty" kv:"allowEmpty" export:"true" `
}
// TLSClientConfig options to configure TLS communication between Traefik and the servers.
type TLSClientConfig struct {
InsecureSkipVerify bool ` description:"Disables SSL certificate verification." json:"insecureSkipVerify,omitempty" toml:"insecureSkipVerify,omitempty" yaml:"insecureSkipVerify,omitempty" export:"true" `
RootCAs [ ] tls . FileOrContent ` description:"Defines a list of CA secret used to validate self-signed certificate" json:"rootCAs,omitempty" toml:"rootCAs,omitempty" yaml:"rootCAs,omitempty" `
Spiffe * Spiffe ` description:"Defines the SPIFFE TLS configuration." json:"spiffe,omitempty" toml:"spiffe,omitempty" yaml:"spiffe,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
}
2020-05-11 10:06:07 +00:00
// API holds the API configuration.
2018-11-14 09:18:03 +00:00
type API struct {
2019-09-06 13:08:04 +00:00
Insecure bool ` description:"Activate API directly on the entryPoint named traefik." json:"insecure,omitempty" toml:"insecure,omitempty" yaml:"insecure,omitempty" export:"true" `
2019-07-19 10:28:07 +00:00
Dashboard bool ` description:"Activate dashboard." json:"dashboard,omitempty" toml:"dashboard,omitempty" yaml:"dashboard,omitempty" export:"true" `
Debug bool ` description:"Enable additional endpoints for debugging and profiling." json:"debug,omitempty" toml:"debug,omitempty" yaml:"debug,omitempty" export:"true" `
// TODO: Re-enable statistics
2022-01-24 10:08:05 +00:00
// Statistics *types.Statistics `description:"Enable more detailed statistics." json:"statistics,omitempty" toml:"statistics,omitempty" yaml:"statistics,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true"`
2019-06-17 09:48:05 +00:00
}
// SetDefaults sets the default values.
func ( a * API ) SetDefaults ( ) {
a . Dashboard = true
2018-11-14 09:18:03 +00:00
}
// RespondingTimeouts contains timeout configurations for incoming requests to the Traefik instance.
type RespondingTimeouts struct {
2020-08-17 16:04:03 +00:00
ReadTimeout ptypes . Duration ` description:"ReadTimeout is the maximum duration for reading the entire request, including the body. If zero, no timeout is set." json:"readTimeout,omitempty" toml:"readTimeout,omitempty" yaml:"readTimeout,omitempty" export:"true" `
WriteTimeout ptypes . Duration ` description:"WriteTimeout is the maximum duration before timing out writes of the response. If zero, no timeout is set." json:"writeTimeout,omitempty" toml:"writeTimeout,omitempty" yaml:"writeTimeout,omitempty" export:"true" `
IdleTimeout ptypes . Duration ` description:"IdleTimeout is the maximum amount duration an idle (keep-alive) connection will remain idle before closing itself. If zero, no timeout is set." json:"idleTimeout,omitempty" toml:"idleTimeout,omitempty" yaml:"idleTimeout,omitempty" export:"true" `
2019-06-17 09:48:05 +00:00
}
// SetDefaults sets the default values.
func ( a * RespondingTimeouts ) SetDefaults ( ) {
2020-08-17 16:04:03 +00:00
a . IdleTimeout = ptypes . Duration ( DefaultIdleTimeout )
2018-11-14 09:18:03 +00:00
}
// ForwardingTimeouts contains timeout configurations for forwarding requests to the backend servers.
type ForwardingTimeouts struct {
2020-08-17 16:04:03 +00:00
DialTimeout ptypes . Duration ` description:"The amount of time to wait until a connection to a backend server can be established. If zero, no timeout exists." json:"dialTimeout,omitempty" toml:"dialTimeout,omitempty" yaml:"dialTimeout,omitempty" export:"true" `
ResponseHeaderTimeout ptypes . Duration ` description:"The amount of time to wait for a server's response headers after fully writing the request (including its body, if any). If zero, no timeout exists." json:"responseHeaderTimeout,omitempty" toml:"responseHeaderTimeout,omitempty" yaml:"responseHeaderTimeout,omitempty" export:"true" `
IdleConnTimeout ptypes . Duration ` description:"The maximum period for which an idle HTTP keep-alive connection will remain open before closing itself" json:"idleConnTimeout,omitempty" toml:"idleConnTimeout,omitempty" yaml:"idleConnTimeout,omitempty" export:"true" `
2019-06-17 09:48:05 +00:00
}
// SetDefaults sets the default values.
func ( f * ForwardingTimeouts ) SetDefaults ( ) {
2020-08-17 16:04:03 +00:00
f . DialTimeout = ptypes . Duration ( 30 * time . Second )
f . IdleConnTimeout = ptypes . Duration ( 90 * time . Second )
2018-11-14 09:18:03 +00:00
}
// LifeCycle contains configurations relevant to the lifecycle (such as the shutdown phase) of Traefik.
type LifeCycle struct {
2020-08-17 16:04:03 +00:00
RequestAcceptGraceTimeout ptypes . Duration ` description:"Duration to keep accepting requests before Traefik initiates the graceful shutdown procedure." json:"requestAcceptGraceTimeout,omitempty" toml:"requestAcceptGraceTimeout,omitempty" yaml:"requestAcceptGraceTimeout,omitempty" export:"true" `
GraceTimeOut ptypes . Duration ` description:"Duration to give active requests a chance to finish before Traefik stops." json:"graceTimeOut,omitempty" toml:"graceTimeOut,omitempty" yaml:"graceTimeOut,omitempty" export:"true" `
2019-06-17 09:48:05 +00:00
}
// SetDefaults sets the default values.
func ( a * LifeCycle ) SetDefaults ( ) {
2020-08-17 16:04:03 +00:00
a . GraceTimeOut = ptypes . Duration ( DefaultGraceTimeout )
2018-11-14 09:18:03 +00:00
}
// Tracing holds the tracing configuration.
type Tracing struct {
2022-11-29 14:34:05 +00:00
ServiceName string ` description:"Set the name for this service." json:"serviceName,omitempty" toml:"serviceName,omitempty" yaml:"serviceName,omitempty" export:"true" `
SpanNameLimit int ` description:"Set the maximum character limit for Span names (default 0 = no limit)." json:"spanNameLimit,omitempty" toml:"spanNameLimit,omitempty" yaml:"spanNameLimit,omitempty" export:"true" `
2023-04-17 09:34:00 +00:00
Jaeger * jaeger . Config ` description:"Settings for Jaeger." json:"jaeger,omitempty" toml:"jaeger,omitempty" yaml:"jaeger,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Zipkin * zipkin . Config ` description:"Settings for Zipkin." json:"zipkin,omitempty" toml:"zipkin,omitempty" yaml:"zipkin,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Datadog * datadog . Config ` description:"Settings for Datadog." json:"datadog,omitempty" toml:"datadog,omitempty" yaml:"datadog,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Instana * instana . Config ` description:"Settings for Instana." json:"instana,omitempty" toml:"instana,omitempty" yaml:"instana,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Haystack * haystack . Config ` description:"Settings for Haystack." json:"haystack,omitempty" toml:"haystack,omitempty" yaml:"haystack,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Elastic * elastic . Config ` description:"Settings for Elastic." json:"elastic,omitempty" toml:"elastic,omitempty" yaml:"elastic,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
OpenTelemetry * opentelemetry . Config ` description:"Settings for OpenTelemetry." json:"openTelemetry,omitempty" toml:"openTelemetry,omitempty" yaml:"openTelemetry,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2019-06-17 09:48:05 +00:00
}
// SetDefaults sets the default values.
func ( t * Tracing ) SetDefaults ( ) {
t . ServiceName = "traefik"
t . SpanNameLimit = 0
2018-11-14 09:18:03 +00:00
}
2020-05-11 10:06:07 +00:00
// Providers contains providers configuration.
2018-11-27 16:42:04 +00:00
type Providers struct {
2020-08-17 16:04:03 +00:00
ProvidersThrottleDuration ptypes . Duration ` description:"Backends throttle duration: minimum duration between 2 events from providers before applying a new configuration. It avoids unnecessary reloads if multiples events are sent in a short amount of time." json:"providersThrottleDuration,omitempty" toml:"providersThrottleDuration,omitempty" yaml:"providersThrottleDuration,omitempty" export:"true" `
2019-11-28 20:56:04 +00:00
2023-04-03 08:06:06 +00:00
Docker * docker . Provider ` description:"Enable Docker backend with default settings." json:"docker,omitempty" toml:"docker,omitempty" yaml:"docker,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2022-06-03 10:00:09 +00:00
File * file . Provider ` description:"Enable File backend with default settings." json:"file,omitempty" toml:"file,omitempty" yaml:"file,omitempty" export:"true" `
2023-04-03 08:06:06 +00:00
KubernetesIngress * ingress . Provider ` description:"Enable Kubernetes backend with default settings." json:"kubernetesIngress,omitempty" toml:"kubernetesIngress,omitempty" yaml:"kubernetesIngress,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
KubernetesCRD * crd . Provider ` description:"Enable Kubernetes backend with default settings." json:"kubernetesCRD,omitempty" toml:"kubernetesCRD,omitempty" yaml:"kubernetesCRD,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
KubernetesGateway * gateway . Provider ` description:"Enable Kubernetes gateway api provider with default settings." json:"kubernetesGateway,omitempty" toml:"kubernetesGateway,omitempty" yaml:"kubernetesGateway,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2023-04-17 09:34:00 +00:00
Rest * rest . Provider ` description:"Enable Rest backend with default settings." json:"rest,omitempty" toml:"rest,omitempty" yaml:"rest,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2022-06-03 10:00:09 +00:00
ConsulCatalog * consulcatalog . ProviderBuilder ` description:"Enable ConsulCatalog backend with default settings." json:"consulCatalog,omitempty" toml:"consulCatalog,omitempty" yaml:"consulCatalog,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2022-09-19 14:26:08 +00:00
Nomad * nomad . ProviderBuilder ` description:"Enable Nomad backend with default settings." json:"nomad,omitempty" toml:"nomad,omitempty" yaml:"nomad,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2022-06-03 10:00:09 +00:00
Ecs * ecs . Provider ` description:"Enable AWS ECS backend with default settings." json:"ecs,omitempty" toml:"ecs,omitempty" yaml:"ecs,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Consul * consul . ProviderBuilder ` description:"Enable Consul backend with default settings." json:"consul,omitempty" toml:"consul,omitempty" yaml:"consul,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Etcd * etcd . Provider ` description:"Enable Etcd backend with default settings." json:"etcd,omitempty" toml:"etcd,omitempty" yaml:"etcd,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
ZooKeeper * zk . Provider ` description:"Enable ZooKeeper backend with default settings." json:"zooKeeper,omitempty" toml:"zooKeeper,omitempty" yaml:"zooKeeper,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
Redis * redis . Provider ` description:"Enable Redis backend with default settings." json:"redis,omitempty" toml:"redis,omitempty" yaml:"redis,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
HTTP * http . Provider ` description:"Enable HTTP backend with default settings." json:"http,omitempty" toml:"http,omitempty" yaml:"http,omitempty" label:"allowEmpty" file:"allowEmpty" export:"true" `
2021-05-11 14:14:10 +00:00
2021-06-21 09:54:08 +00:00
Plugin map [ string ] PluginConf ` description:"Plugins configuration." json:"plugin,omitempty" toml:"plugin,omitempty" yaml:"plugin,omitempty" `
2018-11-27 16:42:04 +00:00
}
// SetEffectiveConfiguration adds missing configuration parameters derived from existing ones.
// It also takes care of maintaining backwards compatibility.
2019-07-15 08:22:03 +00:00
func ( c * Configuration ) SetEffectiveConfiguration ( ) {
2020-03-16 15:54:04 +00:00
// Creates the default entry point if needed
2022-05-18 15:22:08 +00:00
if ! c . hasUserDefinedEntrypoint ( ) {
2019-06-17 09:48:05 +00:00
ep := & EntryPoint { Address : ":80" }
ep . SetDefaults ( )
2022-03-24 18:44:08 +00:00
// TODO: double check this tomorrow
if c . EntryPoints == nil {
c . EntryPoints = make ( EntryPoints )
}
c . EntryPoints [ "http" ] = ep
2018-11-27 16:42:04 +00:00
}
2020-03-16 15:54:04 +00:00
// Creates the internal traefik entry point if needed
2019-09-06 13:08:04 +00:00
if ( c . API != nil && c . API . Insecure ) ||
2019-11-14 15:40:05 +00:00
( c . Ping != nil && ! c . Ping . ManualRouting && c . Ping . EntryPoint == DefaultInternalEntryPointName ) ||
( c . Metrics != nil && c . Metrics . Prometheus != nil && ! c . Metrics . Prometheus . ManualRouting && c . Metrics . Prometheus . EntryPoint == DefaultInternalEntryPointName ) ||
( c . Providers != nil && c . Providers . Rest != nil && c . Providers . Rest . Insecure ) {
2018-11-27 16:42:04 +00:00
if _ , ok := c . EntryPoints [ DefaultInternalEntryPointName ] ; ! ok {
2019-06-17 09:48:05 +00:00
ep := & EntryPoint { Address : ":8080" }
ep . SetDefaults ( )
c . EntryPoints [ DefaultInternalEntryPointName ] = ep
2018-11-27 16:42:04 +00:00
}
}
2022-03-24 18:44:08 +00:00
if c . Hub != nil {
if err := c . initHubProvider ( ) ; err != nil {
c . Hub = nil
2022-11-21 17:36:05 +00:00
log . Error ( ) . Err ( err ) . Msg ( "Unable to activate the Hub provider" )
2022-03-24 18:44:08 +00:00
} else {
2023-03-21 11:00:46 +00:00
log . Debug ( ) . Msg ( "Hub provider has been activated" )
2022-03-24 18:44:08 +00:00
}
}
2019-01-29 16:08:08 +00:00
if c . Providers . Docker != nil {
if c . Providers . Docker . SwarmModeRefreshSeconds <= 0 {
2020-08-17 16:04:03 +00:00
c . Providers . Docker . SwarmModeRefreshSeconds = ptypes . Duration ( 15 * time . Second )
2019-01-29 16:08:08 +00:00
}
2020-08-28 08:02:03 +00:00
2020-09-25 07:14:04 +00:00
if c . Providers . Docker . HTTPClientTimeout < 0 {
c . Providers . Docker . HTTPClientTimeout = 0
2020-08-28 08:02:03 +00:00
}
2019-01-29 16:08:08 +00:00
}
2022-06-03 10:00:09 +00:00
// Disable Gateway API provider if not enabled in experimental.
2020-12-15 15:40:05 +00:00
if c . Experimental == nil || ! c . Experimental . KubernetesGateway {
c . Providers . KubernetesGateway = nil
}
// Configure Gateway API provider
if c . Providers . KubernetesGateway != nil {
2022-11-21 17:36:05 +00:00
log . Debug ( ) . Msg ( "Experimental Kubernetes Gateway provider has been activated" )
2020-12-15 15:40:05 +00:00
entryPoints := make ( map [ string ] gateway . Entrypoint )
for epName , entryPoint := range c . EntryPoints {
entryPoints [ epName ] = gateway . Entrypoint { Address : entryPoint . GetAddress ( ) , HasHTTPTLSConf : entryPoint . HTTP . TLS != nil }
}
c . Providers . KubernetesGateway . EntryPoints = entryPoints
}
2018-11-27 16:42:04 +00:00
c . initACMEProvider ( )
}
2022-05-18 15:22:08 +00:00
func ( c * Configuration ) hasUserDefinedEntrypoint ( ) bool {
if len ( c . EntryPoints ) == 0 {
return false
}
switch len ( c . EntryPoints ) {
case 1 :
return c . EntryPoints [ hub . TunnelEntrypoint ] == nil
case 2 :
return c . EntryPoints [ hub . TunnelEntrypoint ] == nil || c . EntryPoints [ hub . APIEntrypoint ] == nil
default :
return true
}
}
2018-11-27 16:42:04 +00:00
func ( c * Configuration ) initACMEProvider ( ) {
2019-07-19 09:52:04 +00:00
for _ , resolver := range c . CertificatesResolvers {
if resolver . ACME != nil {
resolver . ACME . CAServer = getSafeACMECAServer ( resolver . ACME . CAServer )
2018-11-27 16:42:04 +00:00
}
2019-07-19 09:52:04 +00:00
}
2018-11-27 16:42:04 +00:00
2022-11-21 17:36:05 +00:00
logger := logs . NoLevel ( log . Logger , zerolog . DebugLevel ) . With ( ) . Str ( "lib" , "lego" ) . Logger ( )
legolog . Logger = logs . NewLogrusWrapper ( logger )
2019-07-19 09:52:04 +00:00
}
2018-11-27 16:42:04 +00:00
2020-05-11 10:06:07 +00:00
// ValidateConfiguration validate that configuration is coherent.
2019-07-19 09:52:04 +00:00
func ( c * Configuration ) ValidateConfiguration ( ) error {
var acmeEmail string
for name , resolver := range c . CertificatesResolvers {
2022-09-30 13:20:08 +00:00
if resolver . ACME != nil && resolver . Tailscale != nil {
return fmt . Errorf ( "unable to initialize certificates resolver %q, as ACME and Tailscale providers are mutually exclusive" , name )
}
2019-07-19 09:52:04 +00:00
if resolver . ACME == nil {
continue
2018-11-27 16:42:04 +00:00
}
2019-07-19 09:52:04 +00:00
if len ( resolver . ACME . Storage ) == 0 {
return fmt . Errorf ( "unable to initialize certificates resolver %q with no storage location for the certificates" , name )
2018-11-27 16:42:04 +00:00
}
2019-07-19 09:52:04 +00:00
if acmeEmail != "" && resolver . ACME . Email != acmeEmail {
2022-09-30 13:20:08 +00:00
return fmt . Errorf ( "unable to initialize certificates resolver %q, as all ACME resolvers must use the same email" , name )
2018-11-27 16:42:04 +00:00
}
2019-07-19 09:52:04 +00:00
acmeEmail = resolver . ACME . Email
2018-11-27 16:42:04 +00:00
}
2019-07-19 09:52:04 +00:00
return nil
2018-11-27 16:42:04 +00:00
}
func getSafeACMECAServer ( caServerSrc string ) string {
if len ( caServerSrc ) == 0 {
return DefaultAcmeCAServer
}
if strings . HasPrefix ( caServerSrc , "https://acme-v01.api.letsencrypt.org" ) {
caServer := strings . Replace ( caServerSrc , "v01" , "v02" , 1 )
2022-11-21 17:36:05 +00:00
log . Warn ( ) . Msgf ( "The CA server %[1]q refers to a v01 endpoint of the ACME API, please change to %[2]q. Fallback to %[2]q." , caServerSrc , caServer )
2018-11-27 16:42:04 +00:00
return caServer
}
if strings . HasPrefix ( caServerSrc , "https://acme-staging.api.letsencrypt.org" ) {
caServer := strings . Replace ( caServerSrc , "https://acme-staging.api.letsencrypt.org" , "https://acme-staging-v02.api.letsencrypt.org" , 1 )
2022-11-21 17:36:05 +00:00
log . Warn ( ) . Msgf ( "The CA server %[1]q refers to a v01 endpoint of the ACME API, please change to %[2]q. Fallback to %[2]q." , caServerSrc , caServer )
2018-11-27 16:42:04 +00:00
return caServer
}
return caServerSrc
}