phlo-traefik 0.1.0__tar.gz

phlo_traefik-0.1.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: phlo-traefik
+Version: 0.1.0
+Summary: Traefik service plugin for Phlo
+Author-email: Phlo Team <team@phlo.dev>
+License: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/plain
+Requires-Dist: phlo>=0.1.0
+Requires-Dist: pyyaml>=6.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+
+Traefik service plugin for Phlo.

phlo_traefik-0.1.0/README.md

@@ -0,0 +1,52 @@
+# phlo-traefik
+
+Traefik reverse proxy service plugin for Phlo.
+
+## Overview
+
+Provides local reverse proxy for accessing Phlo services by hostname:
+- `http://dagster.phlo.localhost`
+- `http://minio.phlo.localhost`
+- `http://trino.phlo.localhost`
+
+## Usage
+
+```bash
+phlo services start --service traefik
+open http://dagster.phlo.localhost
+```
+
+## Configuration
+
+| Environment Variable | Default | Description |
+|---------------------|---------|-------------|
+| `TRAEFIK_HTTP_PORT` | `80` | Host port for Traefik HTTP entrypoint |
+| `TRAEFIK_DOMAIN` | `phlo.localhost` | Base domain for service hostnames |
+
+## Routed Services
+
+The following services are automatically routed when Traefik is enabled:
+
+| Hostname | Service | Port |
+|----------|---------|------|
+| `dagster.phlo.localhost` | Dagster | 3000 |
+| `minio.phlo.localhost` | MinIO Console | 9001 |
+| `minio-api.phlo.localhost` | MinIO API | 9000 |
+| `trino.phlo.localhost` | Trino | 8080 |
+| `nessie.phlo.localhost` | Nessie | 19120 |
+| `clickhouse.phlo.localhost` | ClickHouse | 8123 |
+| `api.phlo.localhost` | Phlo API | 4000 |
+| `traefik.phlo.localhost` | Traefik Dashboard | (internal) |
+
+## Troubleshooting
+
+### Port 80 already in use
+
+If port 80 is already in use on your machine, set a custom port:
+
+```bash
+# In .phlo/.env.local
+TRAEFIK_HTTP_PORT=8088
+```
+
+Then access services with the port: `http://dagster.phlo.localhost:8088`

phlo_traefik-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "phlo-traefik"
+version = "0.1.0"
+description = "Traefik service plugin for Phlo"
+readme = {text = "Traefik service plugin for Phlo.", content-type = "text/plain"}
+requires-python = ">=3.11"
+authors = [
+    {name = "Phlo Team", email = "team@phlo.dev"},
+]
+license = {text = "MIT"}
+dependencies = [
+    "phlo>=0.1.0",
+    "pyyaml>=6.0.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "ruff>=0.1.0",
+]
+
+[project.entry-points."phlo.plugins.services"]
+traefik = "phlo_traefik.plugin:TraefikServicePlugin"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+phlo_traefik = ["service.yaml"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"

phlo_traefik-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

phlo_traefik-0.1.0/src/phlo_traefik/__init__.py

@@ -0,0 +1 @@
+"""Traefik service plugin."""

phlo_traefik-0.1.0/src/phlo_traefik/plugin.py

@@ -0,0 +1,31 @@
+"""Traefik service plugin."""
+
+from __future__ import annotations
+
+from importlib import resources
+from typing import Any
+
+import yaml
+
+from phlo.plugins import PluginMetadata, ServicePlugin
+
+
+class TraefikServicePlugin(ServicePlugin):
+    """Service plugin for Traefik reverse proxy."""
+
+    @property
+    def metadata(self) -> PluginMetadata:
+        """Return plugin metadata for Traefik service registration."""
+        return PluginMetadata(
+            name="traefik",
+            version="0.1.0",
+            description="Local reverse proxy for named service URLs",
+            author="Phlo Team",
+            tags=["networking", "proxy", "traefik"],
+        )
+
+    @property
+    def service_definition(self) -> dict[str, Any]:
+        """Load and return the Traefik service definition."""
+        service_path = resources.files("phlo_traefik").joinpath("service.yaml")
+        return yaml.safe_load(service_path.read_text(encoding="utf-8"))

phlo_traefik-0.1.0/src/phlo_traefik/service.yaml

@@ -0,0 +1,32 @@
+name: traefik
+description: Local reverse proxy for named service URLs
+category: networking
+default: false
+profile: proxy
+
+image: traefik:v3.3
+
+compose:
+  restart: unless-stopped
+  command:
+    - "--providers.docker=true"
+    - "--providers.docker.exposedbydefault=false"
+    - "--entrypoints.web.address=:80"
+    - "--api.dashboard=true"
+  ports:
+    - "${TRAEFIK_HTTP_PORT:-80}:80"
+  volumes:
+    - "/var/run/docker.sock:/var/run/docker.sock:ro"
+  labels:
+    traefik.enable: "true"
+    traefik.http.routers.traefik.rule: "Host(`traefik.${TRAEFIK_DOMAIN:-phlo.localhost}`)"
+    traefik.http.routers.traefik.service: "api@internal"
+    traefik.http.routers.traefik.entrypoints: "web"
+
+env_vars:
+  TRAEFIK_HTTP_PORT:
+    default: 80
+    description: Host port for Traefik HTTP entrypoint
+  TRAEFIK_DOMAIN:
+    default: phlo.localhost
+    description: Base domain used to build service hostnames

phlo_traefik-0.1.0/src/phlo_traefik/settings.py

@@ -0,0 +1,6 @@
+"""Traefik settings."""
+
+from __future__ import annotations
+
+TRAEFIK_HTTP_PORT_DEFAULT = 80
+TRAEFIK_DOMAIN_DEFAULT = "phlo.localhost"

phlo_traefik-0.1.0/src/phlo_traefik.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: phlo-traefik
+Version: 0.1.0
+Summary: Traefik service plugin for Phlo
+Author-email: Phlo Team <team@phlo.dev>
+License: MIT
+Requires-Python: >=3.11
+Description-Content-Type: text/plain
+Requires-Dist: phlo>=0.1.0
+Requires-Dist: pyyaml>=6.0.1
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+
+Traefik service plugin for Phlo.

phlo_traefik-0.1.0/src/phlo_traefik.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+src/phlo_traefik/__init__.py
+src/phlo_traefik/plugin.py
+src/phlo_traefik/service.yaml
+src/phlo_traefik/settings.py
+src/phlo_traefik.egg-info/PKG-INFO
+src/phlo_traefik.egg-info/SOURCES.txt
+src/phlo_traefik.egg-info/dependency_links.txt
+src/phlo_traefik.egg-info/entry_points.txt
+src/phlo_traefik.egg-info/requires.txt
+src/phlo_traefik.egg-info/top_level.txt
+tests/test_traefik_plugin.py

phlo_traefik-0.1.0/src/phlo_traefik.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

phlo_traefik-0.1.0/src/phlo_traefik.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[phlo.plugins.services]
+traefik = phlo_traefik.plugin:TraefikServicePlugin

phlo_traefik-0.1.0/src/phlo_traefik.egg-info/requires.txt

@@ -0,0 +1,6 @@
+phlo>=0.1.0
+pyyaml>=6.0.1
+
+[dev]
+pytest>=7.0
+ruff>=0.1.0

phlo_traefik-0.1.0/src/phlo_traefik.egg-info/top_level.txt

@@ -0,0 +1 @@
+phlo_traefik

phlo_traefik-0.1.0/tests/test_traefik_plugin.py

@@ -0,0 +1,21 @@
+"""Tests for Traefik service plugin."""
+
+from phlo_traefik.plugin import TraefikServicePlugin
+
+
+def test_traefik_service_definition():
+    """Validate Traefik service definition defaults."""
+    plugin = TraefikServicePlugin()
+    defn = plugin.service_definition
+
+    assert defn["name"] == "traefik"
+    assert defn["profile"] == "proxy"
+
+
+def test_traefik_plugin_metadata():
+    """Validate Traefik plugin metadata."""
+    plugin = TraefikServicePlugin()
+    meta = plugin.metadata
+
+    assert meta.name == "traefik"
+    assert "networking" in meta.tags