Forge Home

traefik

Module to manage the Traefik reverse proxy

11,508 downloads

8,814 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.3.1 (latest)
  • 0.3.0
  • 0.2.0
  • 0.1.1
  • 0.1.0
released Oct 20th 2016
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.4.0
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'praekeltfoundation-traefik', '0.3.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add praekeltfoundation-traefik
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install praekeltfoundation-traefik --version 0.3.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

praekeltfoundation/traefik — version 0.3.1 Oct 20th 2016

puppet-traefik

A Puppet module to manage Traefik

Usage

You can just include traefik or set some basic parameters:

class { 'traefik':
  version     => '1.0.0-rc1',
  config_hash => {
    'accessLogsFile' => '/var/log/traefik/access.log',
    'logLevel'       => 'INFO'
  },
}

Different sections of Traefik's TOML configuration file can be defined with the traefik::config::section type. The name of the Puppet resource, in this case 'web' is used for the top-level of the resulting hash and will result in a table [web] in the TOML file:

traefik::config::section { 'web':
  description => 'API backend',
  order       => '10',
  hash        => {'address' => ':9090'}
}

Hashes can be nested to produce nested TOML tables. The following resource will output the common http and https EntryPoints.

traefik::config::section { 'entryPoints':
  hash => {
    'http'  => {
      'address' => ':80'
    },
    'https' => {
      'address' => ':443',
      'tls'     => {}
    }
  }
}

File backend

Configuring backends and frontends using hashes in traefik::config::section resources can quickly get tedious. The traefik::config::file class and traefik::config::file_rule defined type make setting this up a bit easier.

To start, configure some basics for the file backend:

class { 'traefik::config::file':
  filename => 'rules.toml',
  watch    => true
}

This will set up Traefik to read configuration for the file backend from a file called rules.toml and to watch that file for changes. Next, we create some frontend and backend rules:

traefik::config::file_rule { 'my-service':
  frontend => {
    'routes' => {
      'test_1' => {
        'rule' => 'Host:my-service.example.com'
      }
    }
  },
  backend  => {
    'servers' => {
      'server1' => {
        'url'    => 'http://172.17.0.2:80',
        'weight' => 10
      },
      'server2' => {
        'url'    => 'http://172.17.0.3:80',
        'weight' => 1
      }
    }
  }
}

This should produce (roughly) the following config in rules.toml:

[frontends.my-service-frontend]
backend = 'my-service-backend'

[frontends.my-service-frontend.routes.test_1]
rule = "Host:my-service.example.com"

[backends.my-service-backend.servers.server1]
url = "http://172.17.0.2:80"
weight = 10

[backends.my-service-backend.servers.server2]
url = "http://172.17.0.3:80"
weight = 1

Limitations

  • Currently only works on Ubuntu 14.04 and Debian 8 (pull requests welcome).
  • Uses the toml-rb gem to generate config with a parser function. This means that your Puppet server must have the gem correctly installed. See this page for Puppet 4 instructions.
  • There is no validation on config parameters. Everything (and anything) can be specified via hashes.