/role-traefik-on-docker

An Ansible role that installs the traefik router/reverse proxy/SSL endpoint wonder service onto a docker host

Primary LanguagePython

Role Name

Ansible role to install traefik onto any host with a Docker host installed, as a container.

Requirements

The only real dependency is that docker is installed and configured on the host system and that the user being managed by Ansible is either root or a user in the docker group.

Role Variables

TODO

A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.

  • traefik_debug
    • defaults to false
    • determines if the traefik service should be run in its debug mode
  • traefik_api_port
    • defaults to 8080
    • the port where the traefik api communicates through
    • also where to reach its dashboard interface
  • traefik_data_directory
    • defaults to /var/www/traefik
    • determines where the traefik service's configs, logs, etc. are stored

Dependencies

TODO

The go-to role for installing docker tends to be geerlingguy's docker role so that is one tentative dependency, but arch-based users will be left out in the cold if that were a dependency, so when this role is more mature, and I have my own or someone else's good docker role for arch users I'll add some role dependencies.

Example Playbook

TODO

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

- hosts: servers
  roles:
     - { role: traefik-on-docker, x: 42 }

License

CC-BY

Author Information

Reach out to me on the github repository's issues section to point out problems or suggestions: