2017-04-15 13:49:53 +00:00
package docker
2015-09-12 13:10:03 +00:00
2015-09-07 22:15:14 +00:00
import (
2016-08-16 15:26:10 +00:00
"context"
2017-05-26 15:03:14 +00:00
"fmt"
2016-08-25 04:22:06 +00:00
"math"
2016-08-05 14:02:46 +00:00
"net"
2016-04-08 12:20:54 +00:00
"net/http"
2017-04-15 13:49:53 +00:00
"regexp"
2015-09-24 15:16:13 +00:00
"strconv"
"strings"
"text/template"
"time"
2015-09-10 20:54:37 +00:00
"github.com/BurntSushi/ty/fun"
2016-09-19 17:08:39 +00:00
"github.com/cenk/backoff"
"github.com/containous/traefik/job"
2016-09-23 16:27:01 +00:00
"github.com/containous/traefik/log"
2017-04-15 13:49:53 +00:00
"github.com/containous/traefik/provider"
2016-03-31 16:57:08 +00:00
"github.com/containous/traefik/safe"
2016-02-24 15:43:39 +00:00
"github.com/containous/traefik/types"
2016-07-21 14:33:49 +00:00
"github.com/containous/traefik/version"
2017-07-06 14:28:13 +00:00
dockertypes "github.com/docker/docker/api/types"
dockercontainertypes "github.com/docker/docker/api/types/container"
eventtypes "github.com/docker/docker/api/types/events"
"github.com/docker/docker/api/types/filters"
swarmtypes "github.com/docker/docker/api/types/swarm"
"github.com/docker/docker/client"
2016-08-05 14:02:46 +00:00
"github.com/docker/go-connections/nat"
2016-04-08 12:20:54 +00:00
"github.com/docker/go-connections/sockets"
2015-09-07 08:38:58 +00:00
)
2015-09-09 20:39:08 +00:00
2016-08-05 14:02:46 +00:00
const (
2017-04-15 13:49:53 +00:00
// SwarmAPIVersion is a constant holding the version of the Provider API traefik will use
2016-08-05 14:02:46 +00:00
SwarmAPIVersion string = "1.24"
// SwarmDefaultWatchTime is the duration of the interval when polling docker
SwarmDefaultWatchTime = 15 * time . Second
2017-07-10 14:58:12 +00:00
labelDockerNetwork = "traefik.docker.network"
labelBackendLoadbalancerSwarm = "traefik.backend.loadbalancer.swarm"
labelDockerComposeProject = "com.docker.compose.project"
labelDockerComposeService = "com.docker.compose.service"
2016-08-05 14:02:46 +00:00
)
2016-04-08 12:20:54 +00:00
2017-04-15 13:49:53 +00:00
var _ provider . Provider = ( * Provider ) ( nil )
2016-08-16 17:13:18 +00:00
2017-04-17 10:50:02 +00:00
// Provider holds configurations of the provider.
2017-04-15 13:49:53 +00:00
type Provider struct {
provider . BaseProvider ` mapstructure:",squash" `
2017-04-17 10:50:02 +00:00
Endpoint string ` description:"Docker server endpoint. Can be a tcp or a unix socket endpoint" `
2017-04-15 13:49:53 +00:00
Domain string ` description:"Default domain used" `
2017-04-17 10:50:02 +00:00
TLS * provider . ClientTLS ` description:"Enable Docker TLS support" `
2017-04-15 13:49:53 +00:00
ExposedByDefault bool ` description:"Expose containers by default" `
UseBindPortIP bool ` description:"Use the ip address from the bound port, rather than from the inner network" `
2017-04-17 10:50:02 +00:00
SwarmMode bool ` description:"Use Docker on Swarm Mode" `
2016-08-05 14:02:46 +00:00
}
2017-04-15 13:49:53 +00:00
// dockerData holds the need data to the Provider p
2016-08-05 14:02:46 +00:00
type dockerData struct {
2017-02-03 01:18:12 +00:00
ServiceName string
2016-08-05 14:02:46 +00:00
Name string
Labels map [ string ] string // List of labels set to container or service
NetworkSettings networkSettings
2016-10-03 09:01:37 +00:00
Health string
2016-08-05 14:02:46 +00:00
}
2017-04-15 13:49:53 +00:00
// NetworkSettings holds the networks data to the Provider p
2016-08-05 14:02:46 +00:00
type networkSettings struct {
NetworkMode dockercontainertypes . NetworkMode
Ports nat . PortMap
Networks map [ string ] * networkData
}
2017-04-15 13:49:53 +00:00
// Network holds the network data to the Provider p
2016-08-05 14:02:46 +00:00
type networkData struct {
Name string
Addr string
Port int
Protocol string
ID string
2015-11-20 15:05:06 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) createClient ( ) ( client . APIClient , error ) {
2016-04-08 12:20:54 +00:00
var httpClient * http . Client
httpHeaders := map [ string ] string {
2016-07-21 14:33:49 +00:00
"User-Agent" : "Traefik " + version . Version ,
2016-04-08 12:20:54 +00:00
}
2017-04-15 13:49:53 +00:00
if p . TLS != nil {
config , err := p . TLS . CreateTLSConfig ( )
2016-04-08 12:20:54 +00:00
if err != nil {
return nil , err
}
tr := & http . Transport {
TLSClientConfig : config ,
}
2017-04-15 13:49:53 +00:00
proto , addr , _ , err := client . ParseHost ( p . Endpoint )
2016-04-08 12:20:54 +00:00
if err != nil {
return nil , err
}
sockets . ConfigureTransport ( tr , proto , addr )
httpClient = & http . Client {
Transport : tr ,
}
2016-06-27 14:14:56 +00:00
2016-04-08 12:20:54 +00:00
}
2016-08-05 14:02:46 +00:00
var version string
2017-04-15 13:49:53 +00:00
if p . SwarmMode {
2016-08-05 14:02:46 +00:00
version = SwarmAPIVersion
} else {
version = DockerAPIVersion
}
2017-04-15 13:49:53 +00:00
return client . NewClient ( p . Endpoint , version , httpClient , httpHeaders )
2016-08-05 14:02:46 +00:00
2016-04-08 12:20:54 +00:00
}
2017-04-17 10:50:02 +00:00
// Provide allows the docker provider to provide configurations to traefik
2015-11-01 18:29:47 +00:00
// using the given configuration channel.
2017-04-15 13:49:53 +00:00
func ( p * Provider ) Provide ( configurationChan chan <- types . ConfigMessage , pool * safe . Pool , constraints types . Constraints ) error {
p . Constraints = append ( p . Constraints , constraints ... )
2016-04-13 18:36:23 +00:00
// TODO register this routine in pool, and watch for stop channel
2016-03-31 16:57:08 +00:00
safe . Go ( func ( ) {
2016-02-25 17:30:13 +00:00
operation := func ( ) error {
var err error
2015-11-01 18:29:47 +00:00
2017-04-15 13:49:53 +00:00
dockerClient , err := p . createClient ( )
2016-02-25 17:30:13 +00:00
if err != nil {
log . Errorf ( "Failed to create a client for docker, error: %s" , err )
return err
}
2016-06-08 17:39:38 +00:00
ctx := context . Background ( )
version , err := dockerClient . ServerVersion ( ctx )
2017-08-18 00:18:02 +00:00
if err != nil {
log . Errorf ( "Failed to retrieve information of the docker client and server host: %s" , err )
return err
}
2017-04-15 13:49:53 +00:00
log . Debugf ( "Provider connection established with docker %s (API %s)" , version . Version , version . APIVersion )
2016-08-05 14:02:46 +00:00
var dockerDataList [ ] dockerData
2017-04-15 13:49:53 +00:00
if p . SwarmMode {
dockerDataList , err = p . listServices ( ctx , dockerClient )
2016-08-05 14:02:46 +00:00
if err != nil {
log . Errorf ( "Failed to list services for docker swarm mode, error %s" , err )
return err
}
} else {
dockerDataList , err = listContainers ( ctx , dockerClient )
if err != nil {
log . Errorf ( "Failed to list containers for docker, error %s" , err )
return err
}
2016-02-25 17:30:13 +00:00
}
2016-08-05 14:02:46 +00:00
2017-04-15 13:49:53 +00:00
configuration := p . loadDockerConfig ( dockerDataList )
2016-02-25 17:30:13 +00:00
configurationChan <- types . ConfigMessage {
ProviderName : "docker" ,
Configuration : configuration ,
}
2017-04-15 13:49:53 +00:00
if p . Watch {
2016-06-08 17:39:38 +00:00
ctx , cancel := context . WithCancel ( ctx )
2017-04-15 13:49:53 +00:00
if p . SwarmMode {
2017-05-02 15:20:20 +00:00
errChan := make ( chan error )
2016-08-05 14:02:46 +00:00
// TODO: This need to be change. Linked to Swarm events docker/docker#23827
ticker := time . NewTicker ( SwarmDefaultWatchTime )
pool . Go ( func ( stop chan bool ) {
2017-05-02 15:20:20 +00:00
defer close ( errChan )
2016-08-05 14:02:46 +00:00
for {
select {
case <- ticker . C :
2017-04-15 13:49:53 +00:00
services , err := p . listServices ( ctx , dockerClient )
2016-08-05 14:02:46 +00:00
if err != nil {
log . Errorf ( "Failed to list services for docker, error %s" , err )
2017-05-02 15:20:20 +00:00
errChan <- err
2016-08-05 14:02:46 +00:00
return
}
2017-04-15 13:49:53 +00:00
configuration := p . loadDockerConfig ( services )
2016-08-05 14:02:46 +00:00
if configuration != nil {
configurationChan <- types . ConfigMessage {
ProviderName : "docker" ,
Configuration : configuration ,
}
}
case <- stop :
ticker . Stop ( )
cancel ( )
return
}
}
} )
2017-05-02 15:20:20 +00:00
if err , ok := <- errChan ; ok {
return err
}
// channel closed
2016-08-05 14:02:46 +00:00
} else {
pool . Go ( func ( stop chan bool ) {
for {
select {
case <- stop :
cancel ( )
return
}
}
} )
f := filters . NewArgs ( )
f . Add ( "type" , "container" )
options := dockertypes . EventsOptions {
Filters : f ,
}
2017-07-06 14:28:13 +00:00
2016-08-05 14:02:46 +00:00
startStopHandle := func ( m eventtypes . Message ) {
2017-04-15 13:49:53 +00:00
log . Debugf ( "Provider event received %+v" , m )
2016-08-05 14:02:46 +00:00
containers , err := listContainers ( ctx , dockerClient )
if err != nil {
log . Errorf ( "Failed to list containers for docker, error %s" , err )
// Call cancel to get out of the monitor
2016-06-16 20:49:57 +00:00
cancel ( )
return
}
2017-04-15 13:49:53 +00:00
configuration := p . loadDockerConfig ( containers )
2016-08-05 14:02:46 +00:00
if configuration != nil {
configurationChan <- types . ConfigMessage {
ProviderName : "docker" ,
Configuration : configuration ,
}
2015-09-10 20:54:37 +00:00
}
2015-09-10 07:06:37 +00:00
}
2017-07-06 14:28:13 +00:00
eventsc , errc := dockerClient . Events ( ctx , options )
for event := range eventsc {
if event . Action == "start" ||
event . Action == "die" ||
strings . HasPrefix ( event . Action , "health_status" ) {
startStopHandle ( event )
}
}
if err := <- errc ; err != nil {
2016-08-05 14:02:46 +00:00
return err
}
2016-04-08 12:20:54 +00:00
}
2015-11-01 18:29:47 +00:00
}
2016-02-25 17:30:13 +00:00
return nil
}
notify := func ( err error , time time . Duration ) {
2017-04-15 13:49:53 +00:00
log . Errorf ( "Provider connection error %+v, retrying in %s" , err , time )
2016-02-25 17:30:13 +00:00
}
2016-12-08 12:32:12 +00:00
err := backoff . RetryNotify ( safe . OperationWithRecover ( operation ) , job . NewBackOff ( backoff . NewExponentialBackOff ( ) ) , notify )
2016-02-25 17:30:13 +00:00
if err != nil {
2016-08-19 08:36:54 +00:00
log . Errorf ( "Cannot connect to docker server %+v" , err )
2016-02-25 17:30:13 +00:00
}
2016-03-31 16:57:08 +00:00
} )
2015-11-01 18:29:47 +00:00
2015-10-01 10:04:25 +00:00
return nil
2015-09-07 08:38:58 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) loadDockerConfig ( containersInspected [ ] dockerData ) * types . Configuration {
2015-10-08 19:21:51 +00:00
var DockerFuncMap = template . FuncMap {
2017-04-15 13:49:53 +00:00
"getBackend" : p . getBackend ,
"getIPAddress" : p . getIPAddress ,
"getPort" : p . getPort ,
"getWeight" : p . getWeight ,
"getDomain" : p . getDomain ,
"getProtocol" : p . getProtocol ,
"getPassHostHeader" : p . getPassHostHeader ,
"getPriority" : p . getPriority ,
"getEntryPoints" : p . getEntryPoints ,
2017-04-19 09:14:05 +00:00
"getBasicAuth" : p . getBasicAuth ,
2017-04-15 13:49:53 +00:00
"getFrontendRule" : p . getFrontendRule ,
"hasCircuitBreakerLabel" : p . hasCircuitBreakerLabel ,
"getCircuitBreakerExpression" : p . getCircuitBreakerExpression ,
"hasLoadBalancerLabel" : p . hasLoadBalancerLabel ,
"getLoadBalancerMethod" : p . getLoadBalancerMethod ,
"hasMaxConnLabels" : p . hasMaxConnLabels ,
"getMaxConnAmount" : p . getMaxConnAmount ,
"getMaxConnExtractorFunc" : p . getMaxConnExtractorFunc ,
"getSticky" : p . getSticky ,
"getIsBackendLBSwarm" : p . getIsBackendLBSwarm ,
"hasServices" : p . hasServices ,
"getServiceNames" : p . getServiceNames ,
"getServicePort" : p . getServicePort ,
"getServiceWeight" : p . getServiceWeight ,
"getServiceProtocol" : p . getServiceProtocol ,
"getServiceEntryPoints" : p . getServiceEntryPoints ,
2017-04-19 09:14:05 +00:00
"getServiceBasicAuth" : p . getServiceBasicAuth ,
2017-04-15 13:49:53 +00:00
"getServiceFrontendRule" : p . getServiceFrontendRule ,
"getServicePassHostHeader" : p . getServicePassHostHeader ,
"getServicePriority" : p . getServicePriority ,
"getServiceBackend" : p . getServiceBackend ,
2017-04-30 09:22:07 +00:00
"getWhitelistSourceRange" : p . getWhitelistSourceRange ,
2015-09-10 20:54:37 +00:00
}
// filter containers
2016-08-05 14:02:46 +00:00
filteredContainers := fun . Filter ( func ( container dockerData ) bool {
2017-04-15 13:49:53 +00:00
return p . containerFilter ( container )
2016-08-05 14:02:46 +00:00
} , containersInspected ) . ( [ ] dockerData )
2015-09-10 20:54:37 +00:00
2016-08-05 14:02:46 +00:00
frontends := map [ string ] [ ] dockerData { }
2016-09-28 14:29:19 +00:00
backends := map [ string ] dockerData { }
servers := map [ string ] [ ] dockerData { }
2015-09-10 20:54:37 +00:00
for _ , container := range filteredContainers {
2017-04-15 13:49:53 +00:00
frontendName := p . getFrontendName ( container )
2016-06-06 19:59:58 +00:00
frontends [ frontendName ] = append ( frontends [ frontendName ] , container )
2017-04-15 13:49:53 +00:00
backendName := p . getBackend ( container )
2016-09-28 14:29:19 +00:00
backends [ backendName ] = container
servers [ backendName ] = append ( servers [ backendName ] , container )
2015-09-07 08:38:58 +00:00
}
2015-09-09 14:49:51 +00:00
templateObjects := struct {
2016-09-28 11:28:20 +00:00
Containers [ ] dockerData
Frontends map [ string ] [ ] dockerData
2016-09-28 14:29:19 +00:00
Backends map [ string ] dockerData
Servers map [ string ] [ ] dockerData
2016-09-28 11:28:20 +00:00
Domain string
2015-09-07 08:38:58 +00:00
} {
2015-09-10 20:54:37 +00:00
filteredContainers ,
2015-10-23 07:49:19 +00:00
frontends ,
2016-09-28 14:29:19 +00:00
backends ,
servers ,
2017-04-15 13:49:53 +00:00
p . Domain ,
2015-09-07 08:38:58 +00:00
}
2017-04-15 13:49:53 +00:00
configuration , err := p . GetConfiguration ( "templates/docker.tmpl" , DockerFuncMap , templateObjects )
2015-09-07 08:38:58 +00:00
if err != nil {
2015-11-13 10:50:32 +00:00
log . Error ( err )
2015-09-07 08:38:58 +00:00
}
2015-11-13 10:50:32 +00:00
return configuration
}
2015-09-07 08:38:58 +00:00
2017-04-15 13:49:53 +00:00
func ( p * Provider ) hasCircuitBreakerLabel ( container dockerData ) bool {
2017-07-10 14:58:12 +00:00
if _ , err := getLabel ( container , types . LabelBackendCircuitbreakerExpression ) ; err != nil {
2016-08-25 04:22:06 +00:00
return false
}
return true
}
2017-03-08 14:10:21 +00:00
// Regexp used to extract the name of the service and the name of the property for this service
// All properties are under the format traefik.<servicename>.frontent.*= except the port/weight/protocol directly after traefik.<servicename>.
var servicesPropertiesRegexp = regexp . MustCompile ( ` ^traefik\.(?P<service_name>.*?)\.(?P<property_name>port|weight|protocol|frontend\.(.*))$ ` )
// Map of services properties
// we can get it with label[serviceName][propertyName] and we got the propertyValue
type labelServiceProperties map [ string ] map [ string ] string
// Check if for the given container, we find labels that are defining services
2017-04-15 13:49:53 +00:00
func ( p * Provider ) hasServices ( container dockerData ) bool {
2017-03-08 14:10:21 +00:00
return len ( extractServicesLabels ( container . Labels ) ) > 0
}
// Extract the service labels from container labels of dockerData struct
func extractServicesLabels ( labels map [ string ] string ) labelServiceProperties {
v := make ( labelServiceProperties )
for index , serviceProperty := range labels {
matches := servicesPropertiesRegexp . FindStringSubmatch ( index )
if matches != nil {
result := make ( map [ string ] string )
for i , name := range servicesPropertiesRegexp . SubexpNames ( ) {
if i != 0 {
result [ name ] = matches [ i ]
}
}
serviceName := result [ "service_name" ]
if _ , ok := v [ serviceName ] ; ! ok {
v [ serviceName ] = make ( map [ string ] string )
}
v [ serviceName ] [ result [ "property_name" ] ] = serviceProperty
}
}
return v
}
// Gets the entry for a service label searching in all labels of the given container
func getContainerServiceLabel ( container dockerData , serviceName string , entry string ) ( string , bool ) {
value , ok := extractServicesLabels ( container . Labels ) [ serviceName ] [ entry ]
return value , ok
}
// Gets array of service names for a given container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServiceNames ( container dockerData ) [ ] string {
2017-03-08 14:10:21 +00:00
labelServiceProperties := extractServicesLabels ( container . Labels )
keys := make ( [ ] string , 0 , len ( labelServiceProperties ) )
for k := range labelServiceProperties {
keys = append ( keys , k )
}
return keys
}
// Extract entrypoints from labels for a given service and a given docker container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServiceEntryPoints ( container dockerData , serviceName string ) [ ] string {
2017-03-08 14:10:21 +00:00
if entryPoints , ok := getContainerServiceLabel ( container , serviceName , "frontend.entryPoints" ) ; ok {
return strings . Split ( entryPoints , "," )
}
2017-04-15 13:49:53 +00:00
return p . getEntryPoints ( container )
2017-03-08 14:10:21 +00:00
}
2017-04-19 09:14:05 +00:00
// Extract basic auth from labels for a given service and a given docker container
func ( p * Provider ) getServiceBasicAuth ( container dockerData , serviceName string ) [ ] string {
if basicAuth , ok := getContainerServiceLabel ( container , serviceName , "frontend.auth.basic" ) ; ok {
return strings . Split ( basicAuth , "," )
}
return p . getBasicAuth ( container )
}
2017-03-08 14:10:21 +00:00
// Extract passHostHeader from labels for a given service and a given docker container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServicePassHostHeader ( container dockerData , serviceName string ) string {
2017-03-08 14:10:21 +00:00
if servicePassHostHeader , ok := getContainerServiceLabel ( container , serviceName , "frontend.passHostHeader" ) ; ok {
return servicePassHostHeader
}
2017-04-15 13:49:53 +00:00
return p . getPassHostHeader ( container )
2017-03-08 14:10:21 +00:00
}
// Extract priority from labels for a given service and a given docker container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServicePriority ( container dockerData , serviceName string ) string {
2017-03-08 14:10:21 +00:00
if value , ok := getContainerServiceLabel ( container , serviceName , "frontend.priority" ) ; ok {
return value
}
2017-04-15 13:49:53 +00:00
return p . getPriority ( container )
2017-03-08 14:10:21 +00:00
}
// Extract backend from labels for a given service and a given docker container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServiceBackend ( container dockerData , serviceName string ) string {
2017-03-08 14:10:21 +00:00
if value , ok := getContainerServiceLabel ( container , serviceName , "frontend.backend" ) ; ok {
return value
}
2017-04-15 13:49:53 +00:00
return p . getBackend ( container ) + "-" + provider . Normalize ( serviceName )
2017-03-08 14:10:21 +00:00
}
// Extract rule from labels for a given service and a given docker container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServiceFrontendRule ( container dockerData , serviceName string ) string {
2017-03-08 14:10:21 +00:00
if value , ok := getContainerServiceLabel ( container , serviceName , "frontend.rule" ) ; ok {
return value
}
2017-04-15 13:49:53 +00:00
return p . getFrontendRule ( container )
2017-03-08 14:10:21 +00:00
}
// Extract port from labels for a given service and a given docker container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServicePort ( container dockerData , serviceName string ) string {
2017-03-08 14:10:21 +00:00
if value , ok := getContainerServiceLabel ( container , serviceName , "port" ) ; ok {
return value
}
2017-04-15 13:49:53 +00:00
return p . getPort ( container )
2017-03-08 14:10:21 +00:00
}
// Extract weight from labels for a given service and a given docker container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServiceWeight ( container dockerData , serviceName string ) string {
2017-03-08 14:10:21 +00:00
if value , ok := getContainerServiceLabel ( container , serviceName , "weight" ) ; ok {
return value
}
2017-04-15 13:49:53 +00:00
return p . getWeight ( container )
2017-03-08 14:10:21 +00:00
}
// Extract protocol from labels for a given service and a given docker container
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getServiceProtocol ( container dockerData , serviceName string ) string {
2017-03-08 14:10:21 +00:00
if value , ok := getContainerServiceLabel ( container , serviceName , "protocol" ) ; ok {
return value
}
2017-04-15 13:49:53 +00:00
return p . getProtocol ( container )
2017-03-08 14:10:21 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) hasLoadBalancerLabel ( container dockerData ) bool {
2017-07-10 14:58:12 +00:00
_ , errMethod := getLabel ( container , types . LabelBackendLoadbalancerMethod )
_ , errSticky := getLabel ( container , types . LabelBackendLoadbalancerSticky )
2016-09-28 11:28:20 +00:00
if errMethod != nil && errSticky != nil {
2016-08-25 04:22:06 +00:00
return false
}
return true
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) hasMaxConnLabels ( container dockerData ) bool {
2017-07-10 14:58:12 +00:00
if _ , err := getLabel ( container , types . LabelBackendMaxconnAmount ) ; err != nil {
2016-08-25 04:22:06 +00:00
return false
}
2017-07-10 14:58:12 +00:00
if _ , err := getLabel ( container , types . LabelBackendMaxconnExtractorfunc ) ; err != nil {
2016-08-25 04:22:06 +00:00
return false
}
return true
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getCircuitBreakerExpression ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelBackendCircuitbreakerExpression ) ; err == nil {
2016-08-25 04:22:06 +00:00
return label
}
return "NetworkErrorRatio() > 1"
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getLoadBalancerMethod ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelBackendLoadbalancerMethod ) ; err == nil {
2016-08-25 04:22:06 +00:00
return label
}
return "wrr"
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getMaxConnAmount ( container dockerData ) int64 {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelBackendMaxconnAmount ) ; err == nil {
2016-08-25 04:22:06 +00:00
i , errConv := strconv . ParseInt ( label , 10 , 64 )
if errConv != nil {
log . Errorf ( "Unable to parse traefik.backend.maxconn.amount %s" , label )
return math . MaxInt64
}
return i
}
return math . MaxInt64
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getMaxConnExtractorFunc ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelBackendMaxconnExtractorfunc ) ; err == nil {
2016-08-25 04:22:06 +00:00
return label
}
return "request.host"
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) containerFilter ( container dockerData ) bool {
2017-07-10 14:58:12 +00:00
_ , err := strconv . Atoi ( container . Labels [ types . LabelPort ] )
2016-05-28 22:16:57 +00:00
if len ( container . NetworkSettings . Ports ) == 0 && err != nil {
log . Debugf ( "Filtering container without port and no traefik.port label %s" , container . Name )
2015-11-13 10:50:32 +00:00
return false
2015-09-07 08:38:58 +00:00
}
2015-11-13 10:50:32 +00:00
2017-04-15 13:49:53 +00:00
if ! isContainerEnabled ( container , p . ExposedByDefault ) {
2015-11-13 10:50:32 +00:00
log . Debugf ( "Filtering disabled container %s" , container . Name )
return false
}
2017-07-10 14:58:12 +00:00
constraintTags := strings . Split ( container . Labels [ types . LabelTags ] , "," )
2017-04-15 13:49:53 +00:00
if ok , failingConstraint := p . MatchConstraints ( constraintTags ) ; ! ok {
2016-06-06 19:59:58 +00:00
if failingConstraint != nil {
log . Debugf ( "Container %v pruned by '%v' constraint" , container . Name , failingConstraint . String ( ) )
}
return false
}
2016-10-03 09:01:37 +00:00
if container . Health != "" && container . Health != "healthy" {
log . Debugf ( "Filtering unhealthy or starting container %s" , container . Name )
return false
}
2017-04-07 14:30:57 +00:00
if len ( p . getFrontendRule ( container ) ) == 0 {
log . Debugf ( "Filtering container with empty frontend rule %s" , container . Name )
return false
}
2015-11-13 10:50:32 +00:00
return true
2015-09-09 14:49:51 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getFrontendName ( container dockerData ) string {
2015-10-23 07:49:19 +00:00
// Replace '.' with '-' in quoted keys because of this issue https://github.com/BurntSushi/toml/issues/78
2017-04-15 13:49:53 +00:00
return provider . Normalize ( p . getFrontendRule ( container ) )
2015-10-23 07:49:19 +00:00
}
2015-11-13 10:50:32 +00:00
// GetFrontendRule returns the frontend rule for the specified container, using
// it's label. It returns a default one (Host) if the label is not present.
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getFrontendRule ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelFrontendRule ) ; err == nil {
2015-11-13 10:50:32 +00:00
return label
}
2017-07-10 14:58:12 +00:00
if labels , err := getLabels ( container , [ ] string { labelDockerComposeProject , labelDockerComposeService } ) ; err == nil {
return "Host:" + p . getSubDomain ( labels [ labelDockerComposeService ] + "." + labels [ labelDockerComposeProject ] ) + "." + p . Domain
2017-05-03 21:24:53 +00:00
}
2017-04-07 14:30:57 +00:00
if len ( p . Domain ) > 0 {
return "Host:" + p . getSubDomain ( container . ServiceName ) + "." + p . Domain
2017-03-04 12:31:07 +00:00
}
2017-04-07 14:30:57 +00:00
return ""
2015-11-13 10:50:32 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getBackend ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelBackend ) ; err == nil {
2017-04-15 13:49:53 +00:00
return provider . Normalize ( label )
2015-11-13 10:50:32 +00:00
}
2017-07-10 14:58:12 +00:00
if labels , err := getLabels ( container , [ ] string { labelDockerComposeProject , labelDockerComposeService } ) ; err == nil {
return provider . Normalize ( labels [ labelDockerComposeService ] + "_" + labels [ labelDockerComposeProject ] )
2017-03-04 12:31:07 +00:00
}
2017-04-15 13:49:53 +00:00
return provider . Normalize ( container . ServiceName )
2015-11-13 10:50:32 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getIPAddress ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , labelDockerNetwork ) ; err == nil && label != "" {
2016-08-05 14:02:46 +00:00
networkSettings := container . NetworkSettings
if networkSettings . Networks != nil {
network := networkSettings . Networks [ label ]
2016-06-01 05:11:17 +00:00
if network != nil {
2016-08-05 14:02:46 +00:00
return network . Addr
2016-06-01 05:11:17 +00:00
}
2017-03-19 17:40:09 +00:00
log . Warnf ( "Could not find network named '%s' for container '%s'! Maybe you're missing the project's prefix in the label? Defaulting to first available network." , label , container . Name )
2016-06-01 05:11:17 +00:00
}
}
2016-07-05 09:44:30 +00:00
// If net==host, quick n' dirty, we return 127.0.0.1
// This will work locally, but will fail with swarm.
2016-08-05 14:02:46 +00:00
if "host" == container . NetworkSettings . NetworkMode {
2016-07-05 09:44:30 +00:00
return "127.0.0.1"
}
2017-04-15 13:49:53 +00:00
if p . UseBindPortIP {
port := p . getPort ( container )
2016-09-20 12:52:35 +00:00
for netport , portBindings := range container . NetworkSettings . Ports {
if string ( netport ) == port + "/TCP" || string ( netport ) == port + "/UDP" {
for _ , p := range portBindings {
return p . HostIP
}
}
}
}
2016-07-05 09:44:30 +00:00
for _ , network := range container . NetworkSettings . Networks {
2016-08-05 14:02:46 +00:00
return network . Addr
2016-06-01 05:11:17 +00:00
}
return ""
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getPort ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelPort ) ; err == nil {
2015-11-13 10:50:32 +00:00
return label
}
2017-04-28 08:05:54 +00:00
// See iteration order in https://blog.golang.org/go-maps-in-action
var ports [ ] nat . Port
for p := range container . NetworkSettings . Ports {
ports = append ( ports , p )
}
less := func ( i , j nat . Port ) bool {
return i . Int ( ) < j . Int ( )
2015-11-13 10:50:32 +00:00
}
2017-04-28 08:05:54 +00:00
nat . Sort ( ports , less )
if len ( ports ) > 0 {
min := ports [ 0 ]
return min . Port ( )
}
2015-11-13 10:50:32 +00:00
return ""
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getWeight ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelWeight ) ; err == nil {
2015-11-13 10:50:32 +00:00
return label
}
2016-11-23 13:49:55 +00:00
return "0"
2015-11-13 10:50:32 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getSticky ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelBackendLoadbalancerSticky ) ; err == nil {
2017-01-07 08:20:52 +00:00
return label
}
return "false"
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getIsBackendLBSwarm ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , labelBackendLoadbalancerSwarm ) ; err == nil {
2017-01-07 08:20:52 +00:00
return label
2016-06-02 18:36:14 +00:00
}
2016-06-08 19:08:03 +00:00
return "false"
2016-06-02 18:36:14 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getDomain ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelDomain ) ; err == nil {
2015-11-13 10:50:32 +00:00
return label
}
2017-04-15 13:49:53 +00:00
return p . Domain
2015-10-23 07:49:19 +00:00
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getProtocol ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if label , err := getLabel ( container , types . LabelProtocol ) ; err == nil {
2015-11-13 10:50:32 +00:00
return label
}
return "http"
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getPassHostHeader ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if passHostHeader , err := getLabel ( container , types . LabelFrontendPassHostHeader ) ; err == nil {
2015-11-13 10:50:32 +00:00
return passHostHeader
}
2016-05-10 11:43:24 +00:00
return "true"
2015-11-13 10:50:32 +00:00
}
2017-04-30 09:22:07 +00:00
func ( p * Provider ) getWhitelistSourceRange ( container dockerData ) [ ] string {
var whitelistSourceRange [ ] string
2017-07-10 14:58:12 +00:00
if whitelistSourceRangeLabel , err := getLabel ( container , types . LabelTraefikFrontendWhitelistSourceRange ) ; err == nil {
2017-04-30 09:22:07 +00:00
whitelistSourceRange = provider . SplitAndTrimString ( whitelistSourceRangeLabel )
}
return whitelistSourceRange
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getPriority ( container dockerData ) string {
2017-07-10 14:58:12 +00:00
if priority , err := getLabel ( container , types . LabelFrontendPriority ) ; err == nil {
2016-06-06 20:30:23 +00:00
return priority
}
return "0"
}
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getEntryPoints ( container dockerData ) [ ] string {
2017-07-10 14:58:12 +00:00
if entryPoints , err := getLabel ( container , types . LabelFrontendEntryPoints ) ; err == nil {
2016-02-01 15:08:58 +00:00
return strings . Split ( entryPoints , "," )
}
return [ ] string { }
}
2017-04-19 09:14:05 +00:00
func ( p * Provider ) getBasicAuth ( container dockerData ) [ ] string {
2017-07-10 14:58:12 +00:00
if basicAuth , err := getLabel ( container , types . LabelFrontendAuthBasic ) ; err == nil {
2017-04-19 09:14:05 +00:00
return strings . Split ( basicAuth , "," )
}
return [ ] string { }
}
2016-08-05 14:02:46 +00:00
func isContainerEnabled ( container dockerData , exposedByDefault bool ) bool {
2017-07-10 14:58:12 +00:00
return exposedByDefault && container . Labels [ types . LabelEnable ] != "false" || container . Labels [ types . LabelEnable ] == "true"
2016-07-14 09:32:15 +00:00
}
2016-08-05 14:02:46 +00:00
func getLabel ( container dockerData , label string ) ( string , error ) {
for key , value := range container . Labels {
2015-10-23 07:49:19 +00:00
if key == label {
return value , nil
2015-09-09 14:49:51 +00:00
}
}
2017-05-26 15:03:14 +00:00
return "" , fmt . Errorf ( "label not found: %s" , label )
2015-10-23 07:49:19 +00:00
}
2016-08-05 14:02:46 +00:00
func getLabels ( container dockerData , labels [ ] string ) ( map [ string ] string , error ) {
2015-11-05 14:14:25 +00:00
var globalErr error
2015-10-26 23:26:35 +00:00
foundLabels := map [ string ] string { }
for _ , label := range labels {
2015-11-13 10:50:32 +00:00
foundLabel , err := getLabel ( container , label )
2015-11-05 14:14:25 +00:00
// Error out only if one of them is defined.
2015-11-01 18:29:47 +00:00
if err != nil {
2017-05-26 15:03:14 +00:00
globalErr = fmt . Errorf ( "label not found: %s" , label )
2015-11-05 14:14:25 +00:00
continue
2015-10-26 23:26:35 +00:00
}
2015-11-01 18:29:47 +00:00
foundLabels [ label ] = foundLabel
2015-11-05 14:14:25 +00:00
2015-10-26 23:26:35 +00:00
}
2015-11-05 14:14:25 +00:00
return foundLabels , globalErr
2015-10-26 23:26:35 +00:00
}
2016-08-05 14:02:46 +00:00
func listContainers ( ctx context . Context , dockerClient client . ContainerAPIClient ) ( [ ] dockerData , error ) {
2016-06-08 17:39:38 +00:00
containerList , err := dockerClient . ContainerList ( ctx , dockertypes . ContainerListOptions { } )
2016-04-08 12:20:54 +00:00
if err != nil {
2016-08-05 14:02:46 +00:00
return [ ] dockerData { } , err
2016-04-08 12:20:54 +00:00
}
2016-08-05 14:02:46 +00:00
containersInspected := [ ] dockerData { }
2015-10-23 07:49:19 +00:00
2015-11-13 10:50:32 +00:00
// get inspect containers
for _ , container := range containerList {
2016-06-08 17:39:38 +00:00
containerInspected , err := dockerClient . ContainerInspect ( ctx , container . ID )
2016-04-08 12:20:54 +00:00
if err != nil {
2016-06-20 10:15:31 +00:00
log . Warnf ( "Failed to inspect container %s, error: %s" , container . ID , err )
2016-06-08 17:39:38 +00:00
} else {
2016-08-05 14:02:46 +00:00
dockerData := parseContainer ( containerInspected )
containersInspected = append ( containersInspected , dockerData )
2016-04-08 12:20:54 +00:00
}
2015-10-23 07:49:19 +00:00
}
2016-04-08 12:20:54 +00:00
return containersInspected , nil
2015-09-12 13:10:03 +00:00
}
2016-05-31 21:23:23 +00:00
2016-08-05 14:02:46 +00:00
func parseContainer ( container dockertypes . ContainerJSON ) dockerData {
dockerData := dockerData {
NetworkSettings : networkSettings { } ,
}
if container . ContainerJSONBase != nil {
dockerData . Name = container . ContainerJSONBase . Name
2017-02-03 01:18:12 +00:00
dockerData . ServiceName = dockerData . Name //Default ServiceName to be the container's Name.
2016-08-05 14:02:46 +00:00
if container . ContainerJSONBase . HostConfig != nil {
dockerData . NetworkSettings . NetworkMode = container . ContainerJSONBase . HostConfig . NetworkMode
}
2016-11-28 15:46:37 +00:00
if container . State != nil && container . State . Health != nil {
dockerData . Health = container . State . Health . Status
}
2016-08-05 14:02:46 +00:00
}
if container . Config != nil && container . Config . Labels != nil {
dockerData . Labels = container . Config . Labels
}
if container . NetworkSettings != nil {
if container . NetworkSettings . Ports != nil {
dockerData . NetworkSettings . Ports = container . NetworkSettings . Ports
}
if container . NetworkSettings . Networks != nil {
dockerData . NetworkSettings . Networks = make ( map [ string ] * networkData )
for name , containerNetwork := range container . NetworkSettings . Networks {
dockerData . NetworkSettings . Networks [ name ] = & networkData {
ID : containerNetwork . NetworkID ,
Name : name ,
Addr : containerNetwork . IPAddress ,
}
}
}
}
return dockerData
}
2017-01-24 10:29:45 +00:00
// Escape beginning slash "/", convert all others to dash "-", and convert underscores "_" to dash "-"
2017-04-15 13:49:53 +00:00
func ( p * Provider ) getSubDomain ( name string ) string {
2017-01-24 10:29:45 +00:00
return strings . Replace ( strings . Replace ( strings . TrimPrefix ( name , "/" ) , "/" , "-" , - 1 ) , "_" , "-" , - 1 )
2016-05-31 21:23:23 +00:00
}
2016-08-05 14:02:46 +00:00
2017-04-15 13:49:53 +00:00
func ( p * Provider ) listServices ( ctx context . Context , dockerClient client . APIClient ) ( [ ] dockerData , error ) {
2016-08-05 14:02:46 +00:00
serviceList , err := dockerClient . ServiceList ( ctx , dockertypes . ServiceListOptions { } )
if err != nil {
return [ ] dockerData { } , err
}
networkListArgs := filters . NewArgs ( )
networkListArgs . Add ( "driver" , "overlay" )
networkList , err := dockerClient . NetworkList ( ctx , dockertypes . NetworkListOptions { Filters : networkListArgs } )
networkMap := make ( map [ string ] * dockertypes . NetworkResource )
if err != nil {
log . Debug ( "Failed to network inspect on client for docker, error: %s" , err )
return [ ] dockerData { } , err
}
for _ , network := range networkList {
2016-10-07 14:35:27 +00:00
networkToAdd := network
networkMap [ network . ID ] = & networkToAdd
2016-08-05 14:02:46 +00:00
}
var dockerDataList [ ] dockerData
2017-01-07 08:20:52 +00:00
var dockerDataListTasks [ ] dockerData
2016-08-05 14:02:46 +00:00
for _ , service := range serviceList {
dockerData := parseService ( service , networkMap )
2017-04-15 13:49:53 +00:00
useSwarmLB , _ := strconv . ParseBool ( p . getIsBackendLBSwarm ( dockerData ) )
2017-02-16 16:50:41 +00:00
isGlobalSvc := service . Spec . Mode . Global != nil
2016-08-05 14:02:46 +00:00
2017-01-07 08:20:52 +00:00
if useSwarmLB {
dockerDataList = append ( dockerDataList , dockerData )
} else {
2017-02-16 16:50:41 +00:00
dockerDataListTasks , err = listTasks ( ctx , dockerClient , service . ID , dockerData , networkMap , isGlobalSvc )
2017-01-07 08:20:52 +00:00
for _ , dockerDataTask := range dockerDataListTasks {
dockerDataList = append ( dockerDataList , dockerDataTask )
}
}
2016-08-05 14:02:46 +00:00
}
return dockerDataList , err
}
func parseService ( service swarmtypes . Service , networkMap map [ string ] * dockertypes . NetworkResource ) dockerData {
dockerData := dockerData {
2017-02-03 01:18:12 +00:00
ServiceName : service . Spec . Annotations . Name ,
2016-08-05 14:02:46 +00:00
Name : service . Spec . Annotations . Name ,
Labels : service . Spec . Annotations . Labels ,
NetworkSettings : networkSettings { } ,
}
if service . Spec . EndpointSpec != nil {
switch service . Spec . EndpointSpec . Mode {
2017-07-06 14:28:13 +00:00
case swarmtypes . ResolutionModeDNSRR :
2016-08-05 14:02:46 +00:00
log . Debug ( "Ignored endpoint-mode not supported, service name: %s" , dockerData . Name )
2017-07-06 14:28:13 +00:00
case swarmtypes . ResolutionModeVIP :
2016-08-05 14:02:46 +00:00
dockerData . NetworkSettings . Networks = make ( map [ string ] * networkData )
for _ , virtualIP := range service . Endpoint . VirtualIPs {
networkService := networkMap [ virtualIP . NetworkID ]
if networkService != nil {
ip , _ , _ := net . ParseCIDR ( virtualIP . Addr )
network := & networkData {
Name : networkService . Name ,
ID : virtualIP . NetworkID ,
Addr : ip . String ( ) ,
}
dockerData . NetworkSettings . Networks [ network . Name ] = network
} else {
log . Debug ( "Network not found, id: %s" , virtualIP . NetworkID )
}
2017-01-07 08:20:52 +00:00
}
}
}
return dockerData
}
func listTasks ( ctx context . Context , dockerClient client . APIClient , serviceID string ,
2017-02-16 16:50:41 +00:00
serviceDockerData dockerData , networkMap map [ string ] * dockertypes . NetworkResource , isGlobalSvc bool ) ( [ ] dockerData , error ) {
2017-01-07 08:20:52 +00:00
serviceIDFilter := filters . NewArgs ( )
serviceIDFilter . Add ( "service" , serviceID )
2017-02-16 16:50:41 +00:00
serviceIDFilter . Add ( "desired-state" , "running" )
2017-07-06 14:28:13 +00:00
taskList , err := dockerClient . TaskList ( ctx , dockertypes . TaskListOptions { Filters : serviceIDFilter } )
2017-01-07 08:20:52 +00:00
if err != nil {
return [ ] dockerData { } , err
}
var dockerDataList [ ] dockerData
for _ , task := range taskList {
2017-07-06 14:28:13 +00:00
if task . Status . State != swarmtypes . TaskStateRunning {
2017-03-16 14:38:40 +00:00
continue
}
2017-02-16 16:50:41 +00:00
dockerData := parseTasks ( task , serviceDockerData , networkMap , isGlobalSvc )
2017-01-07 08:20:52 +00:00
dockerDataList = append ( dockerDataList , dockerData )
}
return dockerDataList , err
}
2016-08-05 14:02:46 +00:00
2017-02-16 16:50:41 +00:00
func parseTasks ( task swarmtypes . Task , serviceDockerData dockerData , networkMap map [ string ] * dockertypes . NetworkResource , isGlobalSvc bool ) dockerData {
2017-01-07 08:20:52 +00:00
dockerData := dockerData {
2017-02-03 01:18:12 +00:00
ServiceName : serviceDockerData . Name ,
2017-01-07 08:20:52 +00:00
Name : serviceDockerData . Name + "." + strconv . Itoa ( task . Slot ) ,
Labels : serviceDockerData . Labels ,
NetworkSettings : networkSettings { } ,
}
2017-08-18 00:18:02 +00:00
if isGlobalSvc {
2017-02-16 16:50:41 +00:00
dockerData . Name = serviceDockerData . Name + "." + task . ID
}
2017-01-07 08:20:52 +00:00
if task . NetworksAttachments != nil {
dockerData . NetworkSettings . Networks = make ( map [ string ] * networkData )
for _ , virtualIP := range task . NetworksAttachments {
if networkService , present := networkMap [ virtualIP . Network . ID ] ; present {
// Not sure about this next loop - when would a task have multiple IP's for the same network?
for _ , addr := range virtualIP . Addresses {
ip , _ , _ := net . ParseCIDR ( addr )
network := & networkData {
ID : virtualIP . Network . ID ,
Name : networkService . Name ,
Addr : ip . String ( ) ,
}
dockerData . NetworkSettings . Networks [ network . Name ] = network
}
2016-08-05 14:02:46 +00:00
}
}
}
return dockerData
}