docker

Documentation

Index

• Constants
• type Provider
  • func (p *Provider) Init() error
  • func (p *Provider) Provide(configurationChan chan<- config.Message, pool *safe.Pool) error

Constants

const (
	// SwarmAPIVersion is a constant holding the version of the Provider API traefik will use.
	SwarmAPIVersion = "1.24"
	// DefaultTemplateRule The default template for the default rule.
	DefaultTemplateRule = "Host(`{{ normalize .Name }}`)"
)

const (
	// DockerAPIVersion is a constant holding the version of the Provider API traefik will use
	DockerAPIVersion = "1.21"
)

Types

type Provider

type Provider struct {
	provider.Constrainer    `mapstructure:",squash" export:"true"`
	Watch                   bool             `description:"Watch provider" export:"true"`
	Endpoint                string           `description:"Docker server endpoint. Can be a tcp or a unix socket endpoint"`
	DefaultRule             string           `description:"Default rule"`
	TLS                     *types.ClientTLS `description:"Enable Docker TLS support" export:"true"`
	ExposedByDefault        bool             `description:"Expose containers by default" export:"true"`
	UseBindPortIP           bool             `description:"Use the ip address from the bound port, rather than from the inner network" export:"true"`
	SwarmMode               bool             `description:"Use Docker on Swarm Mode" export:"true"`
	Network                 string           `description:"Default Docker network used" export:"true"`
	SwarmModeRefreshSeconds int              `description:"Polling interval for swarm mode (in seconds)" export:"true"`
	// contains filtered or unexported fields
}

Provider holds configurations of the provider.

func (*Provider) Init

func (p *Provider) Init() error

Init the provider.

func (*Provider) Provide

func (p *Provider) Provide(configurationChan chan<- config.Message, pool *safe.Pool) error

Provide allows the docker provider to provide configurations to traefik using the given configuration channel.