Compare commits

...

3 commits

Author SHA1 Message Date
137075ee6f
feat: add basic httpbin services
Used to test connectivity of proxies
2025-11-07 11:57:45 +01:00
314fce4757
chore: upgrade reverseproxy role for use with vagrant and ssl 2025-11-07 11:57:07 +01:00
dd84ca3184
chore: install docker and dependencies in base role
the ansible_virtualization_type != "docker" part is used when testing in containers, since systemd is not available there
2025-11-07 11:56:57 +01:00
17 changed files with 420 additions and 57 deletions

View file

@ -1,3 +1,61 @@
#SPDX-License-Identifier: MIT-0
---
# tasks file for base
- name: Update apt cache
ansible.builtin.apt:
update_cache: true
cache_valid_time: 3600
when: ansible_os_family == "Debian"
- name: Install required packages for Docker
ansible.builtin.apt:
name:
- apt-transport-https
- ca-certificates
- curl
- gnupg
- lsb-release
state: present
when: ansible_os_family == "Debian"
- name: Install convenience packages
ansible.builtin.apt:
name:
- htop
- ncdu
- vim
- curl
state: present
when: ansible_os_family == "Debian"
- name: Add Docker GPG key
ansible.builtin.apt_key:
url: https://download.docker.com/linux/debian/gpg
state: present
when: ansible_os_family == "Debian"
- name: Add Docker repository
ansible.builtin.apt_repository:
repo: "deb [arch=amd64] https://download.docker.com/linux/debian {{ ansible_distribution_release }} stable"
state: present
when: ansible_os_family == "Debian"
- name: Install Docker Engine and Docker Compose plugin
ansible.builtin.apt:
name:
- docker-ce
- docker-ce-cli
- containerd.io
- docker-buildx-plugin
- docker-compose-plugin
state: present
update_cache: true
when: ansible_os_family == "Debian"
- name: Start and enable Docker service
ansible.builtin.systemd:
name: docker
state: started
enabled: true
when: ansible_virtualization_type != "docker"

38
roles/httpbin/README.md Normal file
View file

@ -0,0 +1,38 @@
Role Name
=========
A brief description of the role goes here.
Requirements
------------
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
Role Variables
--------------
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.
Dependencies
------------
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
Example Playbook
----------------
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: username.rolename, x: 42 }
License
-------
BSD
Author Information
------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed).

View file

@ -0,0 +1,19 @@
#SPDX-License-Identifier: MIT-0
---
# defaults file for httpbin
# Base directory configuration (inherited from base role or defined here)
docker_compose_base_dir: /etc/docker/compose
# Httpbin-specific configuration
httpbin_service_name: httpbin
httpbin_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ httpbin_service_name }}"
# Service configuration
httpbin_domain: "httpbin.local.test"
httpbin_image: "kennethreitz/httpbin"
httpbin_port: 80
# Traefik configuration
httpbin_traefik_network: "proxy"
httpbin_use_ssl: true

View file

@ -0,0 +1,3 @@
#SPDX-License-Identifier: MIT-0
---
# handlers file for httpbin

View file

@ -0,0 +1,35 @@
#SPDX-License-Identifier: MIT-0
galaxy_info:
author: your name
description: your role description
company: your company (optional)
# If the issue tracker for your role is not on github, uncomment the
# next line and provide a value
# issue_tracker_url: http://example.com/issue/tracker
# Choose a valid license ID from https://spdx.org - some suggested licenses:
# - BSD-3-Clause (default)
# - MIT
# - GPL-2.0-or-later
# - GPL-3.0-only
# - Apache-2.0
# - CC-BY-4.0
license: license (GPL-2.0-or-later, MIT, etc)
min_ansible_version: 2.1
# If this a Container Enabled role, provide the minimum Ansible Container version.
# min_ansible_container_version:
galaxy_tags: []
# List tags for your role here, one per line. A tag is a keyword that describes
# and categorizes the role. Users find roles by searching for tags. Be sure to
# remove the '[]' above, if you add tags to this list.
#
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
# Maximum 20 tags per role.
dependencies: []
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
# if you add dependencies to this list.

View file

@ -0,0 +1,20 @@
#SPDX-License-Identifier: MIT-0
---
# tasks file for httpbin
- name: Create docker compose directory
file:
path: "{{ httpbin_docker_compose_dir }}"
state: directory
mode: '0755'
- name: Create docker-compose file for httpbin
template:
src: docker-compose.yml.j2
dest: "{{ httpbin_docker_compose_dir }}/docker-compose.yml"
mode: '0644'
- name: Start httpbin container
community.docker.docker_compose_v2:
project_src: "{{ httpbin_docker_compose_dir }}"
state: present

View file

@ -0,0 +1,22 @@
services:
httpbin:
image: {{ httpbin_image }}
container_name: {{ httpbin_service_name }}
restart: unless-stopped
networks:
- {{ httpbin_traefik_network }}
labels:
- traefik.enable=true
- traefik.docker.network={{ httpbin_traefik_network }}
- traefik.http.routers.{{ httpbin_service_name }}.rule=Host(`{{ httpbin_domain }}`)
{% if httpbin_use_ssl %}
- traefik.http.routers.{{ httpbin_service_name }}.entrypoints=websecure
- traefik.http.routers.{{ httpbin_service_name }}.tls=true
{% else %}
- traefik.http.routers.{{ httpbin_service_name }}.entrypoints=web
{% endif %}
- traefik.http.services.{{ httpbin_service_name }}.loadbalancer.server.port={{ httpbin_port }}
networks:
{{ httpbin_traefik_network }}:
external: true

View file

@ -0,0 +1,3 @@
#SPDX-License-Identifier: MIT-0
localhost

View file

@ -0,0 +1,6 @@
#SPDX-License-Identifier: MIT-0
---
- hosts: localhost
remote_user: root
roles:
- httpbin

View file

@ -0,0 +1,3 @@
#SPDX-License-Identifier: MIT-0
---
# vars file for httpbin

View file

@ -2,13 +2,68 @@
---
# defaults file for reverseproxy
# Base directory configuration (inherited from base role or defined here)
docker_compose_base_dir: /etc/docker/compose
docker_volume_base_dir: /srv/data
# Service-specific configuration
service_name: reverseproxy
docker_compose_dir: "{{ docker_compose_base_dir }}/{{ service_name }}"
docker_volume_dir: "{{ docker_volume_base_dir }}/{{ service_name }}"
# Provider configuration
use_static_services: false # Use all_services from services.yml for outward-facing proxies
use_docker_provider: true # Use Docker provider for service discovery via labels
use_ssl: false # Enable SSL termination with Let's Encrypt
enable_dashboard: true # Enable Traefik dashboard
# Deployment mode: 'dmz' or 'backend'
# - dmz: Public-facing reverse proxy that routes to backend servers using file provider
# - backend: Application server with docker provider for local container discovery
reverseproxy_mode: "backend"
# SSL configuration
use_ssl: true
ssl_email: "admin@example.com"
ssl_cert_resolver: "dns" # Certificate resolver name
# Certificate mode: 'acme' for Let's Encrypt with DNS challenge or 'selfsigned' for self-signed certs
cert_mode: "selfsigned" # Use selfsigned for vagrant, acme for production
# ACME DNS Challenge with RFC2136 (TSIG) configuration
acme_dns_zone: "" # e.g., "digitalboard._acme.digitalboard.ch."
acme_dns_nameserver: "" # e.g., "192.168.1.1:53"
acme_tsig_algorithm: "hmac-sha256"
acme_tsig_key: "" # TSIG key name
acme_tsig_secret: "" # TSIG secret
acme_propagation_timeout: "120"
acme_polling_interval: "2"
acme_ttl: "60"
# Self-signed certificate configuration (for vagrant/testing)
selfsigned_cert_dir: "{{ docker_volume_dir }}/certs"
selfsigned_cert_days: 365
selfsigned_common_name: "*.local.test"
# Dashboard
enable_dashboard: false
# Access log configuration
enable_access_logs: true
access_log_format: "common"
log_level: "INFO"
# Network name
traefik_network: "proxy"
# Services to expose (defined by application roles via host_vars or group_vars)
# Each backend server should define this variable with their services
# reverseproxy_services:
# - name: httpbin
# domain: httpbin.example.com
# port: 8080
# protocol: http # http or https
# entrypoints: [websecure] # optional, defaults based on SSL config
# DMZ mode: Explicit backend server mapping
# Define which backend servers this DMZ proxy should route to
# If empty or undefined, routes to all servers in backend_servers group
backend_servers_to_proxy: []
# Example:
# backend_servers_to_proxy:
# - backend1
# - backend2

View file

@ -30,6 +30,5 @@ galaxy_info:
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
# Maximum 20 tags per role.
dependencies: []
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
# if you add dependencies to this list.
dependencies:
- digitalboard.core.base

View file

@ -2,23 +2,23 @@
---
# tasks file for reverseproxy
- name: Gather service information from all hosts
setup:
delegate_to: "{{ item }}"
delegate_facts: true
loop: "{{ groups['all_servers'] }}"
when: use_static_services | bool
- name: Build service registry from all hosts
- name: Determine which backend servers to proxy (DMZ mode)
set_fact:
all_services: "{{ all_services | default([]) + hostvars[item].services | default([]) | map('combine', {'backend_host': item}) | list }}"
loop: "{{ groups['all_servers'] }}"
when: use_static_services | bool
_backend_servers: "{{ backend_servers_to_proxy if backend_servers_to_proxy | length > 0 else groups['backend_servers'] | default([]) }}"
when: reverseproxy_mode == 'dmz'
- name: Build service registry from backend servers (DMZ mode)
set_fact:
proxied_services: "{{ proxied_services | default([]) + hostvars[item].reverseproxy_services | default([]) | map('combine', {'backend_host': hostvars[item].ansible_host | default(item)}) | list }}"
loop: "{{ _backend_servers | default([]) }}"
when: reverseproxy_mode == 'dmz'
- name: Debug service registry
debug:
var: all_services
when: use_static_services | bool
var: proxied_services
when:
- reverseproxy_mode == 'dmz'
- proxied_services is defined
- name: Create docker compose directory
file:
@ -26,33 +26,45 @@
state: directory
mode: '0755'
- name: Create docker volume directories
- name: Create docker volume directory
file:
path: "{{ docker_volume_dir }}/traefik/{{ item }}"
path: "{{ docker_volume_dir }}"
state: directory
mode: '0755'
loop:
- letsencrypt
- name: Create traefik config directory
file:
path: "{{ docker_volume_dir }}/config"
state: directory
mode: '0755'
when: reverseproxy_mode == 'dmz'
- name: Create letsencrypt directory
file:
path: "{{ docker_volume_dir }}/letsencrypt"
state: directory
mode: '0755'
when: cert_mode == 'acme'
- name: Create traefik Docker network
community.docker.docker_network:
name: traefik
name: "{{ traefik_network }}"
state: present
- name: Generate traefik static configuration
template:
src: traefik.yml.j2
dest: "{{ docker_compose_dir }}/traefik.yml"
dest: "{{ docker_volume_dir }}/traefik.yml"
mode: '0644'
notify: restart traefik
- name: Generate traefik services configuration for discovered services
- name: Generate traefik dynamic configuration for DMZ services
template:
src: services.yml.j2
dest: "{{ docker_compose_dir }}/services.yml"
dest: "{{ docker_volume_dir }}/config/services.yml"
mode: '0644'
notify: restart traefik
when: use_static_services | bool
when: reverseproxy_mode == 'dmz'
- name: Create docker-compose file for traefik
template:
@ -63,4 +75,4 @@
- name: Start traefik container
community.docker.docker_compose_v2:
project_src: "{{ docker_compose_dir }}"
state: present
state: present

View file

@ -1,21 +1,39 @@
services:
traefik:
image: traefik:v3.5
container_name: traefik
image: traefik:latest
container_name: reverseproxy
restart: always
{% if cert_mode == 'acme' %}
environment:
RFC2136_NAMESERVER: "{{ acme_dns_nameserver }}"
RFC2136_TSIG_ALGORITHM: "{{ acme_tsig_algorithm }}"
RFC2136_TSIG_KEY: "{{ acme_tsig_key }}"
RFC2136_TSIG_SECRET: "{{ acme_tsig_secret }}"
RFC2136_PROPAGATION_TIMEOUT: "{{ acme_propagation_timeout }}"
RFC2136_POLLING_INTERVAL: "{{ acme_polling_interval }}"
RFC2136_TTL: "{{ acme_ttl }}"
{% endif %}
ports:
- "80:80"
- "443:443"
{% if enable_dashboard %}
- "8080:8080" # Dashboard
- "8080:8080"
{% endif %}
volumes:
- {{ docker_volume_dir }}/traefik/etc/traefik:/etc/traefik:ro
- {{ docker_volume_dir }}/traefik/letsencrypt:/letsencrypt
- {{ docker_volume_dir }}/traefik.yml:/traefik.yml:ro
{% if cert_mode == 'acme' %}
- {{ docker_volume_dir }}/letsencrypt:/letsencrypt
{% endif %}
{% if reverseproxy_mode == 'dmz' %}
- {{ docker_volume_dir }}/config:/config:ro
{% endif %}
{% if reverseproxy_mode == 'backend' %}
- /var/run/docker.sock:/var/run/docker.sock:ro
{% endif %}
networks:
- traefik
- {{ traefik_network }}
networks:
traefik:
{{ traefik_network }}:
name: {{ traefik_network }}
external: true

View file

@ -0,0 +1,47 @@
{% if enable_dashboard %}
api:
dashboard: true
insecure: true
{% endif %}
{% if enable_access_logs %}
accessLog:
format: {{ access_log_format }}
{% endif %}
entryPoints:
web:
address: ":80"
{% if use_ssl %}
http:
redirections:
entryPoint:
to: websecure
scheme: https
{% endif %}
websecure:
address: ":443"
providers:
{% if use_static_services | default(false) %}
file:
filename: /etc/traefik/services.yml
watch: true
{% endif %}
{% if use_docker_provider | default(true) %}
docker:
endpoint: "unix:///var/run/docker.sock"
exposedByDefault: false
{% endif %}
certificatesResolvers:
letsencrypt:
acme:
email: admin@digitalboard.ch
storage: /letsencrypt/acme.json
httpChallenge:
entryPoint: web
global:
checkNewVersion: false
sendAnonymousUsage: false

View file

@ -1,30 +1,35 @@
{% if use_static_services | default(false) %}
http:
routers:
{% for service in all_services %}
{% for service in proxied_services %}
{{ service.name }}:
rule: "Host(`{{ service.domain }}`)"
service: {{ service.name }}-service
entryPoints:
{% if use_ssl | default(false) %}
- websecure
- {{ 'websecure' if use_ssl else 'web' }}
{% if use_ssl %}
tls:
certResolver: letsencrypt
{% if cert_mode == 'acme' %}
certResolver: {{ ssl_cert_resolver }}
{% else %}
- web
{}
{% endif %}
{% endif %}
{% endfor %}
services:
{% for service in all_services %}
{% for service in proxied_services %}
{{ service.name }}-service:
loadBalancer:
passHostHeader: true
servers:
- url: "{{ service.upstream_protocol }}://{{ service.backend_host }}:{{ service.port }}"
{% if service.health_check is defined %}
healthCheck:
path: "{{ service.health_check }}"
interval: "30s"
- url: "{{ service.protocol }}://{{ service.backend_host }}:{{ service.port }}"
{% if service.protocol == 'https' and cert_mode == 'selfsigned' %}
serversTransport: insecure-transport
{% endif %}
{% endfor %}
{% if cert_mode == 'selfsigned' %}
serversTransports:
insecure-transport:
insecureSkipVerify: true
{% endif %}

View file

@ -1,9 +1,17 @@
log:
level: {{ log_level }}
{% if enable_dashboard %}
api:
dashboard: true
insecure: true
{% endif %}
{% if enable_access_logs %}
accessLog:
format: {{ access_log_format }}
{% endif %}
entryPoints:
web:
address: ":80"
@ -18,24 +26,36 @@ entryPoints:
address: ":443"
providers:
{% if use_static_services | default(false) %}
{% if reverseproxy_mode == 'dmz' %}
file:
filename: /etc/traefik/services.yml
directory: /config
watch: true
{% endif %}
{% if use_docker_provider | default(true) %}
{% if reverseproxy_mode == 'backend' %}
docker:
endpoint: "unix:///var/run/docker.sock"
network: {{ traefik_network }}
exposedByDefault: false
{% endif %}
{% if use_ssl and cert_mode == 'acme' %}
certificatesResolvers:
letsencrypt:
{{ ssl_cert_resolver }}:
acme:
email: admin@digitalboard.ch
email: {{ ssl_email }}
storage: /letsencrypt/acme.json
httpChallenge:
entryPoint: web
dnsChallenge:
provider: rfc2136
resolvers:
- "{{ acme_dns_nameserver }}"
{% endif %}
{% if use_ssl %}
tls:
options:
default:
minVersion: VersionTLS12
{% endif %}
global:
checkNewVersion: false