docs/content/reference/install-configuration/providers/overview.md
Providers are infrastructure components, whether orchestrators, container engines, cloud providers, or key-value stores. The idea is that Traefik queries the provider APIs in order to find relevant information about routing, and when Traefik detects a change, it dynamically updates the routes.
While each provider is different, you can think of each as belonging to one of four categories:
When you declare certain objects in the Traefik dynamic configuration, such as middleware, services, TLS options or server transports, they reside in their provider's namespace. For example, if you declare a middleware using a Docker label, it resides in the Docker provider namespace.
If you use multiple providers and wish to reference such an object declared in another provider
(e.g. referencing a cross-provider object like middleware), then the object name should be suffixed by the @
separator, and the provider name.
For the list of the providers names, see the supported providers table below.
<resource-name>@<provider-name>
!!! important "Kubernetes Namespace vs Traefik Namespace"
As Kubernetes also has its own notion of namespace,
one should not confuse the _provider namespace_ with the _Kubernetes Namespace_ of a resource when in the context of cross-provider usage.
In this case, since the definition of a Traefik dynamic configuration object is not in Kubernetes,
specifying a Kubernetes Namespace when referring to the resource does not make any sense.
On the other hand, if you were to declare a middleware as a Custom Resource in Kubernetes and use the non-CRD Ingress objects,
you would have to add the Kubernetes Namespace of the middleware to the annotation like this `<middleware-namespace>-<middleware-name>@kubernetescrd`.
Below is the list of the currently supported providers in Traefik.
| Provider | Type | Configuration Type | Provider Name |
|---|---|---|---|
| <a id="opt-Docker" href="#opt-Docker" title="#opt-Docker">Docker</a> | Orchestrator | Label | docker |
| <a id="opt-Docker-Swarm" href="#opt-Docker-Swarm" title="#opt-Docker-Swarm">Docker Swarm</a> | Orchestrator | Label | swarm |
| <a id="opt-Kubernetes-IngressRoute" href="#opt-Kubernetes-IngressRoute" title="#opt-Kubernetes-IngressRoute">Kubernetes IngressRoute</a> | Orchestrator | Custom Resource | kubernetescrd |
| <a id="opt-Kubernetes-Ingress" href="#opt-Kubernetes-Ingress" title="#opt-Kubernetes-Ingress">Kubernetes Ingress</a> | Orchestrator | Ingress | kubernetes |
| <a id="opt-Kubernetes-Gateway-API" href="#opt-Kubernetes-Gateway-API" title="#opt-Kubernetes-Gateway-API">Kubernetes Gateway API</a> | Orchestrator | Gateway API Resource | kubernetesgateway |
| <a id="opt-Consul-Catalog" href="#opt-Consul-Catalog" title="#opt-Consul-Catalog">Consul Catalog</a> | Orchestrator | Label | consulcatalog |
| <a id="opt-Nomad" href="#opt-Nomad" title="#opt-Nomad">Nomad</a> | Orchestrator | Label | nomad |
| <a id="opt-ECS" href="#opt-ECS" title="#opt-ECS">ECS</a> | Orchestrator | Label | ecs |
| <a id="opt-File" href="#opt-File" title="#opt-File">File</a> | Manual | YAML/TOML format | file |
| <a id="opt-Consul" href="#opt-Consul" title="#opt-Consul">Consul</a> | KV | KV | consul |
| <a id="opt-Etcd" href="#opt-Etcd" title="#opt-Etcd">Etcd</a> | KV | KV | etcd |
| <a id="opt-ZooKeeper" href="#opt-ZooKeeper" title="#opt-ZooKeeper">ZooKeeper</a> | KV | KV | zookeeper |
| <a id="opt-Redis" href="#opt-Redis" title="#opt-Redis">Redis</a> | KV | KV | redis |
| <a id="opt-HTTP" href="#opt-HTTP" title="#opt-HTTP">HTTP</a> | Manual | JSON/YAML format | http |
!!! info "More Providers"
The current version of Traefik does not yet support every provider that Traefik v2.11 did.
See the [previous version (v2.11)](https://doc.traefik.io/traefik/v2.11/) for more information.
Declaring the add-foo-prefix in the file provider.
http:
middlewares:
add-foo-prefix:
addPrefix:
prefix: "/foo"
[http.middlewares]
[http.middlewares.add-foo-prefix.addPrefix]
prefix = "/foo"
Using the add-foo-prefix middleware from other providers:
your-container:
image: your-docker-image
labels:
# Attach add-foo-prefix@file middleware (declared in file)
- "traefik.http.routers.my-container.middlewares=add-foo-prefix@file"
apiVersion: traefik.io/v1alpha1
kind: IngressRoute
metadata:
name: ingressroutestripprefix
spec:
entryPoints:
- web
routes:
- match: Host(`example.com`)
kind: Rule
services:
- name: whoami
port: 80
middlewares:
- name: add-foo-prefix@file
# namespace: bar
# A namespace specification such as above is ignored
# when the cross-provider syntax is used.
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: ingress
namespace: appspace
annotations:
"traefik.ingress.kubernetes.io/router.middlewares": add-foo-prefix@file
spec:
By default, Traefik creates routes for all detected containers.
If you want to limit the scope of the Traefik service discovery, i.e. disallow route creation for some containers, you can do so in two different ways:
With Consul Catalog,
Docker,
ECS,
Nomad and
Swarm
providers, you can set exposedByDefault to false and add a label traefik.enable=true
on containers you want to expose
Use a finer-grained mechanism based on label selector or constraints.
!!! info "The following providers support constraints"
- [Consul Catalog](./hashicorp/consul-catalog.md#constraints)
- [Docker](./docker.md#constraints)
- [ECS](./others/ecs.md#constraints)
- [Nomad](./hashicorp/nomad.md#constraints)
- [Swarm](./swarm.md#constraints)
!!! info "The following providers support label selectors"
- [Kubernetes CRD](./kubernetes/kubernetes-crd.md#opt-providers-kubernetesCRD-labelselector)
- [Kubernetes Gateway API](./kubernetes/kubernetes-gateway.md#opt-providers-kubernetesGateway-labelselector)
- [Kubernetes Ingress](./kubernetes/kubernetes-ingress.md#opt-providers-kubernetesIngress-labelselector)
providers.precedenceOptional
When two routers from different providers define the same rule with equal numeric priority,
the precedence option determines which provider's route takes precedence.
The list is ordered from highest to lowest precedence: a provider listed first wins over providers listed later.
providers:
precedence:
- kubernetescrd
- kubernetes
- file
[providers]
precedence = ["kubernetescrd", "kubernetes", "file"]
--providers.precedence=kubernetescrd,kubernetes,file
When precedence is not set, Traefik uses the following default order (highest precedence first):
| Position | Provider name |
|---|---|
| <a id="opt-1" href="#opt-1" title="#opt-1">1</a> | kubernetesgateway |
| <a id="opt-2" href="#opt-2" title="#opt-2">2</a> | kubernetescrd |
| <a id="opt-3" href="#opt-3" title="#opt-3">3</a> | kubernetes |
| <a id="opt-4" href="#opt-4" title="#opt-4">4</a> | kubernetesingressnginx |
| <a id="opt-5" href="#opt-5" title="#opt-5">5</a> | swarm |
| <a id="opt-6" href="#opt-6" title="#opt-6">6</a> | docker |
| <a id="opt-7" href="#opt-7" title="#opt-7">7</a> | file |
| <a id="opt-8" href="#opt-8" title="#opt-8">8</a> | redis |
| <a id="opt-9" href="#opt-9" title="#opt-9">9</a> | knative |
| <a id="opt-10" href="#opt-10" title="#opt-10">10</a> | consul |
| <a id="opt-11" href="#opt-11" title="#opt-11">11</a> | consulcatalog |
| <a id="opt-12" href="#opt-12" title="#opt-12">12</a> | nomad |
| <a id="opt-13" href="#opt-13" title="#opt-13">13</a> | etcd |
| <a id="opt-14" href="#opt-14" title="#opt-14">14</a> | ecs |
| <a id="opt-15" href="#opt-15" title="#opt-15">15</a> | http |
| <a id="opt-16" href="#opt-16" title="#opt-16">16</a> | zookeeper |
| <a id="opt-17" href="#opt-17" title="#opt-17">17</a> | rest |
!!! note
- `precedence` only acts as a **tiebreaker**: it is applied only when two routes from different providers share the same numeric `priority` value. An explicit router priority always takes precedence.
- A provider absent from `precedence` loses to any listed provider.
- Provider names are case-insensitive.
{% include-markdown "includes/traefik-for-business-applications.md" %}