No description
Find a file
bitsofinfo 70ab34cfb8 doc change regarding consul SSL
document change to clarify consul ssl, vs consul ssl client certificate security
2017-07-18 17:22:08 +02:00
.github chore: GitHub Code Owners. 2017-07-10 17:45:58 +02:00
.semaphoreci Merge branch 'v1.3' 2017-06-27 23:27:00 +02:00
acme Merge branch 'v1.3' 2017-06-27 14:42:12 +02:00
autogen Merge pull request #1464 from vdemeester/vendor-autogen 2017-05-03 10:02:14 +02:00
cluster drop "slave" wording for "worker" 2017-06-12 20:07:39 +02:00
cmd/traefik Handle RootCAs Certificate 2017-06-30 14:56:55 +02:00
contrib Address review comments. 2017-06-24 12:32:05 +02:00
docs doc change regarding consul SSL 2017-07-18 17:22:08 +02:00
examples traefik controller access to secrets 2017-07-07 22:35:03 +02:00
healthcheck test: HealthCheck review. 2017-06-09 23:55:49 +02:00
integration Factorize labels 2017-07-10 16:58:12 +02:00
job Import order as goimports does 2016-12-30 19:04:02 +01:00
log feat(logger): Expose Logrus writer. 2017-07-08 00:05:53 +02:00
middlewares Enhance integration tests 2017-07-10 14:58:31 +02:00
provider [marathon] Use single API call to fetch Marathon resources. 2017-07-11 14:35:01 +02:00
safe Add unit tests for package safe 2017-05-01 16:21:26 +02:00
script Update traefik dependencies (docker/docker and related) (#1823) 2017-07-06 16:28:13 +02:00
server extract lb configuration steps into method 2017-07-10 19:18:31 +02:00
templates [marathon] Use single API call to fetch Marathon resources. 2017-07-11 14:35:01 +02:00
testhelpers test: HealthCheck review. 2017-06-09 23:55:49 +02:00
types Factorize labels 2017-07-10 16:58:12 +02:00
vendor Update traefik dependencies (docker/docker and related) (#1823) 2017-07-06 16:28:13 +02:00
version Merge v1.2.1-master 2017-04-11 22:36:56 +02:00
webui Merge tag 'v1.3.1' 2017-06-16 16:52:53 +02:00
.dockerignore Re-exclude /dist/traefik from .dockerignore. 2017-04-26 10:01:43 +02:00
.gitignore Make the ACME developements testing easier 2017-07-07 11:36:32 +02:00
.pre-commit-config.yaml add errcheck validation 2016-03-23 16:39:09 +01:00
.travis.yml always rebuild webui on 'make image' 2017-07-07 17:56:48 +02:00
build.Dockerfile Update traefik dependencies (docker/docker and related) (#1823) 2017-07-06 16:28:13 +02:00
CHANGELOG.md Prepare release v1.3.3 2017-07-06 17:53:35 +02:00
CODE_OF_CONDUCT.md Adopt the Code Of Coduct from http://contributor-covenant.org 2016-08-26 10:26:41 +01:00
Dockerfile Adding expose for default port 2015-12-03 17:15:01 +01:00
generate.go Move version.go in its own package… 2016-07-21 16:33:49 +02:00
glide.lock chore(glide): change nergoni git url. 2017-07-12 10:22:39 +02:00
glide.yaml chore(glide): change nergoni git url. 2017-07-12 10:22:39 +02:00
LICENSE.md License 2017, Træfɪk => Træfik 2017-04-24 15:12:44 +02:00
Makefile always rebuild webui on 'make image' 2017-07-07 17:56:48 +02:00
mkdocs.yml Add Marathon guide 2017-05-17 14:59:28 +02:00
README.md Update README.md 2017-07-07 14:34:25 +02:00
requirements.txt Fix docs build and add missing benchmarks page (#1017) 2017-01-09 15:12:11 +01:00
traefik.sample.toml Add whitelist configuration option for entrypoints 2017-07-08 12:21:14 +02:00

Træfik

Build Status SemaphoreCI Docs Go Report Card License Join the chat at https://traefik.herokuapp.com Twitter

Træfik (pronounced like traffic) is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. It supports several backends (Docker, Swarm, Kubernetes, Marathon, Mesos, Consul, Etcd, Zookeeper, BoltDB, Eureka, Amazon DynamoDB, Rest API, file...) to manage its configuration automatically and dynamically.

Overview

Imagine that you have deployed a bunch of microservices on your infrastructure. You probably used a service registry (like etcd or consul) and/or an orchestrator (swarm, Mesos/Marathon) to manage all these services. If you want your users to access some of your microservices from the Internet, you will have to use a reverse proxy and configure it using virtual hosts or prefix paths:

  • domain api.domain.com will point the microservice api in your private network
  • path domain.com/web will point the microservice web in your private network
  • domain backoffice.domain.com will point the microservices backoffice in your private network, load-balancing between your multiple instances

But a microservices architecture is dynamic... Services are added, removed, killed or upgraded often, eventually several times a day.

Traditional reverse-proxies are not natively dynamic. You can't change their configuration and hot-reload easily.

Here enters Træfik.

Architecture

Træfik can listen to your service registry/orchestrator API, and knows each time a microservice is added, removed, killed or upgraded, and can generate its configuration automatically. Routes to your services will be created instantly.

Run it and forget it!

Features

  • It's fast
  • No dependency hell, single binary made with go
  • Rest API
  • Multiple backends supported: Docker, Swarm, Kubernetes, Marathon, Mesos, Consul, Etcd, and more to come
  • Watchers for backends, can listen for changes in backends to apply a new configuration automatically
  • Hot-reloading of configuration. No need to restart the process
  • Graceful shutdown http connections
  • Circuit breakers on backends
  • Round Robin, rebalancer load-balancers
  • Rest Metrics
  • Tiny official docker image included
  • SSL backends support
  • SSL frontend support (with SNI)
  • Clean AngularJS Web UI
  • Websocket support
  • HTTP/2 support
  • Retry request if network error
  • Let's Encrypt support (Automatic HTTPS with renewal)
  • High Availability with cluster mode

Quickstart

You can have a quick look at Træfik in this Katacoda tutorial that shows how to load balance requests between multiple Docker containers. If you are looking for a more comprehensive and real use-case example, you can also check Play-With-Docker to see how to load balance between multiple nodes.

Here is a talk given by Ed Robinson at the ContainerCamp UK conference. You will learn fundamental Træfik features and see some demos with Kubernetes.

Traefik ContainerCamp UK

Here is a talk (in French) given by Emile Vauge at the Devoxx France 2016 conference. You will learn fundamental Træfik features and see some demos with Docker, Mesos/Marathon and Let's Encrypt.

Traefik Devoxx France

Web UI

You can access the simple HTML frontend of Træfik.

Web UI Providers Web UI Health

Plumbing

Test it

./traefik --configFile=traefik.toml
  • Use the tiny Docker image:
docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/etc/traefik/traefik.toml traefik
  • From sources:
git clone https://github.com/containous/traefik

Documentation

You can find the complete documentation here.

Contributing

Please refer to this section.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Support

You can join Join the chat at https://traefik.herokuapp.com to get basic support. If you prefer commercial support, please contact containo.us by mail: mailto:support@containo.us.

Release cycle

  • Release: We try to release a new version every 2 months
    • i.e.: 1.3.0, 1.4.0, 1.5.0
  • Release candidate: we do RC (1.x.0-rcy) before the final release (1.x.0)
    • i.e.: 1.1.0-rc1 -> 1.1.0-rc2 -> 1.1.0-rc3 -> 1.1.0-rc4 -> 1.1.0
  • Bug-fixes: For each version we release bug fixes
    • i.e.: 1.1.1, 1.1.2, 1.1.3
    • those versions contain only bug-fixes
    • no additional features are delivered in those versions
  • Each version is supported until the next one is released
    • i.e.: 1.1.x will be supported until 1.2.0 is out
  • We use Semantic Versioning

Maintainers

Credits

Kudos to Peka for his awesome work on the logo logo. Traefik's logo licensed under the Creative Commons 3.0 Attributions license.

Traefik's logo was inspired by the gopher stickers made by Takuya Ueda (https://twitter.com/tenntenn). The original Go gopher was designed by Renee French (http://reneefrench.blogspot.com/).