Harden Dynu/Traefik DNS correlation and validation
This commit is contained in:
beatz174-bit
@@ -18,9 +18,74 @@ This repository includes a **read-only** Dynu DNS inventory workflow for `lan.dd
|
|||||||
- No Ansible Dynu mutation tasks are introduced.
|
- No Ansible Dynu mutation tasks are introduced.
|
||||||
- API secrets are read from environment variables and are never logged.
|
- API secrets are read from environment variables and are never logged.
|
||||||
|
|
||||||
|
## Correlation logic
|
||||||
|
|
||||||
|
`scripts/dynu/correlate_dynu_with_traefik.py` uses compose files as the source of truth and parses them as YAML.
|
||||||
|
|
||||||
|
It supports both common label formats:
|
||||||
|
|
||||||
|
- list style:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
labels:
|
||||||
|
- "traefik.http.routers.app.rule=Host(`app.lan.ddnsgeek.com`)"
|
||||||
|
```
|
||||||
|
|
||||||
|
- map style:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
labels:
|
||||||
|
traefik.http.routers.app.rule: "Host(`app.lan.ddnsgeek.com`)"
|
||||||
|
```
|
||||||
|
|
||||||
|
The parser extracts hostnames from router rules such as:
|
||||||
|
|
||||||
|
- `Host(`a`)`
|
||||||
|
- `Host("a")`
|
||||||
|
- `Host('a')`
|
||||||
|
- multi-host rules (comma-delimited)
|
||||||
|
- combined expressions such as `Host(...) && PathPrefix(...)`
|
||||||
|
|
||||||
|
## Route metadata in inventory
|
||||||
|
|
||||||
|
Each discovered hostname mapping includes:
|
||||||
|
|
||||||
|
- fqdn
|
||||||
|
- compose service name
|
||||||
|
- compose file path
|
||||||
|
- stack area (`apps`, `monitoring`, `core`)
|
||||||
|
- router label key(s)
|
||||||
|
- raw router rule
|
||||||
|
- `uses_tls`
|
||||||
|
- `tls_options`
|
||||||
|
- `middlewares`
|
||||||
|
- `uses_mtls`
|
||||||
|
- `uses_authelia`
|
||||||
|
|
||||||
|
mTLS is metadata only and **never blocks mapping**.
|
||||||
|
|
||||||
|
## Validation model
|
||||||
|
|
||||||
|
The generated JSON/Markdown include a top-level `validation` section with:
|
||||||
|
|
||||||
|
- `allowed_unmapped_hostnames`
|
||||||
|
- `unexpected_unmapped_hostnames`
|
||||||
|
- `duplicate_hostnames`
|
||||||
|
- `ambiguous_hostnames`
|
||||||
|
- `validation_ok`
|
||||||
|
|
||||||
|
Current policy:
|
||||||
|
|
||||||
|
- `edge.lan.ddnsgeek.com` is the only allowed unmapped DNS hostname.
|
||||||
|
- every other `*.lan.ddnsgeek.com` DNS hostname should map to a compose/Traefik-discovered service.
|
||||||
|
|
||||||
|
Optional strict mode:
|
||||||
|
|
||||||
|
- Set `DYNU_ENFORCE_VALIDATION=true` to make the correlate script exit non-zero when unexpected unmapped hostnames exist.
|
||||||
|
|
||||||
## Required Environment Variables
|
## Required Environment Variables
|
||||||
|
|
||||||
- `DYNU_API_KEY` (required)
|
- `DYNU_API_KEY` (required for fetch)
|
||||||
- `DYNU_BASE_URL` (optional, defaults to `https://api.dynu.com`)
|
- `DYNU_BASE_URL` (optional, defaults to `https://api.dynu.com`)
|
||||||
- `DYNU_READ_ONLY` (**must** be `true`)
|
- `DYNU_READ_ONLY` (**must** be `true`)
|
||||||
|
|
||||||
@@ -33,6 +98,7 @@ DYNU_BASE_URL=https://api.dynu.com
|
|||||||
```
|
```
|
||||||
|
|
||||||
Notes:
|
Notes:
|
||||||
|
|
||||||
- Keep values unquoted unless required by your shell.
|
- Keep values unquoted unless required by your shell.
|
||||||
- `scripts/dynu/build_dns_inventory.sh` will auto-load `secrets/dynu.env` when present.
|
- `scripts/dynu/build_dns_inventory.sh` will auto-load `secrets/dynu.env` when present.
|
||||||
|
|
||||||
|
|||||||
@@ -4,93 +4,64 @@
|
|||||||
|
|
||||||
- Base domain: `lan.ddnsgeek.com`
|
- Base domain: `lan.ddnsgeek.com`
|
||||||
- Dynu fetched at: `2026-04-21T03:55:09+00:00`
|
- Dynu fetched at: `2026-04-21T03:55:09+00:00`
|
||||||
- Inventory generated at: `2026-04-21T03:55:09+00:00`
|
- Inventory generated at: `2026-04-21T04:08:43+00:00`
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
|
|
||||||
- Traefik hostnames discovered: **5**
|
- Traefik hostnames discovered: **15**
|
||||||
- Dynu hostnames discovered: **20**
|
- Dynu hostnames discovered: **20**
|
||||||
- Matched: **5**
|
- Mapped hostnames: **15**
|
||||||
- Missing in Dynu: **0**
|
- DNS-only hostnames: **5**
|
||||||
- Dynu DNS only: **15**
|
- Traefik-only hostnames: **0**
|
||||||
- Duplicate Traefik hostnames: **1**
|
- Ambiguous hostnames: **0**
|
||||||
|
|
||||||
## Dynu Records
|
## Validation
|
||||||
|
|
||||||
| Hostname | Type | Value | TTL |
|
- Validation ok: **false**
|
||||||
|---|---|---|---|
|
- Allowed unmapped hostnames: `edge.lan.ddnsgeek.com`
|
||||||
| `auth.lan.ddnsgeek.com` | `A` | `` | `120` |
|
- Unexpected unmapped hostnames: **3**
|
||||||
| `edge.lan.ddnsgeek.com` | `A` | `` | `120` |
|
- Duplicate hostnames: **1**
|
||||||
| `familytree.lan.ddnsgeek.com` | `A` | `` | `120` |
|
- Ambiguous hostnames: **0**
|
||||||
| `gitea.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `gotify.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `grafana.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `influxdb.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `kuma.lan.ddnsgeek.com` | `A` | `120.155.63.223` | `60` |
|
|
||||||
| `lan.ddnsgeek.com` | `SOA` | `` | `120` |
|
|
||||||
| `monitor-kuma.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `mtls-bridge.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `nextcloud.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `node-red.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `passbolt.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `portainer.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `prometheus.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `searxng.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `shifts.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `stockfill.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
| `traefik.lan.ddnsgeek.com` | `A` | `` | `120` |
|
|
||||||
|
|
||||||
## Correlation
|
### Allowed unmapped hostnames
|
||||||
|
|
||||||
| Hostname | Status | Service(s) | Source compose file(s) | DNS records |
|
- `edge.lan.ddnsgeek.com`
|
||||||
|---|---|---|---|---|
|
|
||||||
| `auth.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `edge.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `familytree.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `gitea.lan.ddnsgeek.com` | `matched` | apps/gitea | apps/gitea/docker-compose.yml | A: |
|
|
||||||
| `gotify.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `grafana.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `influxdb.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `kuma.lan.ddnsgeek.com` | `dns_only` | - | - | A:120.155.63.223 |
|
|
||||||
| `lan.ddnsgeek.com` | `dns_only` | - | - | SOA: |
|
|
||||||
| `monitor-kuma.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `mtls-bridge.lan.ddnsgeek.com` | `matched` | monitoring/mtls-bridge | monitoring/mtls-bridge/docker-compose.yml | A: |
|
|
||||||
| `nextcloud.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `node-red.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `passbolt.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `portainer.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `prometheus.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `searxng.lan.ddnsgeek.com` | `matched` | apps/searxng-webapp | apps/searxng/docker-compose.yml | A: |
|
|
||||||
| `shifts.lan.ddnsgeek.com` | `dns_only` | - | - | A: |
|
|
||||||
| `stockfill.lan.ddnsgeek.com` | `matched` | apps/stockfill | apps/stockfill/docker-compose.yml | A: |
|
|
||||||
| `traefik.lan.ddnsgeek.com` | `matched` | core/traefik | core/traefik/docker-compose.yml | A: |
|
|
||||||
|
|
||||||
## Matched records
|
### Unexpected unmapped hostnames
|
||||||
|
|
||||||
- `gitea.lan.ddnsgeek.com`
|
- `kuma.lan.ddnsgeek.com`
|
||||||
- `mtls-bridge.lan.ddnsgeek.com`
|
- `shifts.lan.ddnsgeek.com`
|
||||||
- `searxng.lan.ddnsgeek.com`
|
|
||||||
- `stockfill.lan.ddnsgeek.com`
|
- `stockfill.lan.ddnsgeek.com`
|
||||||
- `traefik.lan.ddnsgeek.com`
|
|
||||||
|
|
||||||
## Traefik hostnames missing in Dynu
|
### Duplicate hostnames
|
||||||
|
|
||||||
|
- `mtls-bridge.lan.ddnsgeek.com`
|
||||||
|
|
||||||
|
### Ambiguous hostnames
|
||||||
|
|
||||||
_None._
|
_None._
|
||||||
|
|
||||||
## Dynu DNS records not mapped to known Traefik services
|
## Correlation
|
||||||
|
|
||||||
- `auth.lan.ddnsgeek.com`
|
| Hostname | Status | Reasons | Service(s) | Route metadata | DNS records |
|
||||||
- `edge.lan.ddnsgeek.com`
|
|---|---|---|---|---|---|
|
||||||
- `familytree.lan.ddnsgeek.com`
|
| `auth.lan.ddnsgeek.com` | `mapped` | `mapped` | core/authelia | authelia [tls=true, mtls=false, authelia=false, tls_options=-, middlewares=-] | A: |
|
||||||
- `gotify.lan.ddnsgeek.com`
|
| `edge.lan.ddnsgeek.com` | `allowed_unmapped` | `allowed_unmapped, dns_only` | - | - | A: |
|
||||||
- `grafana.lan.ddnsgeek.com`
|
| `familytree.lan.ddnsgeek.com` | `mapped` | `mapped` | apps/grampsweb | gramps [tls=true, mtls=false, authelia=false, tls_options=-, middlewares=-] | A: |
|
||||||
- `influxdb.lan.ddnsgeek.com`
|
| `gitea.lan.ddnsgeek.com` | `mapped` | `mapped` | apps/gitea | gitea [tls=true, mtls=false, authelia=false, tls_options=-, middlewares=-] | A: |
|
||||||
- `kuma.lan.ddnsgeek.com`
|
| `gotify.lan.ddnsgeek.com` | `mapped` | `mapped` | monitoring/gotify | gotify [tls=true, mtls=true, authelia=false, tls_options=mtls-private-admin@file, middlewares=-] | A: |
|
||||||
- `lan.ddnsgeek.com`
|
| `grafana.lan.ddnsgeek.com` | `mapped` | `mapped` | monitoring/grafana | grafana [tls=true, mtls=true, authelia=false, tls_options=mtls-private-admin@file, middlewares=-] | A: |
|
||||||
- `monitor-kuma.lan.ddnsgeek.com`
|
| `influxdb.lan.ddnsgeek.com` | `mapped` | `mapped` | monitoring/influxdb | influxdb [tls=true, mtls=true, authelia=true, tls_options=mtls-private-admin@file, middlewares=authelia] | A: |
|
||||||
- `nextcloud.lan.ddnsgeek.com`
|
| `kuma.lan.ddnsgeek.com` | `unexpected_unmapped` | `unexpected_unmapped, dns_only` | - | - | A:120.155.63.223 |
|
||||||
- `node-red.lan.ddnsgeek.com`
|
| `lan.ddnsgeek.com` | `dns_only` | `dns_only` | - | - | SOA: |
|
||||||
- `passbolt.lan.ddnsgeek.com`
|
| `monitor-kuma.lan.ddnsgeek.com` | `mapped` | `mapped` | monitoring/monitor-kuma | monitor [tls=true, mtls=true, authelia=false, tls_options=mtls-private-admin@file, middlewares=-] | A: |
|
||||||
- `portainer.lan.ddnsgeek.com`
|
| `mtls-bridge.lan.ddnsgeek.com` | `mapped` | `mapped` | monitoring/mtls-bridge | mtls-bridge [tls=true, mtls=true, authelia=false, tls_options=-, middlewares=mtls-bridge-auth,mtls-bridge-cors]<br>mtls-bridge-preflight [tls=true, mtls=true, authelia=false, tls_options=-, middlewares=mtls-bridge-cors] | A: |
|
||||||
- `prometheus.lan.ddnsgeek.com`
|
| `nextcloud.lan.ddnsgeek.com` | `mapped` | `mapped` | apps/nextcloud-webapp | nextcloud [tls=true, mtls=false, authelia=false, tls_options=-, middlewares=nextcloud-dav,nextcloud-webfinger] | A: |
|
||||||
- `shifts.lan.ddnsgeek.com`
|
| `node-red.lan.ddnsgeek.com` | `mapped` | `mapped` | monitoring/node-red | node-red [tls=true, mtls=true, authelia=true, tls_options=mtls-private-admin@file, middlewares=authelia] | A: |
|
||||||
|
| `passbolt.lan.ddnsgeek.com` | `mapped` | `mapped` | apps/passbolt-webapp | passbolt [tls=true, mtls=false, authelia=false, tls_options=-, middlewares=-] | A: |
|
||||||
|
| `portainer.lan.ddnsgeek.com` | `mapped` | `mapped` | monitoring/portainer | portainer [tls=true, mtls=true, authelia=false, tls_options=mtls-private-admin@file, middlewares=-] | A: |
|
||||||
|
| `prometheus.lan.ddnsgeek.com` | `mapped` | `mapped` | monitoring/prometheus | prometheus [tls=true, mtls=true, authelia=true, tls_options=mtls-private-admin@file, middlewares=authelia] | A: |
|
||||||
|
| `searxng.lan.ddnsgeek.com` | `mapped` | `mapped` | apps/searxng-webapp | searxng [tls=true, mtls=false, authelia=false, tls_options=-, middlewares=-] | A: |
|
||||||
|
| `shifts.lan.ddnsgeek.com` | `unexpected_unmapped` | `unexpected_unmapped, dns_only` | - | - | A: |
|
||||||
|
| `stockfill.lan.ddnsgeek.com` | `unexpected_unmapped` | `unexpected_unmapped, dns_only` | - | - | A: |
|
||||||
|
| `traefik.lan.ddnsgeek.com` | `mapped` | `mapped` | core/traefik | traefik [tls=true, mtls=true, authelia=true, tls_options=mtls-private-admin@file, middlewares=authelia] | A: |
|
||||||
|
|||||||
@@ -14,15 +14,19 @@ import sys
|
|||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
from datetime import datetime, timezone
|
from datetime import datetime, timezone
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Dict, List, Tuple
|
from typing import Any, Dict, Iterable, List, Set
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
|
||||||
BASE_DOMAIN = "lan.ddnsgeek.com"
|
BASE_DOMAIN = "lan.ddnsgeek.com"
|
||||||
|
ALLOWED_UNMAPPED_HOSTNAMES = ["edge.lan.ddnsgeek.com"]
|
||||||
DYN_DATA = Path("data/dns/dynu_live.json")
|
DYN_DATA = Path("data/dns/dynu_live.json")
|
||||||
OUT_JSON = Path("data/dns/dynu_traefik_inventory.json")
|
OUT_JSON = Path("data/dns/dynu_traefik_inventory.json")
|
||||||
OUT_MD = Path("docs/generated/dns-inventory.md")
|
OUT_MD = Path("docs/generated/dns-inventory.md")
|
||||||
|
|
||||||
HOST_RULE_RE = re.compile(r"Host\((.*?)\)")
|
HOST_CALL_RE = re.compile(r"Host\s*\(([^)]*)\)", re.IGNORECASE)
|
||||||
DOMAIN_RE = re.compile(r"[`\"']([^`\"']+)[`\"']")
|
QUOTED_HOST_RE = re.compile(r"[`\"']([^`\"']+)[`\"']")
|
||||||
|
ROUTER_LABEL_RE = re.compile(r"^traefik\.http\.routers\.([^.]+)\.(.+)$")
|
||||||
|
|
||||||
|
|
||||||
class ReadOnlyError(RuntimeError):
|
class ReadOnlyError(RuntimeError):
|
||||||
@@ -38,95 +42,156 @@ def require_read_only() -> None:
|
|||||||
|
|
||||||
|
|
||||||
def compose_files(root: Path) -> List[Path]:
|
def compose_files(root: Path) -> List[Path]:
|
||||||
files = [root / "default-network.yml"]
|
files: Set[Path] = set()
|
||||||
|
if (root / "default-network.yml").exists():
|
||||||
|
files.add(root / "default-network.yml")
|
||||||
|
|
||||||
for area in ("apps", "monitoring", "core"):
|
for area in ("apps", "monitoring", "core"):
|
||||||
base = root / area
|
base = root / area
|
||||||
if not base.exists():
|
if not base.exists():
|
||||||
continue
|
continue
|
||||||
for p in sorted(base.glob("*/*")):
|
for pattern in ("**/docker-compose.yml", "**/docker-compose.yaml"):
|
||||||
if p.is_file() and p.name in {"docker-compose.yml", "docker-compose.yaml"}:
|
files.update(p for p in base.glob(pattern) if p.is_file())
|
||||||
files.append(p)
|
|
||||||
return files
|
return sorted(files)
|
||||||
|
|
||||||
|
|
||||||
def parse_hosts_from_label(label_value: str) -> List[str]:
|
def parse_hosts_from_rule(rule: str) -> List[str]:
|
||||||
found = []
|
hosts: Set[str] = set()
|
||||||
for fragment in HOST_RULE_RE.findall(label_value):
|
for call_fragment in HOST_CALL_RE.findall(rule):
|
||||||
for host in DOMAIN_RE.findall(fragment):
|
quoted_hosts = QUOTED_HOST_RE.findall(call_fragment)
|
||||||
h = host.strip().strip(".").lower()
|
for host in quoted_hosts:
|
||||||
if h:
|
clean = host.strip().strip(".").lower()
|
||||||
found.append(h)
|
if clean:
|
||||||
return sorted(set(found))
|
hosts.add(clean)
|
||||||
|
|
||||||
|
if not quoted_hosts:
|
||||||
|
for token in call_fragment.split(","):
|
||||||
|
clean = token.strip().strip(".`\"'").lower()
|
||||||
|
if clean:
|
||||||
|
hosts.add(clean)
|
||||||
|
|
||||||
|
return sorted(hosts)
|
||||||
|
|
||||||
|
|
||||||
def extract_traefik_hosts(path: Path) -> List[Dict[str, str]]:
|
def load_env_defaults(repo_root: Path) -> Dict[str, str]:
|
||||||
lines = path.read_text(encoding="utf-8").splitlines()
|
env_values: Dict[str, str] = {}
|
||||||
entries: List[Dict[str, str]] = []
|
for candidate in (repo_root / "default-environment.env", repo_root / ".env"):
|
||||||
|
if not candidate.exists():
|
||||||
|
continue
|
||||||
|
for line in candidate.read_text(encoding="utf-8").splitlines():
|
||||||
|
stripped = line.strip()
|
||||||
|
if not stripped or stripped.startswith("#") or "=" not in stripped:
|
||||||
|
continue
|
||||||
|
key, value = stripped.split("=", 1)
|
||||||
|
env_values[key.strip()] = value.strip().strip("'\"")
|
||||||
|
return env_values
|
||||||
|
|
||||||
in_services = False
|
|
||||||
current_service = ""
|
|
||||||
current_labels_indent = None
|
|
||||||
|
|
||||||
for raw in lines:
|
def resolve_rule_variables(rule: str, env_values: Dict[str, str]) -> str:
|
||||||
line = raw.rstrip("\n")
|
var_re = re.compile(r"\$\{([A-Za-z_][A-Za-z0-9_]*)\}")
|
||||||
stripped = line.strip()
|
|
||||||
|
|
||||||
if stripped == "services:":
|
def replacer(match: re.Match[str]) -> str:
|
||||||
in_services = True
|
key = match.group(1)
|
||||||
current_service = ""
|
if key in os.environ:
|
||||||
current_labels_indent = None
|
return os.environ[key]
|
||||||
|
return env_values.get(key, match.group(0))
|
||||||
|
|
||||||
|
return var_re.sub(replacer, rule)
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_labels(raw_labels: Any) -> Dict[str, str]:
|
||||||
|
labels: Dict[str, str] = {}
|
||||||
|
if isinstance(raw_labels, dict):
|
||||||
|
for key, value in raw_labels.items():
|
||||||
|
labels[str(key)] = "" if value is None else str(value)
|
||||||
|
return labels
|
||||||
|
|
||||||
|
if isinstance(raw_labels, list):
|
||||||
|
for item in raw_labels:
|
||||||
|
if isinstance(item, str) and "=" in item:
|
||||||
|
key, value = item.split("=", 1)
|
||||||
|
labels[key.strip()] = value.strip()
|
||||||
|
elif isinstance(item, str):
|
||||||
|
labels[item.strip()] = ""
|
||||||
|
return labels
|
||||||
|
|
||||||
|
return labels
|
||||||
|
|
||||||
|
|
||||||
|
def infer_stack(compose_file: Path) -> str:
|
||||||
|
parts = compose_file.parts
|
||||||
|
return parts[0] if parts else "unknown"
|
||||||
|
|
||||||
|
|
||||||
|
def boolish(value: str) -> bool:
|
||||||
|
return value.strip().lower() in {"1", "true", "yes", "on"}
|
||||||
|
|
||||||
|
|
||||||
|
def parse_middlewares(raw_value: str) -> List[str]:
|
||||||
|
return [item.strip() for item in raw_value.split(",") if item.strip()]
|
||||||
|
|
||||||
|
|
||||||
|
def extract_traefik_hosts(path: Path, env_values: Dict[str, str]) -> List[Dict[str, Any]]:
|
||||||
|
try:
|
||||||
|
payload = yaml.safe_load(path.read_text(encoding="utf-8")) or {}
|
||||||
|
except yaml.YAMLError as exc:
|
||||||
|
raise RuntimeError(f"Failed to parse compose YAML in {path}: {exc}") from exc
|
||||||
|
|
||||||
|
services = payload.get("services")
|
||||||
|
if not isinstance(services, dict):
|
||||||
|
return []
|
||||||
|
|
||||||
|
entries: List[Dict[str, Any]] = []
|
||||||
|
stack = infer_stack(path)
|
||||||
|
|
||||||
|
for service_name, service_payload in services.items():
|
||||||
|
if not isinstance(service_payload, dict):
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if not in_services:
|
labels = normalize_labels(service_payload.get("labels"))
|
||||||
continue
|
router_fields: Dict[str, Dict[str, str]] = defaultdict(dict)
|
||||||
|
|
||||||
service_match = re.match(r"^(\s{2})([A-Za-z0-9_.-]+):\s*$", line)
|
for label_key, label_value in labels.items():
|
||||||
if service_match:
|
match = ROUTER_LABEL_RE.match(label_key)
|
||||||
current_service = service_match.group(2)
|
if not match:
|
||||||
current_labels_indent = None
|
continue
|
||||||
continue
|
router_name, field_name = match.groups()
|
||||||
|
router_fields[router_name][field_name] = label_value
|
||||||
|
|
||||||
if re.match(r"^\S", line):
|
for router_name, fields in router_fields.items():
|
||||||
in_services = False
|
rule = fields.get("rule", "")
|
||||||
current_service = ""
|
if not rule:
|
||||||
current_labels_indent = None
|
continue
|
||||||
continue
|
|
||||||
|
|
||||||
labels_match = re.match(r"^(\s+)labels:\s*$", line)
|
router_label_key = f"traefik.http.routers.{router_name}.rule"
|
||||||
if labels_match and current_service:
|
middlewares = parse_middlewares(fields.get("middlewares", ""))
|
||||||
current_labels_indent = len(labels_match.group(1))
|
tls_options = fields.get("tls.options", "")
|
||||||
continue
|
tls_enabled = boolish(fields.get("tls", "")) or bool(tls_options) or bool(fields.get("tls.certresolver", ""))
|
||||||
|
|
||||||
if current_labels_indent is None:
|
lowered_metadata = " ".join([tls_options, ",".join(middlewares)]).lower()
|
||||||
continue
|
uses_mtls = "mtls" in lowered_metadata
|
||||||
|
uses_authelia = "authelia" in lowered_metadata
|
||||||
|
|
||||||
indent = len(line) - len(line.lstrip(" "))
|
resolved_rule = resolve_rule_variables(rule, env_values)
|
||||||
if indent <= current_labels_indent:
|
for fqdn in parse_hosts_from_rule(resolved_rule):
|
||||||
current_labels_indent = None
|
entries.append(
|
||||||
continue
|
{
|
||||||
|
"fqdn": fqdn,
|
||||||
if "traefik.http.routers." not in line or ".rule" not in line:
|
"service": str(service_name),
|
||||||
continue
|
"stack": stack,
|
||||||
|
"source_compose_file": str(path),
|
||||||
label_value = ""
|
"router": router_name,
|
||||||
list_match = re.match(r"^\s*-\s*([\"']?)(.+)\1\s*$", stripped)
|
"router_label_keys": [router_label_key],
|
||||||
if list_match:
|
"raw_rule": rule,
|
||||||
payload = list_match.group(2)
|
"resolved_rule": resolved_rule,
|
||||||
label_value = payload.split("=", 1)[1] if "=" in payload else payload
|
"uses_tls": tls_enabled,
|
||||||
else:
|
"tls_options": tls_options,
|
||||||
map_match = re.match(r"^\s*([\"']?[^:]+\1):\s*(.+)$", line)
|
"middlewares": middlewares,
|
||||||
if map_match:
|
"uses_mtls": uses_mtls,
|
||||||
label_value = map_match.group(2).strip().strip("\"'")
|
"uses_authelia": uses_authelia,
|
||||||
|
}
|
||||||
for fqdn in parse_hosts_from_label(label_value):
|
)
|
||||||
entries.append(
|
|
||||||
{
|
|
||||||
"fqdn": fqdn,
|
|
||||||
"stack": path.parts[0],
|
|
||||||
"service": current_service,
|
|
||||||
"source_compose_file": str(path),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
return entries
|
return entries
|
||||||
|
|
||||||
@@ -157,10 +222,36 @@ def load_dynu(path: Path) -> Dict[str, List[Dict[str, str]]]:
|
|||||||
return index
|
return index
|
||||||
|
|
||||||
|
|
||||||
def write_markdown(data: Dict) -> None:
|
def is_subdomain_of_base(fqdn: str) -> bool:
|
||||||
matched = [x for x in data["inventory"] if x["status"] == "matched"]
|
return fqdn.endswith(f".{BASE_DOMAIN}")
|
||||||
missing = [x for x in data["inventory"] if x["status"] == "missing_in_dynu"]
|
|
||||||
dns_only = [x for x in data["inventory"] if x["status"] == "dns_only"]
|
|
||||||
|
def summarize_reasons(
|
||||||
|
has_traefik: bool,
|
||||||
|
has_dns: bool,
|
||||||
|
is_allowed_unmapped: bool,
|
||||||
|
is_ambiguous: bool,
|
||||||
|
is_enforced_dns_subdomain: bool,
|
||||||
|
) -> List[str]:
|
||||||
|
reasons: List[str] = []
|
||||||
|
if has_traefik and has_dns:
|
||||||
|
reasons.append("mapped")
|
||||||
|
if has_dns and not has_traefik and is_allowed_unmapped:
|
||||||
|
reasons.append("allowed_unmapped")
|
||||||
|
if has_dns and not has_traefik and is_enforced_dns_subdomain and not is_allowed_unmapped:
|
||||||
|
reasons.append("unexpected_unmapped")
|
||||||
|
if has_dns and not has_traefik:
|
||||||
|
reasons.append("dns_only")
|
||||||
|
if has_traefik and not has_dns:
|
||||||
|
reasons.append("traefik_only")
|
||||||
|
if is_ambiguous:
|
||||||
|
reasons.append("duplicate_mapping")
|
||||||
|
reasons.append("ambiguous_mapping")
|
||||||
|
return reasons
|
||||||
|
|
||||||
|
|
||||||
|
def write_markdown(data: Dict[str, Any]) -> None:
|
||||||
|
inventory = data["inventory"]
|
||||||
|
|
||||||
lines = [
|
lines = [
|
||||||
"# DNS Inventory (Dynu + Traefik)",
|
"# DNS Inventory (Dynu + Traefik)",
|
||||||
@@ -175,38 +266,60 @@ def write_markdown(data: Dict) -> None:
|
|||||||
"",
|
"",
|
||||||
f"- Traefik hostnames discovered: **{data['summary']['traefik_hostnames']}**",
|
f"- Traefik hostnames discovered: **{data['summary']['traefik_hostnames']}**",
|
||||||
f"- Dynu hostnames discovered: **{data['summary']['dynu_hostnames']}**",
|
f"- Dynu hostnames discovered: **{data['summary']['dynu_hostnames']}**",
|
||||||
f"- Matched: **{data['summary']['matched']}**",
|
f"- Mapped hostnames: **{data['summary']['mapped_hostnames']}**",
|
||||||
f"- Missing in Dynu: **{data['summary']['missing_in_dynu']}**",
|
f"- DNS-only hostnames: **{data['summary']['dns_only_hostnames']}**",
|
||||||
f"- Dynu DNS only: **{data['summary']['dns_only']}**",
|
f"- Traefik-only hostnames: **{data['summary']['traefik_only_hostnames']}**",
|
||||||
f"- Duplicate Traefik hostnames: **{data['summary']['duplicate_traefik_hostnames']}**",
|
f"- Ambiguous hostnames: **{len(data['validation']['ambiguous_hostnames'])}**",
|
||||||
"",
|
"",
|
||||||
"## Dynu Records",
|
"## Validation",
|
||||||
|
"",
|
||||||
|
f"- Validation ok: **{str(data['validation']['validation_ok']).lower()}**",
|
||||||
|
f"- Allowed unmapped hostnames: `{', '.join(data['validation']['allowed_unmapped_hostnames'])}`",
|
||||||
|
f"- Unexpected unmapped hostnames: **{len(data['validation']['unexpected_unmapped_hostnames'])}**",
|
||||||
|
f"- Duplicate hostnames: **{len(data['validation']['duplicate_hostnames'])}**",
|
||||||
|
f"- Ambiguous hostnames: **{len(data['validation']['ambiguous_hostnames'])}**",
|
||||||
"",
|
"",
|
||||||
"| Hostname | Type | Value | TTL |",
|
|
||||||
"|---|---|---|---|",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
for row in data["dynu_records_table"]:
|
def bullet_list(title: str, values: Iterable[str]) -> None:
|
||||||
lines.append(f"| `{row['hostname']}` | `{row['type']}` | `{row['value']}` | `{row['ttl']}` |")
|
rows = list(values)
|
||||||
|
lines.extend([f"### {title}", ""])
|
||||||
lines.extend(["", "## Correlation", "", "| Hostname | Status | Service(s) | Source compose file(s) | DNS records |", "|---|---|---|---|---|"])
|
|
||||||
for row in data["inventory"]:
|
|
||||||
svc = ", ".join(sorted({f"{e['stack']}/{e['service']}" for e in row.get('traefik_entries', [])})) or "-"
|
|
||||||
src = ", ".join(sorted({e['source_compose_file'] for e in row.get('traefik_entries', [])})) or "-"
|
|
||||||
dns = ", ".join([f"{r['type']}:{r['value']}" for r in row.get("dynu_records", [])]) or "-"
|
|
||||||
lines.append(f"| `{row['fqdn']}` | `{row['status']}` | {svc} | {src} | {dns} |")
|
|
||||||
|
|
||||||
def section(title: str, rows: List[Dict]) -> None:
|
|
||||||
lines.extend(["", f"## {title}", ""])
|
|
||||||
if not rows:
|
if not rows:
|
||||||
lines.append("_None._")
|
lines.append("_None._")
|
||||||
return
|
else:
|
||||||
for row in rows:
|
for value in rows:
|
||||||
lines.append(f"- `{row['fqdn']}`")
|
lines.append(f"- `{value}`")
|
||||||
|
lines.append("")
|
||||||
|
|
||||||
section("Matched records", matched)
|
bullet_list("Allowed unmapped hostnames", data["validation"]["allowed_unmapped_hostnames"])
|
||||||
section("Traefik hostnames missing in Dynu", missing)
|
bullet_list("Unexpected unmapped hostnames", data["validation"]["unexpected_unmapped_hostnames"])
|
||||||
section("Dynu DNS records not mapped to known Traefik services", dns_only)
|
bullet_list("Duplicate hostnames", data["validation"]["duplicate_hostnames"])
|
||||||
|
bullet_list("Ambiguous hostnames", data["validation"]["ambiguous_hostnames"])
|
||||||
|
|
||||||
|
lines.extend(
|
||||||
|
[
|
||||||
|
"## Correlation",
|
||||||
|
"",
|
||||||
|
"| Hostname | Status | Reasons | Service(s) | Route metadata | DNS records |",
|
||||||
|
"|---|---|---|---|---|---|",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
for row in inventory:
|
||||||
|
services = sorted({f"{entry['stack']}/{entry['service']}" for entry in row["traefik_entries"]})
|
||||||
|
service_cell = ", ".join(services) if services else "-"
|
||||||
|
reason_cell = ", ".join(row["reasons"]) if row["reasons"] else "-"
|
||||||
|
|
||||||
|
route_chunks = []
|
||||||
|
for entry in row["traefik_entries"]:
|
||||||
|
middlewares = ",".join(entry.get("middlewares", [])) or "-"
|
||||||
|
route_chunks.append(
|
||||||
|
f"{entry['router']} [tls={str(entry['uses_tls']).lower()}, mtls={str(entry['uses_mtls']).lower()}, authelia={str(entry['uses_authelia']).lower()}, tls_options={entry.get('tls_options') or '-'}, middlewares={middlewares}]"
|
||||||
|
)
|
||||||
|
route_cell = "<br>".join(route_chunks) if route_chunks else "-"
|
||||||
|
|
||||||
|
dns_cell = ", ".join(f"{item['type']}:{item['value']}" for item in row["dynu_records"]) if row["dynu_records"] else "-"
|
||||||
|
lines.append(f"| `{row['fqdn']}` | `{row['status']}` | `{reason_cell}` | {service_cell} | {route_cell} | {dns_cell} |")
|
||||||
|
|
||||||
OUT_MD.parent.mkdir(parents=True, exist_ok=True)
|
OUT_MD.parent.mkdir(parents=True, exist_ok=True)
|
||||||
OUT_MD.write_text("\n".join(lines) + "\n", encoding="utf-8")
|
OUT_MD.write_text("\n".join(lines) + "\n", encoding="utf-8")
|
||||||
@@ -227,43 +340,79 @@ def main() -> int:
|
|||||||
dynu_index = load_dynu(DYN_DATA)
|
dynu_index = load_dynu(DYN_DATA)
|
||||||
|
|
||||||
repo_root = Path(__file__).resolve().parents[2]
|
repo_root = Path(__file__).resolve().parents[2]
|
||||||
hosts = []
|
env_values = load_env_defaults(repo_root)
|
||||||
|
hosts: List[Dict[str, Any]] = []
|
||||||
for cf in compose_files(repo_root):
|
for cf in compose_files(repo_root):
|
||||||
hosts.extend(extract_traefik_hosts(cf.relative_to(repo_root)))
|
hosts.extend(extract_traefik_hosts(cf.relative_to(repo_root), env_values))
|
||||||
|
|
||||||
by_fqdn: Dict[str, List[Dict[str, str]]] = defaultdict(list)
|
by_fqdn: Dict[str, List[Dict[str, Any]]] = defaultdict(list)
|
||||||
for entry in hosts:
|
for entry in hosts:
|
||||||
if entry["fqdn"].endswith(BASE_DOMAIN):
|
if entry["fqdn"] == BASE_DOMAIN or is_subdomain_of_base(entry["fqdn"]):
|
||||||
by_fqdn[entry["fqdn"]].append(entry)
|
by_fqdn[entry["fqdn"]].append(entry)
|
||||||
|
|
||||||
duplicate_hosts = {k for k, v in by_fqdn.items() if len(v) > 1}
|
duplicate_hostnames = sorted(k for k, v in by_fqdn.items() if len(v) > 1)
|
||||||
|
|
||||||
combined_fqdns = sorted(set(by_fqdn.keys()) | set(dynu_index.keys()))
|
combined_fqdns = sorted(set(by_fqdn.keys()) | set(dynu_index.keys()))
|
||||||
inventory = []
|
inventory = []
|
||||||
|
ambiguous_hostnames: List[str] = []
|
||||||
|
|
||||||
for fqdn in combined_fqdns:
|
for fqdn in combined_fqdns:
|
||||||
traefik_entries = sorted(
|
traefik_entries = sorted(
|
||||||
by_fqdn.get(fqdn, []),
|
by_fqdn.get(fqdn, []),
|
||||||
key=lambda x: (x["stack"], x["service"], x["source_compose_file"]),
|
key=lambda x: (x["stack"], x["service"], x["source_compose_file"], x["router"]),
|
||||||
)
|
)
|
||||||
dns_records = dynu_index.get(fqdn, [])
|
dns_records = dynu_index.get(fqdn, [])
|
||||||
|
|
||||||
if traefik_entries and dns_records:
|
is_allowed_unmapped = fqdn in ALLOWED_UNMAPPED_HOSTNAMES
|
||||||
status = "matched"
|
has_traefik = bool(traefik_entries)
|
||||||
elif traefik_entries and not dns_records:
|
has_dns = bool(dns_records)
|
||||||
status = "missing_in_dynu"
|
|
||||||
else:
|
service_keys = {f"{item['stack']}/{item['service']}" for item in traefik_entries}
|
||||||
|
is_ambiguous = len(service_keys) > 1
|
||||||
|
if is_ambiguous:
|
||||||
|
ambiguous_hostnames.append(fqdn)
|
||||||
|
|
||||||
|
is_enforced_dns_subdomain = is_subdomain_of_base(fqdn)
|
||||||
|
|
||||||
|
if has_traefik and has_dns:
|
||||||
|
status = "mapped"
|
||||||
|
elif has_dns and is_allowed_unmapped:
|
||||||
|
status = "allowed_unmapped"
|
||||||
|
elif has_dns and not has_traefik and is_enforced_dns_subdomain:
|
||||||
|
status = "unexpected_unmapped"
|
||||||
|
elif has_dns and not has_traefik:
|
||||||
status = "dns_only"
|
status = "dns_only"
|
||||||
|
else:
|
||||||
|
status = "traefik_only"
|
||||||
|
|
||||||
|
reasons = summarize_reasons(
|
||||||
|
has_traefik, has_dns, is_allowed_unmapped, is_ambiguous, is_enforced_dns_subdomain
|
||||||
|
)
|
||||||
|
|
||||||
inventory.append(
|
inventory.append(
|
||||||
{
|
{
|
||||||
"fqdn": fqdn,
|
"fqdn": fqdn,
|
||||||
"status": status,
|
"status": status,
|
||||||
"duplicate": fqdn in duplicate_hosts,
|
"reasons": reasons,
|
||||||
|
"duplicate": fqdn in duplicate_hostnames,
|
||||||
"traefik_entries": traefik_entries,
|
"traefik_entries": traefik_entries,
|
||||||
"dynu_records": dns_records,
|
"dynu_records": dns_records,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
subdomain_dns_hosts = sorted(host for host in dynu_index if is_subdomain_of_base(host))
|
||||||
|
unexpected_unmapped_hostnames = sorted(
|
||||||
|
host for host in subdomain_dns_hosts if host not in by_fqdn and host not in ALLOWED_UNMAPPED_HOSTNAMES
|
||||||
|
)
|
||||||
|
|
||||||
|
validation = {
|
||||||
|
"allowed_unmapped_hostnames": sorted(ALLOWED_UNMAPPED_HOSTNAMES),
|
||||||
|
"unexpected_unmapped_hostnames": unexpected_unmapped_hostnames,
|
||||||
|
"duplicate_hostnames": duplicate_hostnames,
|
||||||
|
"ambiguous_hostnames": sorted(set(ambiguous_hostnames)),
|
||||||
|
"validation_ok": len(unexpected_unmapped_hostnames) == 0,
|
||||||
|
}
|
||||||
|
|
||||||
dynu_rows = []
|
dynu_rows = []
|
||||||
for fqdn in sorted(dynu_index.keys()):
|
for fqdn in sorted(dynu_index.keys()):
|
||||||
for rec in dynu_index[fqdn]:
|
for rec in dynu_index[fqdn]:
|
||||||
@@ -285,11 +434,11 @@ def main() -> int:
|
|||||||
"summary": {
|
"summary": {
|
||||||
"traefik_hostnames": len(by_fqdn),
|
"traefik_hostnames": len(by_fqdn),
|
||||||
"dynu_hostnames": len(dynu_index),
|
"dynu_hostnames": len(dynu_index),
|
||||||
"matched": sum(1 for x in inventory if x["status"] == "matched"),
|
"mapped_hostnames": sum(1 for x in inventory if x["status"] == "mapped"),
|
||||||
"missing_in_dynu": sum(1 for x in inventory if x["status"] == "missing_in_dynu"),
|
"dns_only_hostnames": sum(1 for x in inventory if "dns_only" in x["reasons"]),
|
||||||
"dns_only": sum(1 for x in inventory if x["status"] == "dns_only"),
|
"traefik_only_hostnames": sum(1 for x in inventory if x["status"] == "traefik_only"),
|
||||||
"duplicate_traefik_hostnames": len(duplicate_hosts),
|
|
||||||
},
|
},
|
||||||
|
"validation": validation,
|
||||||
"inventory": inventory,
|
"inventory": inventory,
|
||||||
"dynu_records_table": dynu_rows,
|
"dynu_records_table": dynu_rows,
|
||||||
}
|
}
|
||||||
@@ -300,6 +449,15 @@ def main() -> int:
|
|||||||
|
|
||||||
print(f"Wrote {OUT_JSON}")
|
print(f"Wrote {OUT_JSON}")
|
||||||
print(f"Wrote {OUT_MD}")
|
print(f"Wrote {OUT_MD}")
|
||||||
|
|
||||||
|
if os.environ.get("DYNU_ENFORCE_VALIDATION") == "true" and not validation["validation_ok"]:
|
||||||
|
print(
|
||||||
|
"Validation failed: unexpected unmapped hostnames were found: "
|
||||||
|
+ ", ".join(validation["unexpected_unmapped_hostnames"]),
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return 4
|
||||||
|
|
||||||
return 0
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user