traefik/pkg/provider/aggregator/aggregator.go

207 lines
5.4 KiB
Go
Raw Normal View History

2018-11-14 09:18:03 +00:00
package aggregator
import (
"context"
"time"
2022-11-21 17:36:05 +00:00
"github.com/rs/zerolog/log"
2023-02-03 14:24:05 +00:00
"github.com/traefik/traefik/v3/pkg/config/dynamic"
"github.com/traefik/traefik/v3/pkg/config/static"
"github.com/traefik/traefik/v3/pkg/provider"
"github.com/traefik/traefik/v3/pkg/provider/file"
"github.com/traefik/traefik/v3/pkg/provider/traefik"
"github.com/traefik/traefik/v3/pkg/redactor"
"github.com/traefik/traefik/v3/pkg/safe"
2018-11-14 09:18:03 +00:00
)
// throttled defines what kind of config refresh throttling the aggregator should
// set up for a given provider.
// If a provider implements throttled, the configuration changes it sends will be
// taken into account no more often than the frequency inferred from ThrottleDuration().
// If ThrottleDuration returns zero, no throttling will take place.
// If throttled is not implemented, the throttling will be set up in accordance
// with the global providersThrottleDuration option.
type throttled interface {
ThrottleDuration() time.Duration
}
// maybeThrottledProvide returns the Provide method of the given provider,
// potentially augmented with some throttling depending on whether and how the
// provider implements the throttled interface.
func maybeThrottledProvide(prd provider.Provider, defaultDuration time.Duration) func(chan<- dynamic.Message, *safe.Pool) error {
providerThrottleDuration := defaultDuration
if throttled, ok := prd.(throttled); ok {
// per-provider throttling
providerThrottleDuration = throttled.ThrottleDuration()
}
if providerThrottleDuration == 0 {
// throttling disabled
return prd.Provide
}
return func(configurationChan chan<- dynamic.Message, pool *safe.Pool) error {
rc := newRingChannel()
pool.GoCtx(func(ctx context.Context) {
for {
select {
case <-ctx.Done():
return
case msg := <-rc.out():
configurationChan <- msg
time.Sleep(providerThrottleDuration)
}
}
})
return prd.Provide(rc.in(), pool)
}
}
2018-11-14 09:18:03 +00:00
// ProviderAggregator aggregates providers.
type ProviderAggregator struct {
internalProvider provider.Provider
fileProvider provider.Provider
providers []provider.Provider
providersThrottleDuration time.Duration
2018-11-14 09:18:03 +00:00
}
// NewProviderAggregator returns an aggregate of all the providers configured in the static configuration.
func NewProviderAggregator(conf static.Providers) ProviderAggregator {
p := ProviderAggregator{
providersThrottleDuration: time.Duration(conf.ProvidersThrottleDuration),
}
2018-11-14 09:18:03 +00:00
if conf.File != nil {
p.quietAddProvider(conf.File)
}
if conf.Docker != nil {
p.quietAddProvider(conf.Docker)
}
2018-12-03 10:32:05 +00:00
if conf.Rest != nil {
p.quietAddProvider(conf.Rest)
}
if conf.KubernetesIngress != nil {
p.quietAddProvider(conf.KubernetesIngress)
}
if conf.KubernetesCRD != nil {
p.quietAddProvider(conf.KubernetesCRD)
}
if conf.KubernetesGateway != nil {
p.quietAddProvider(conf.KubernetesGateway)
}
if conf.Ecs != nil {
p.quietAddProvider(conf.Ecs)
}
2019-10-15 15:34:08 +00:00
if conf.ConsulCatalog != nil {
for _, pvd := range conf.ConsulCatalog.BuildProviders() {
p.quietAddProvider(pvd)
}
2019-10-15 15:34:08 +00:00
}
if conf.Nomad != nil {
for _, pvd := range conf.Nomad.BuildProviders() {
p.quietAddProvider(pvd)
}
}
if conf.Consul != nil {
for _, pvd := range conf.Consul.BuildProviders() {
p.quietAddProvider(pvd)
}
}
if conf.Etcd != nil {
p.quietAddProvider(conf.Etcd)
}
if conf.ZooKeeper != nil {
p.quietAddProvider(conf.ZooKeeper)
}
if conf.Redis != nil {
p.quietAddProvider(conf.Redis)
}
if conf.HTTP != nil {
p.quietAddProvider(conf.HTTP)
}
2018-11-14 09:18:03 +00:00
return p
}
func (p *ProviderAggregator) quietAddProvider(provider provider.Provider) {
err := p.AddProvider(provider)
if err != nil {
2022-11-21 17:36:05 +00:00
log.Error().Err(err).Msgf("Error while initializing provider %T", provider)
2018-11-14 09:18:03 +00:00
}
}
// AddProvider adds a provider in the providers map.
func (p *ProviderAggregator) AddProvider(provider provider.Provider) error {
err := provider.Init()
2018-11-14 09:18:03 +00:00
if err != nil {
return err
}
switch provider.(type) {
case *file.Provider:
p.fileProvider = provider
case *traefik.Provider:
p.internalProvider = provider
default:
p.providers = append(p.providers, provider)
}
2018-11-14 09:18:03 +00:00
return nil
}
2020-05-11 10:06:07 +00:00
// Init the provider.
func (p ProviderAggregator) Init() error {
2018-11-14 09:18:03 +00:00
return nil
}
2020-05-11 10:06:07 +00:00
// Provide calls the provide method of every providers.
func (p ProviderAggregator) Provide(configurationChan chan<- dynamic.Message, pool *safe.Pool) error {
2021-02-01 11:36:03 +00:00
if p.fileProvider != nil {
p.launchProvider(configurationChan, pool, p.fileProvider)
2021-02-01 11:36:03 +00:00
}
2018-11-14 09:18:03 +00:00
for _, prd := range p.providers {
2019-03-19 09:04:04 +00:00
prd := prd
2018-11-14 09:18:03 +00:00
safe.Go(func() {
p.launchProvider(configurationChan, pool, prd)
2018-11-14 09:18:03 +00:00
})
}
// internal provider must be the last because we use it to know if all the providers are loaded.
// ConfigurationWatcher will wait for this requiredProvider before applying configurations.
if p.internalProvider != nil {
p.launchProvider(configurationChan, pool, p.internalProvider)
}
2018-11-14 09:18:03 +00:00
return nil
}
func (p ProviderAggregator) launchProvider(configurationChan chan<- dynamic.Message, pool *safe.Pool, prd provider.Provider) {
jsonConf, err := redactor.RemoveCredentials(prd)
if err != nil {
2022-11-21 17:36:05 +00:00
log.Debug().Err(err).Msgf("Cannot marshal the provider configuration %T", prd)
}
2022-11-21 17:36:05 +00:00
log.Info().Msgf("Starting provider %T", prd)
log.Debug().RawJSON("config", []byte(jsonConf)).Msgf("%T provider configuration", prd)
if err := maybeThrottledProvide(prd, p.providersThrottleDuration)(configurationChan, pool); err != nil {
2022-11-21 17:36:05 +00:00
log.Error().Err(err).Msgf("Cannot start the provider %T", prd)
return
}
}