traefik

command module
v2.0.0-beta1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 19, 2019 License: MIT Imports: 0 Imported by: 0

README

Traefik

Build Status SemaphoreCI Docs Go Report Card License Twitter

Traefik (pronounced traffic) is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy. Traefik integrates with your existing infrastructure components (Docker, Swarm mode, Kubernetes, Marathon, Consul, Etcd, Rancher, Amazon ECS, ...) and configures itself automatically and dynamically. Pointing Traefik at your orchestrator should be the only configuration step you need.


. Overview . Features . Supported backends . Quickstart . Web UI . Documentation .

. Support . Release cycle . Contributing . Maintainers . Credits .


⚠ Please be aware that the old configurations for Traefik v1.X are NOT compatible with the v2.X config as of now. If you're testing out v2, please ensure you are using a v2 configuration.

Overview

Imagine that you have deployed a bunch of microservices with the help of an orchestrator (like Swarm or Kubernetes) or a service registry (like etcd or consul). Now you want users to access these microservices, and you need a reverse proxy.

Traditional reverse-proxies require that you configure each route that will connect paths and subdomains to each microservice. In an environment where you add, remove, kill, upgrade, or scale your services many times a day, the task of keeping the routes up to date becomes tedious.

This is when Traefik can help you!

Traefik listens to your service registry/orchestrator API and instantly generates the routes so your microservices are connected to the outside world -- without further intervention from your part.

Run Traefik and let it do the work for you! (But if you'd rather configure some of your routes manually, Traefik supports that too!)

Architecture

Features

  • Continuously updates its configuration (No restarts!)
  • Supports multiple load balancing algorithms
  • Provides HTTPS to your microservices by leveraging Let's Encrypt (wildcard certificates support)
  • Circuit breakers, retry
  • See the magic through its clean web UI
  • Websocket, HTTP/2, GRPC ready
  • Provides metrics (Rest, Prometheus, Datadog, Statsd, InfluxDB)
  • Keeps access logs (JSON, CLF)
  • Fast
  • Exposes a Rest API
  • Packaged as a single binary file (made with ❤ with go) and available as a tiny official docker image

Supported Backends

Quickstart

To get your hands on Traefik, you can use the 5-Minute Quickstart in our documentation (you will need Docker).

Web UI

You can access the simple HTML frontend of Traefik.

Web UI Providers Web UI Health

Documentation

You can find the complete documentation at https://docs.traefik.io. A collection of contributions around Traefik can be found at https://awesome.traefik.io.

⚠ If you're testing out v2, please ensure you are using the v2 documentation.

Support

To get community support, you can:

  • join the Traefik community forum:

If you need commercial support, please contact Containo.us by mail: mailto:support@containo.us.

Download

./traefik --configFile=traefik.toml
docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/etc/traefik/traefik.toml traefik
  • Or get the sources:
git clone https://github.com/containous/traefik

Introductory Videos

⚠ Please be aware that these videos are for v1.X. The old configurations for Traefik v1.X are NOT compatible with Traefik v2. If you're testing out v2, please ensure you are using a v2 configuration.

Here is a talk given by Emile Vauge at GopherCon 2017. You will learn Traefik basics in less than 10 minutes.

Traefik GopherCon 2017

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

Traefik ContainerCamp UK

Maintainers

Information about process and maintainers

Contributing

If you'd like to contribute to the project, refer to the contributing documentation.

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.

Release Cycle

  • We release a new version (e.g. 1.1.0, 1.2.0, 1.3.0) every other month.
  • Release Candidates are available before the release (e.g. 1.1.0-rc1, 1.1.0-rc2, 1.1.0-rc3, 1.1.0-rc4, before 1.1.0)
  • Bug-fixes (e.g. 1.1.1, 1.1.2, 1.2.1, 1.2.3) are released as needed (no additional features are delivered in those versions, bug-fixes only)

Each version is supported until the next one is released (e.g. 1.1.x will be supported until 1.2.0 is out)

We use Semantic Versioning

Mailing lists

Credits

Kudos to Peka for his awesome work on the logo logo.

Traefik's logo is 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/).

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
helloworld
Package helloworld is a generated protocol buffer package.
Package helloworld is a generated protocol buffer package.
try
pkg
api
cli
Package cli provides tools to create commands that support advanced configuration features, sub-commands, and allowing configuration from command-line flags, configuration files, and environment variables.
Package cli provides tools to create commands that support advanced configuration features, sub-commands, and allowing configuration from command-line flags, configuration files, and environment variables.
config/env
Package env implements encoding and decoding between environment variable and a typed Configuration.
Package env implements encoding and decoding between environment variable and a typed Configuration.
config/file
Package file implements decoding between configuration in a file and a typed Configuration.
Package file implements decoding between configuration in a file and a typed Configuration.
config/flag
Package flag implements encoding and decoding between flag arguments and a typed Configuration.
Package flag implements encoding and decoding between flag arguments and a typed Configuration.
config/generator
Package generator implements the custom initialization of all the fields of an empty interface.
Package generator implements the custom initialization of all the fields of an empty interface.
config/label
Package label implements the decoding and encoding between flat labels and a typed Configuration.
Package label implements the decoding and encoding between flat labels and a typed Configuration.
config/parser
Package parser implements decoding and encoding between a flat map of labels and a typed Configuration.
Package parser implements decoding and encoding between a flat map of labels and a typed Configuration.
ip
job
log
middlewares/headers
Package headers Middleware based on https://github.com/unrolled/secure.
Package headers Middleware based on https://github.com/unrolled/secure.
provider/kubernetes/crd/generated/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
provider/kubernetes/crd/generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
provider/kubernetes/crd/generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
provider/kubernetes/crd/generated/clientset/versioned/typed/traefik/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
provider/kubernetes/crd/generated/clientset/versioned/typed/traefik/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
provider/kubernetes/crd/traefik/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
Package v1alpha1 is the v1alpha1 version of the API.
provider/marathon/mocks
Package mocks Code generated by mockery v1.0.0.
Package mocks Code generated by mockery v1.0.0.
tcp
tls

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL