daemon/discovery/discovery.go
db63f937
 package discovery
7d193ef1
 
 import (
677a6b35
 	"errors"
2efdb8cb
 	"fmt"
 	"strconv"
7d193ef1
 	"time"
 
 	"github.com/docker/docker/pkg/discovery"
1009e6a4
 	"github.com/sirupsen/logrus"
7d193ef1
 
 	// Register the libkv backends for discovery.
 	_ "github.com/docker/docker/pkg/discovery/kv"
 )
 
 const (
 	// defaultDiscoveryHeartbeat is the default value for discovery heartbeat interval.
 	defaultDiscoveryHeartbeat = 20 * time.Second
2efdb8cb
 	// defaultDiscoveryTTLFactor is the default TTL factor for discovery
 	defaultDiscoveryTTLFactor = 3
7d193ef1
 )
 
db63f937
 // ErrDiscoveryDisabled is an error returned if the discovery is disabled
 var ErrDiscoveryDisabled = errors.New("discovery is disabled")
677a6b35
 
db63f937
 // Reloader is the discovery reloader of the daemon
 type Reloader interface {
677a6b35
 	discovery.Watcher
 	Stop()
 	Reload(backend, address string, clusterOpts map[string]string) error
2dce79e0
 	ReadyCh() <-chan struct{}
677a6b35
 }
 
 type daemonDiscoveryReloader struct {
 	backend discovery.Backend
 	ticker  *time.Ticker
 	term    chan bool
2dce79e0
 	readyCh chan struct{}
677a6b35
 }
 
 func (d *daemonDiscoveryReloader) Watch(stopCh <-chan struct{}) (<-chan discovery.Entries, <-chan error) {
 	return d.backend.Watch(stopCh)
 }
 
2dce79e0
 func (d *daemonDiscoveryReloader) ReadyCh() <-chan struct{} {
 	return d.readyCh
 }
 
2efdb8cb
 func discoveryOpts(clusterOpts map[string]string) (time.Duration, time.Duration, error) {
 	var (
 		heartbeat = defaultDiscoveryHeartbeat
 		ttl       = defaultDiscoveryTTLFactor * defaultDiscoveryHeartbeat
 	)
 
 	if hb, ok := clusterOpts["discovery.heartbeat"]; ok {
 		h, err := strconv.Atoi(hb)
 		if err != nil {
 			return time.Duration(0), time.Duration(0), err
 		}
68fde862
 
 		if h <= 0 {
 			return time.Duration(0), time.Duration(0),
 				fmt.Errorf("discovery.heartbeat must be positive")
 		}
 
2efdb8cb
 		heartbeat = time.Duration(h) * time.Second
 		ttl = defaultDiscoveryTTLFactor * heartbeat
 	}
 
 	if tstr, ok := clusterOpts["discovery.ttl"]; ok {
 		t, err := strconv.Atoi(tstr)
 		if err != nil {
 			return time.Duration(0), time.Duration(0), err
 		}
68fde862
 
 		if t <= 0 {
 			return time.Duration(0), time.Duration(0),
 				fmt.Errorf("discovery.ttl must be positive")
 		}
 
2efdb8cb
 		ttl = time.Duration(t) * time.Second
 
 		if _, ok := clusterOpts["discovery.heartbeat"]; !ok {
fb2bc352
 			heartbeat = time.Duration(t) * time.Second / time.Duration(defaultDiscoveryTTLFactor)
2efdb8cb
 		}
 
 		if ttl <= heartbeat {
 			return time.Duration(0), time.Duration(0),
 				fmt.Errorf("discovery.ttl timer must be greater than discovery.heartbeat")
 		}
 	}
 
 	return heartbeat, ttl, nil
 }
 
db63f937
 // Init initializes the nodes discovery subsystem by connecting to the specified backend
bbeb859b
 // and starts a registration loop to advertise the current node under the specified address.
db63f937
 func Init(backendAddress, advertiseAddress string, clusterOpts map[string]string) (Reloader, error) {
677a6b35
 	heartbeat, backend, err := parseDiscoveryOptions(backendAddress, clusterOpts)
2efdb8cb
 	if err != nil {
 		return nil, err
 	}
 
677a6b35
 	reloader := &daemonDiscoveryReloader{
 		backend: backend,
 		ticker:  time.NewTicker(heartbeat),
 		term:    make(chan bool),
2dce79e0
 		readyCh: make(chan struct{}),
7d193ef1
 	}
 	// We call Register() on the discovery backend in a loop for the whole lifetime of the daemon,
 	// but we never actually Watch() for nodes appearing and disappearing for the moment.
2dce79e0
 	go reloader.advertiseHeartbeat(advertiseAddress)
677a6b35
 	return reloader, nil
7d193ef1
 }
 
677a6b35
 // advertiseHeartbeat registers the current node against the discovery backend using the specified
7d193ef1
 // address. The function never returns, as registration against the backend comes with a TTL and
 // requires regular heartbeats.
677a6b35
 func (d *daemonDiscoveryReloader) advertiseHeartbeat(address string) {
2dce79e0
 	var ready bool
 	if err := d.initHeartbeat(address); err == nil {
 		ready = true
 		close(d.readyCh)
87d0a3ad
 	} else {
 		logrus.WithError(err).Debug("First discovery heartbeat failed")
2dce79e0
 	}
 
677a6b35
 	for {
 		select {
 		case <-d.ticker.C:
2dce79e0
 			if err := d.backend.Register(address); err != nil {
6a1183b3
 				logrus.Warnf("Registering as %q in discovery failed: %v", address, err)
2dce79e0
 			} else {
 				if !ready {
 					close(d.readyCh)
 					ready = true
 				}
 			}
677a6b35
 		case <-d.term:
 			return
 		}
 	}
 }
 
2dce79e0
 // initHeartbeat is used to do the first heartbeat. It uses a tight loop until
 // either the timeout period is reached or the heartbeat is successful and returns.
 func (d *daemonDiscoveryReloader) initHeartbeat(address string) error {
 	// Setup a short ticker until the first heartbeat has succeeded
 	t := time.NewTicker(500 * time.Millisecond)
 	defer t.Stop()
 	// timeout makes sure that after a period of time we stop being so aggressive trying to reach the discovery service
 	timeout := time.After(60 * time.Second)
 
 	for {
 		select {
 		case <-timeout:
 			return errors.New("timeout waiting for initial discovery")
 		case <-d.term:
 			return errors.New("terminated")
 		case <-t.C:
 			if err := d.backend.Register(address); err == nil {
 				return nil
 			}
 		}
 	}
 }
 
677a6b35
 // Reload makes the watcher to stop advertising and reconfigures it to advertise in a new address.
 func (d *daemonDiscoveryReloader) Reload(backendAddress, advertiseAddress string, clusterOpts map[string]string) error {
 	d.Stop()
 
 	heartbeat, backend, err := parseDiscoveryOptions(backendAddress, clusterOpts)
 	if err != nil {
 		return err
 	}
 
 	d.backend = backend
 	d.ticker = time.NewTicker(heartbeat)
2dce79e0
 	d.readyCh = make(chan struct{})
677a6b35
 
2dce79e0
 	go d.advertiseHeartbeat(advertiseAddress)
677a6b35
 	return nil
 }
 
 // Stop terminates the discovery advertising.
 func (d *daemonDiscoveryReloader) Stop() {
 	d.ticker.Stop()
 	d.term <- true
 }
 
 func parseDiscoveryOptions(backendAddress string, clusterOpts map[string]string) (time.Duration, discovery.Backend, error) {
 	heartbeat, ttl, err := discoveryOpts(clusterOpts)
 	if err != nil {
 		return 0, nil, err
7d193ef1
 	}
677a6b35
 
 	backend, err := discovery.New(backendAddress, heartbeat, ttl, clusterOpts)
 	if err != nil {
 		return 0, nil, err
 	}
 	return heartbeat, backend, nil
 }