Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/colinwilson/terraform-docker-traefik-v2

Terraform module to provision a Traefik (v2.10.3) reverse proxy / load balancer on Docker swarm
https://github.com/colinwilson/terraform-docker-traefik-v2

acme docker docker-swarm letsencrypt terraform terraform-module traefik traefik-v2

Last synced: 3 months ago
JSON representation

Terraform module to provision a Traefik (v2.10.3) reverse proxy / load balancer on Docker swarm

Host: GitHub
URL: https://github.com/colinwilson/terraform-docker-traefik-v2
Owner: colinwilson
Created: 2020-08-23T01:10:54.000Z (over 4 years ago)
Default Branch: release
Last Pushed: 2023-06-22T00:01:58.000Z (over 1 year ago)
Last Synced: 2024-05-01T13:06:43.983Z (9 months ago)
Topics: acme, docker, docker-swarm, letsencrypt, terraform, terraform-module, traefik, traefik-v2
Language: HCL
Homepage: https://registry.terraform.io/modules/colinwilson/traefik-v2/docker
Size: 80.1 KB
Stars: 16
Watchers: 3
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # terraform-docker-traefik-v2

An opinionated Terraform module to provision a [Traefik v2](https://github.com/traefik/traefik) reverse proxy/load balancer container on a Docker host in Swarm mode. See the variables file for the available configuration options.

![](https://res.cloudinary.com/qunux/image/upload/v1608070821/traefik_2.3.5_ds_screenshot_2_opt_fqyanb.png)

## Tutorial

[Provision a Docker Swarm Host with Traefik (v2) on Hetzner Cloud using Terraform Modules - Part 2](https://colinwilson.uk/2020/12/18/provision-a-docker-swarm-host-with-traefik-v2-on-hetzner-cloud-using-terraform-modules-part-2/)

## Compatibility

This module is meant for use with Terraform 0.13 or higher.

## Features

* [x] Create a Traefik load balancer/proxy service on a **Docker Swarm mode** host

* [x] Support for **multiple** (optional) Let's Encrypt [`dnsChallenge`](https://doc.traefik.io/traefik/https/acme/#dnschallenge) providers

* [x] Traefik dashboard enabled and protected by HTTP **Basic Auth**. Configurable password

* [x] Acquire (generate) HTTPS certificates automatically (including renewals) with [Let's Encrypt](https://letsencrypt.org/) via **Docker labels**.

* [x] Example deployment repository

* [ ] Include additional `dnsChallenge` providers

* [ ] Document optional `dnsChallenge` variables

## Traefik Configuration

* HTTP --> HTTPS redirect configured via [RedirectScheme](https://doc.traefik.io/traefik/middlewares/redirectscheme/) middleware

* Production & Staging Let's Encrypt [`httpChallenge`](https://doc.traefik.io/traefik/https/acme/#httpchallenge) resolvers configured by default (Docker label values are `letsEncrypt` and `letsEncryptStaging` respectively)

* Support for optional [`dnsChallenge`](https://doc.traefik.io/traefik/https/acme/#dnschallenge) providers (currently supported providers: `cloudflare`). Docker labels for enabled providers use the following syntax: `` or `Staging`. e.g. `cloudflare`,`cloudflareStaging`.

* Dashboard enabled and password protected by [Basic Auth middleware](https://doc.traefik.io/traefik/middlewares/basicauth/)

* Containers balanced/proxied by Traefik are **not** exposed by default. Exposed via the `traefik.enabled` Docker label

* Port 80/443 published in `host` mode to allow client IP forwarding

* [Prometheus metrics](https://doc.traefik.io/traefik/observability/metrics/prometheus/) enabled. Entrypoint: **/metrics** (**not** publicly exposed)

## Usage

Basic usage of this module is as follows:

```hcl

module "docker-traefik" {

  source = "github.com/colinwilson/terraform-docker-traefik-v2"

  password                   = "my_password"         # optional

  traefik_network_attachable = true                  # optional

  acme_email                 = "[email protected]"

  hostname                   = "traefik.example.com"

  live_cert                  = true                  # optional

  lets_encrypt_keytype       = "EC384"               # optional

  lets_encrypt_resolvers     = ["cloudflare"]        # optional

}

```

A Functional example is included in the

[examples](./examples/) directory or clone the **docker-traefik** branch [here](https://github.com/colinwilson/example-terraform-modules)

## Inputs

### Required

| Name | Description | Type | Default | Required |

|------|-------------|:----:|:-----:|:-----:|

| hostname | Hostname for Traefik. | string | n/a | yes |

| acme_email | Let's Encrypt registration email | string | n/a | yes |

### Optional

| Name | Description | Type | Default | Required |

|------|-------------|:----:|:-----:|:-----:|

| networks | List of additional networks Traefik should connect to. | list(string) | `[]` | no |

| traefik_network | Name of Traefik (Docker overlay) network. | string | `"traefik"` | no |

| traefik_network_attachable | Make the default Traefik network attachable. | bool | `false` | no |

| traefik_version | Which Traefik Docker image version to use. | string | `"2.10.3"` | no |

| password | Password to login to Traefik dashboard (username: admin). | string | `"traefik"` | no |

| live_cert | Deploy Traefik with a live SSL cert. | bool | `"false"` | no |

| lets_encrypt_keytype | SSL cert key type to issue certs with. | string |`"RSA2048"` | no |

| lets_encrypt_resolvers | List of DNS Challange providers to enable. | list(string) | `[]`| no |

## Outputs

| Name | Description |

|------|-------------|

| acme_volume_mountpoint | Mount point of the ACME certificates storage volume. |

| traefik_network_name | Name of the Traefik network. |

| traefik_service_config_name | File name of the Traefik configuration file. |

## Requirements

These sections describe requirements for using this module.

### Software

The following dependencies must be available:

- [Terraform](https://www.terraform.io/downloads.html) v0.13

- [Terraform Provider for Docker](https://registry.terraform.io/providers/kreuzwerker/docker/latest) version 2.8.x