Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| de9da29027 | |||
| 72ea500342 | |||
| f754c575d7 | |||
| a092d00312 |
@@ -38,8 +38,8 @@ def main(argv: list[str] | None = None) -> int:
|
|||||||
help="launch broker: 'stub' records requests; 'docker' runs containers",
|
help="launch broker: 'stub' records requests; 'docker' runs containers",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--sidecar-image", default=None,
|
"--sidecar", action="store_true",
|
||||||
help="if set, run one consolidated per-host sidecar from this image",
|
help="run one consolidated per-host sidecar bundle (build-if-missing)",
|
||||||
)
|
)
|
||||||
args = parser.parse_args(argv)
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
@@ -51,10 +51,11 @@ def main(argv: list[str] | None = None) -> int:
|
|||||||
# anything; 'docker' runs real containers (firecracker drops in later).
|
# anything; 'docker' runs real containers (firecracker drops in later).
|
||||||
secret = secrets.token_bytes(32)
|
secret = secrets.token_bytes(32)
|
||||||
broker: LaunchBroker = DockerBroker(secret) if args.broker == "docker" else StubBroker(secret)
|
broker: LaunchBroker = DockerBroker(secret) if args.broker == "docker" else StubBroker(secret)
|
||||||
sidecar: Sidecar | None = DockerSidecar(args.sidecar_image) if args.sidecar_image else None
|
sidecar: Sidecar | None = DockerSidecar() if args.sidecar else None
|
||||||
orchestrator = Orchestrator(registry, broker, secret, sidecar)
|
orchestrator = Orchestrator(registry, broker, secret, sidecar)
|
||||||
|
|
||||||
# One persistent per-host sidecar, shared by every bottle (idempotent).
|
# One persistent per-host sidecar, shared by every bottle: build the
|
||||||
|
# bundle image if missing, then bring the singleton up (idempotent).
|
||||||
if sidecar is not None:
|
if sidecar is not None:
|
||||||
orchestrator.ensure_sidecar()
|
orchestrator.ensure_sidecar()
|
||||||
log.info("consolidated sidecar ensured", context={"name": sidecar.name})
|
log.info("consolidated sidecar ensured", context={"name": sidecar.name})
|
||||||
|
|||||||
@@ -8,9 +8,13 @@ vsock / unix-socket portability caveats):
|
|||||||
GET /sidecar -> 200 {"configured", ["name","running"]}
|
GET /sidecar -> 200 {"configured", ["name","running"]}
|
||||||
GET /bottles -> 200 {"bottles": [ <redacted record>, ...]}
|
GET /bottles -> 200 {"bottles": [ <redacted record>, ...]}
|
||||||
POST /bottles -> 201 {"bottle_id","identity_token"} (launch)
|
POST /bottles -> 201 {"bottle_id","identity_token"} (launch)
|
||||||
body: {"source_ip", ["image_ref"], ["metadata"]}
|
body: {"source_ip", ["image_ref"],
|
||||||
|
["metadata"], ["policy"]}
|
||||||
|
PUT /bottles/<bottle_id>/policy -> 200 {"updated": true} | 404 (live reload)
|
||||||
|
body: {"policy"}
|
||||||
DELETE /bottles/<bottle_id> -> 200 {"torn_down": true} | 404 (teardown)
|
DELETE /bottles/<bottle_id> -> 200 {"torn_down": true} | 404 (teardown)
|
||||||
POST /attribute -> 200 {"bottle_id"} | 403
|
POST /attribute -> 200 {"bottle_id"} | 403
|
||||||
|
POST /resolve -> 200 {"bottle_id","policy"} | 403
|
||||||
body: {"source_ip","identity_token"}
|
body: {"source_ip","identity_token"}
|
||||||
|
|
||||||
`POST /bottles` / `DELETE` drive the full launch lifecycle: they mint (or
|
`POST /bottles` / `DELETE` drive the full launch lifecycle: they mint (or
|
||||||
@@ -49,7 +53,7 @@ def _parse_json_object(body: bytes) -> Json:
|
|||||||
return obj
|
return obj
|
||||||
|
|
||||||
|
|
||||||
def dispatch( # pylint: disable=too-many-return-statements
|
def dispatch( # pylint: disable=too-many-return-statements,too-many-branches
|
||||||
orch: Orchestrator, method: str, path: str, body: bytes
|
orch: Orchestrator, method: str, path: str, body: bytes
|
||||||
) -> tuple[int, Json]:
|
) -> tuple[int, Json]:
|
||||||
"""Route one control-plane request to a (status, payload) pair. Pure —
|
"""Route one control-plane request to a (status, payload) pair. Pure —
|
||||||
@@ -75,20 +79,35 @@ def dispatch( # pylint: disable=too-many-return-statements
|
|||||||
return 400, {"error": "source_ip (string) is required"}
|
return 400, {"error": "source_ip (string) is required"}
|
||||||
image_ref = data.get("image_ref")
|
image_ref = data.get("image_ref")
|
||||||
metadata = data.get("metadata")
|
metadata = data.get("metadata")
|
||||||
|
policy = data.get("policy")
|
||||||
rec = orch.launch_bottle(
|
rec = orch.launch_bottle(
|
||||||
source_ip,
|
source_ip,
|
||||||
image_ref=image_ref if isinstance(image_ref, str) else "",
|
image_ref=image_ref if isinstance(image_ref, str) else "",
|
||||||
metadata=metadata if isinstance(metadata, str) else "",
|
metadata=metadata if isinstance(metadata, str) else "",
|
||||||
|
policy=policy if isinstance(policy, str) else "",
|
||||||
)
|
)
|
||||||
return 201, {"bottle_id": rec.bottle_id, "identity_token": rec.identity_token}
|
return 201, {"bottle_id": rec.bottle_id, "identity_token": rec.identity_token}
|
||||||
|
|
||||||
|
if method == "PUT" and route.startswith("/bottles/") and route.endswith("/policy"):
|
||||||
|
bottle_id = route[len("/bottles/"):-len("/policy")]
|
||||||
|
try:
|
||||||
|
data = _parse_json_object(body)
|
||||||
|
except ValueError as e:
|
||||||
|
return 400, {"error": f"invalid JSON: {e}"}
|
||||||
|
policy = data.get("policy")
|
||||||
|
if not isinstance(policy, str):
|
||||||
|
return 400, {"error": "policy (string) is required"}
|
||||||
|
if orch.set_policy(bottle_id, policy):
|
||||||
|
return 200, {"updated": True}
|
||||||
|
return 404, {"error": "no such bottle"}
|
||||||
|
|
||||||
if method == "DELETE" and route.startswith("/bottles/"):
|
if method == "DELETE" and route.startswith("/bottles/"):
|
||||||
bottle_id = route[len("/bottles/"):]
|
bottle_id = route[len("/bottles/"):]
|
||||||
if orch.teardown_bottle(bottle_id):
|
if orch.teardown_bottle(bottle_id):
|
||||||
return 200, {"torn_down": True}
|
return 200, {"torn_down": True}
|
||||||
return 404, {"error": "no such bottle"}
|
return 404, {"error": "no such bottle"}
|
||||||
|
|
||||||
if method == "POST" and route == "/attribute":
|
if method == "POST" and route in ("/attribute", "/resolve"):
|
||||||
try:
|
try:
|
||||||
data = _parse_json_object(body)
|
data = _parse_json_object(body)
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
@@ -100,6 +119,11 @@ def dispatch( # pylint: disable=too-many-return-statements
|
|||||||
rec = orch.attribute(source_ip, token)
|
rec = orch.attribute(source_ip, token)
|
||||||
if rec is None:
|
if rec is None:
|
||||||
return 403, {"error": "unattributed"}
|
return 403, {"error": "unattributed"}
|
||||||
|
# /attribute is the lightweight identity check; /resolve additionally
|
||||||
|
# returns the bottle's policy — the source-IP-keyed lookup the
|
||||||
|
# multi-tenant sidecar makes per request.
|
||||||
|
if route == "/resolve":
|
||||||
|
return 200, {"bottle_id": rec.bottle_id, "policy": rec.policy}
|
||||||
return 200, {"bottle_id": rec.bottle_id}
|
return 200, {"bottle_id": rec.bottle_id}
|
||||||
|
|
||||||
return 404, {"error": "not found"}
|
return 404, {"error": "not found"}
|
||||||
@@ -134,6 +158,9 @@ class Handler(http.server.BaseHTTPRequestHandler):
|
|||||||
def do_POST(self) -> None:
|
def do_POST(self) -> None:
|
||||||
self._serve("POST")
|
self._serve("POST")
|
||||||
|
|
||||||
|
def do_PUT(self) -> None:
|
||||||
|
self._serve("PUT")
|
||||||
|
|
||||||
def do_DELETE(self) -> None:
|
def do_DELETE(self) -> None:
|
||||||
self._serve("DELETE")
|
self._serve("DELETE")
|
||||||
|
|
||||||
|
|||||||
@@ -64,9 +64,13 @@ class BottleRecord:
|
|||||||
identity_token: str
|
identity_token: str
|
||||||
state: str = "active"
|
state: str = "active"
|
||||||
created_at: float = 0.0
|
created_at: float = 0.0
|
||||||
# Opaque JSON blob for forward-compat (policy refs, pool slot, ...) —
|
# Opaque JSON blob for forward-compat (pool slot, ...) — the registry
|
||||||
# the registry doesn't interpret it, so new fields need no migration.
|
# doesn't interpret it, so new fields need no migration.
|
||||||
metadata: str = ""
|
metadata: str = ""
|
||||||
|
# The bottle's sidecar policy (opaque JSON — egress allowlist / routes /
|
||||||
|
# git config). The registry stores and serves it verbatim, keyed by
|
||||||
|
# source IP; the multi-tenant sidecar interprets it.
|
||||||
|
policy: str = ""
|
||||||
|
|
||||||
def redacted(self) -> dict[str, object]:
|
def redacted(self) -> dict[str, object]:
|
||||||
"""Public view for listing — never exposes the identity token."""
|
"""Public view for listing — never exposes the identity token."""
|
||||||
@@ -76,6 +80,7 @@ class BottleRecord:
|
|||||||
"state": self.state,
|
"state": self.state,
|
||||||
"created_at": self.created_at,
|
"created_at": self.created_at,
|
||||||
"metadata": self.metadata,
|
"metadata": self.metadata,
|
||||||
|
"policy": self.policy,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -97,6 +102,10 @@ _MIGRATIONS = TableMigrations(
|
|||||||
# the "one active bottle per source IP" check cheap.
|
# the "one active bottle per source IP" check cheap.
|
||||||
"CREATE INDEX IF NOT EXISTS idx_orchestrator_bottles_source_ip "
|
"CREATE INDEX IF NOT EXISTS idx_orchestrator_bottles_source_ip "
|
||||||
"ON orchestrator_bottles (source_ip)",
|
"ON orchestrator_bottles (source_ip)",
|
||||||
|
# v3 — per-bottle policy (opaque JSON the sidecar interprets): the
|
||||||
|
# egress allowlist / routes / git config selected by source IP. The
|
||||||
|
# multi-tenant sidecar resolves it per request via `attribute`.
|
||||||
|
"ALTER TABLE orchestrator_bottles ADD COLUMN policy TEXT NOT NULL DEFAULT ''",
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -110,6 +119,7 @@ def _row_to_record(row: sqlite3.Row) -> BottleRecord:
|
|||||||
state=row["state"],
|
state=row["state"],
|
||||||
created_at=row["created_at"],
|
created_at=row["created_at"],
|
||||||
metadata=row["metadata"],
|
metadata=row["metadata"],
|
||||||
|
policy=row["policy"],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -136,6 +146,7 @@ class RegistryStore(DbStore):
|
|||||||
bottle_id: str | None = None,
|
bottle_id: str | None = None,
|
||||||
identity_token: str | None = None,
|
identity_token: str | None = None,
|
||||||
metadata: str = "",
|
metadata: str = "",
|
||||||
|
policy: str = "",
|
||||||
) -> BottleRecord:
|
) -> BottleRecord:
|
||||||
"""Register (or replace) a bottle. Mints a bottle_id / identity token
|
"""Register (or replace) a bottle. Mints a bottle_id / identity token
|
||||||
when not supplied. Live — this is the control-plane reload path."""
|
when not supplied. Live — this is the control-plane reload path."""
|
||||||
@@ -146,12 +157,13 @@ class RegistryStore(DbStore):
|
|||||||
state="active",
|
state="active",
|
||||||
created_at=time.time(),
|
created_at=time.time(),
|
||||||
metadata=metadata,
|
metadata=metadata,
|
||||||
|
policy=policy,
|
||||||
)
|
)
|
||||||
with self._connect() as conn:
|
with self._connect() as conn:
|
||||||
conn.execute(
|
conn.execute(
|
||||||
"INSERT OR REPLACE INTO orchestrator_bottles "
|
"INSERT OR REPLACE INTO orchestrator_bottles "
|
||||||
"(bottle_id, source_ip, identity_token, state, created_at, metadata) "
|
"(bottle_id, source_ip, identity_token, state, created_at, metadata, policy) "
|
||||||
"VALUES (?, ?, ?, ?, ?, ?)",
|
"VALUES (?, ?, ?, ?, ?, ?, ?)",
|
||||||
(
|
(
|
||||||
rec.bottle_id,
|
rec.bottle_id,
|
||||||
rec.source_ip,
|
rec.source_ip,
|
||||||
@@ -159,11 +171,23 @@ class RegistryStore(DbStore):
|
|||||||
rec.state,
|
rec.state,
|
||||||
rec.created_at,
|
rec.created_at,
|
||||||
rec.metadata,
|
rec.metadata,
|
||||||
|
rec.policy,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
self._chmod()
|
self._chmod()
|
||||||
return rec
|
return rec
|
||||||
|
|
||||||
|
def set_policy(self, bottle_id: str, policy: str) -> bool:
|
||||||
|
"""Update a bottle's policy in place (live reload). Returns True if
|
||||||
|
the bottle exists."""
|
||||||
|
with self._connect() as conn:
|
||||||
|
cur = conn.execute(
|
||||||
|
"UPDATE orchestrator_bottles SET policy = ? WHERE bottle_id = ?",
|
||||||
|
(policy, bottle_id),
|
||||||
|
)
|
||||||
|
self._chmod()
|
||||||
|
return cur.rowcount > 0
|
||||||
|
|
||||||
def deregister(self, bottle_id: str) -> bool:
|
def deregister(self, bottle_id: str) -> bool:
|
||||||
"""Remove a bottle. Returns True if a row was deleted."""
|
"""Remove a bottle. Returns True if a row was deleted."""
|
||||||
with self._connect() as conn:
|
with self._connect() as conn:
|
||||||
|
|||||||
@@ -46,10 +46,12 @@ class Orchestrator:
|
|||||||
image_ref: str = "",
|
image_ref: str = "",
|
||||||
slot: int | None = None,
|
slot: int | None = None,
|
||||||
metadata: str = "",
|
metadata: str = "",
|
||||||
|
policy: str = "",
|
||||||
) -> BottleRecord:
|
) -> BottleRecord:
|
||||||
"""Register a bottle and broker its launch. Rolls the registry entry
|
"""Register a bottle (with its sidecar policy) and broker its launch.
|
||||||
back if the launch doesn't take, so a failure leaves no orphan."""
|
Rolls the registry entry back if the launch doesn't take, so a
|
||||||
rec = self.registry.register(source_ip, metadata=metadata)
|
failure leaves no orphan."""
|
||||||
|
rec = self.registry.register(source_ip, metadata=metadata, policy=policy)
|
||||||
req = LaunchRequest(
|
req = LaunchRequest(
|
||||||
op="launch",
|
op="launch",
|
||||||
bottle_id=rec.bottle_id,
|
bottle_id=rec.bottle_id,
|
||||||
@@ -77,15 +79,23 @@ class Orchestrator:
|
|||||||
return True
|
return True
|
||||||
|
|
||||||
def attribute(self, source_ip: str, identity_token: str) -> BottleRecord | None:
|
def attribute(self, source_ip: str, identity_token: str) -> BottleRecord | None:
|
||||||
"""Fail-closed attribution (delegates to the registry)."""
|
"""Fail-closed attribution (delegates to the registry). The returned
|
||||||
|
record carries the bottle's `policy` — this is the source-IP-keyed
|
||||||
|
resolution the multi-tenant sidecar makes per request."""
|
||||||
return self.registry.attribute(source_ip, identity_token)
|
return self.registry.attribute(source_ip, identity_token)
|
||||||
|
|
||||||
|
def set_policy(self, bottle_id: str, policy: str) -> bool:
|
||||||
|
"""Update a bottle's sidecar policy in place (live reload). False if
|
||||||
|
the bottle is unknown."""
|
||||||
|
return self.registry.set_policy(bottle_id, policy)
|
||||||
|
|
||||||
# --- consolidated sidecar ----------------------------------------------
|
# --- consolidated sidecar ----------------------------------------------
|
||||||
|
|
||||||
def ensure_sidecar(self) -> None:
|
def ensure_sidecar(self) -> None:
|
||||||
"""Bring the single per-host sidecar up (idempotent). No-op when no
|
"""Ensure the single per-host sidecar is built and up (idempotent).
|
||||||
sidecar is configured."""
|
No-op when no sidecar is configured."""
|
||||||
if self._sidecar is not None:
|
if self._sidecar is not None:
|
||||||
|
self._sidecar.ensure_built()
|
||||||
self._sidecar.ensure_running()
|
self._sidecar.ensure_running()
|
||||||
|
|
||||||
def sidecar_status(self) -> dict[str, object]:
|
def sidecar_status(self) -> dict[str, object]:
|
||||||
|
|||||||
@@ -18,15 +18,25 @@ launches never spawn N sidecars.
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import abc
|
import abc
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
from ..docker_cmd import run_docker
|
from ..docker_cmd import run_docker
|
||||||
|
|
||||||
SIDECAR_NAME = "bot-bottle-orch-sidecar"
|
SIDECAR_NAME = "bot-bottle-orch-sidecar"
|
||||||
SIDECAR_LABEL = "bot-bottle-orch-sidecar=1"
|
SIDECAR_LABEL = "bot-bottle-orch-sidecar=1"
|
||||||
|
|
||||||
|
# The real sidecar-bundle image + its Dockerfile. Kept as a local constant
|
||||||
|
# rather than imported from backend.docker.sidecar_bundle, which would drag
|
||||||
|
# the whole backend layer into the lean orchestrator (see #359); unify when
|
||||||
|
# that lands. Env override matches the backend's BOT_BOTTLE_SIDECAR_IMAGE.
|
||||||
|
SIDECAR_BUNDLE_IMAGE = os.environ.get("BOT_BOTTLE_SIDECAR_IMAGE", "bot-bottle-sidecars:latest")
|
||||||
|
SIDECAR_DOCKERFILE = "Dockerfile.sidecars"
|
||||||
|
_REPO_ROOT = Path(__file__).resolve().parents[2]
|
||||||
|
|
||||||
|
|
||||||
class SidecarError(Exception):
|
class SidecarError(Exception):
|
||||||
"""The shared sidecar failed to start/stop (non-zero `docker` exit)."""
|
"""The shared sidecar failed to build/start/stop (non-zero `docker` exit)."""
|
||||||
|
|
||||||
|
|
||||||
class Sidecar(abc.ABC):
|
class Sidecar(abc.ABC):
|
||||||
@@ -34,10 +44,16 @@ class Sidecar(abc.ABC):
|
|||||||
|
|
||||||
name: str
|
name: str
|
||||||
|
|
||||||
|
def ensure_built(self) -> None:
|
||||||
|
"""Ensure the sidecar's image / rootfs exists, building it if needed.
|
||||||
|
Default: nothing to build (e.g. a stub or a pre-pulled image)."""
|
||||||
|
return
|
||||||
|
|
||||||
@abc.abstractmethod
|
@abc.abstractmethod
|
||||||
def ensure_running(self) -> None:
|
def ensure_running(self) -> None:
|
||||||
"""Start the sidecar if it isn't already up. Idempotent: a no-op
|
"""Start the sidecar if it isn't already up. Idempotent: a no-op
|
||||||
when it's already running (that's the whole point — one per host)."""
|
when it's already running (that's the whole point — one per host).
|
||||||
|
Assumes the image exists — call `ensure_built()` first."""
|
||||||
|
|
||||||
@abc.abstractmethod
|
@abc.abstractmethod
|
||||||
def is_running(self) -> bool:
|
def is_running(self) -> bool:
|
||||||
@@ -49,11 +65,43 @@ class Sidecar(abc.ABC):
|
|||||||
|
|
||||||
|
|
||||||
class DockerSidecar(Sidecar):
|
class DockerSidecar(Sidecar):
|
||||||
"""The consolidated sidecar as a single, fixed-name Docker container."""
|
"""The consolidated sidecar as a single, fixed-name Docker container.
|
||||||
|
|
||||||
def __init__(self, image_ref: str, *, name: str = SIDECAR_NAME) -> None:
|
`image_ref` defaults to the real sidecar-bundle image; `ensure_built`
|
||||||
|
builds it from `Dockerfile.sidecars` when it's missing. (Note: slice 5
|
||||||
|
builds + launches the bundle container; wiring its per-bottle,
|
||||||
|
source-IP-keyed config is a later slice — see PRD 0070.)"""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
image_ref: str = SIDECAR_BUNDLE_IMAGE,
|
||||||
|
*,
|
||||||
|
name: str = SIDECAR_NAME,
|
||||||
|
build_context: Path | None = None,
|
||||||
|
dockerfile: str | None = SIDECAR_DOCKERFILE,
|
||||||
|
) -> None:
|
||||||
self.image_ref = image_ref
|
self.image_ref = image_ref
|
||||||
self.name = name
|
self.name = name
|
||||||
|
self._build_context = build_context or _REPO_ROOT
|
||||||
|
self._dockerfile = dockerfile
|
||||||
|
|
||||||
|
def image_exists(self) -> bool:
|
||||||
|
return run_docker(["docker", "image", "inspect", self.image_ref]).returncode == 0
|
||||||
|
|
||||||
|
def ensure_built(self) -> None:
|
||||||
|
"""Build the bundle image from its Dockerfile when it's missing.
|
||||||
|
No-op when the image is already present, or when no dockerfile is
|
||||||
|
configured (e.g. a pre-pulled image)."""
|
||||||
|
if self._dockerfile is None or self.image_exists():
|
||||||
|
return
|
||||||
|
proc = run_docker([
|
||||||
|
"docker", "build",
|
||||||
|
"-t", self.image_ref,
|
||||||
|
"-f", str(self._build_context / self._dockerfile),
|
||||||
|
str(self._build_context),
|
||||||
|
])
|
||||||
|
if proc.returncode != 0:
|
||||||
|
raise SidecarError(f"sidecar image build failed: {proc.stderr.strip()}")
|
||||||
|
|
||||||
def is_running(self) -> bool:
|
def is_running(self) -> bool:
|
||||||
proc = run_docker([
|
proc = run_docker([
|
||||||
@@ -85,4 +133,7 @@ class DockerSidecar(Sidecar):
|
|||||||
raise SidecarError(f"sidecar failed to stop: {proc.stderr.strip()}")
|
raise SidecarError(f"sidecar failed to stop: {proc.stderr.strip()}")
|
||||||
|
|
||||||
|
|
||||||
__all__ = ["Sidecar", "DockerSidecar", "SidecarError", "SIDECAR_NAME", "SIDECAR_LABEL"]
|
__all__ = [
|
||||||
|
"Sidecar", "DockerSidecar", "SidecarError",
|
||||||
|
"SIDECAR_NAME", "SIDECAR_LABEL", "SIDECAR_BUNDLE_IMAGE",
|
||||||
|
]
|
||||||
|
|||||||
@@ -0,0 +1,75 @@
|
|||||||
|
"""Sidecar-side per-client policy resolver (PRD 0070).
|
||||||
|
|
||||||
|
The consolidated sidecar serves every bottle from one process, so for each
|
||||||
|
request it must apply the *calling* bottle's policy, selected by the source
|
||||||
|
IP the attribution invariant makes unspoofable. This resolves that policy
|
||||||
|
from the orchestrator's control plane (`POST /resolve`), keyed on the
|
||||||
|
`(source_ip, identity_token)` pair.
|
||||||
|
|
||||||
|
**Always fresh — no cache.** The resolver is called rarely enough that a
|
||||||
|
round-trip doesn't matter, and correctness matters more than speed: every
|
||||||
|
resolve reflects the orchestrator's *current* view, so a revocation, a
|
||||||
|
policy change, or a bottle teardown the orchestrator knows about is honored
|
||||||
|
immediately rather than lingering for a cache TTL. (If this ever becomes a
|
||||||
|
hot path, add caching with orchestrator-driven invalidation — not a blind
|
||||||
|
TTL.)
|
||||||
|
|
||||||
|
**Fail-closed:** an unattributed client (the orchestrator answers `403`)
|
||||||
|
resolves to `None`, and the caller (the egress addon, git-gate) must then
|
||||||
|
deny — exactly as an unknown bottle should be treated. Orchestrator
|
||||||
|
*errors* (unreachable / unexpected status) raise, so the caller can fail
|
||||||
|
closed too rather than silently serving stale or empty policy.
|
||||||
|
|
||||||
|
The resolved value is the policy blob the orchestrator stores verbatim; the
|
||||||
|
consumer parses it (e.g. the egress addon's `load_config`). This module is
|
||||||
|
stdlib-only and free of bot-bottle imports so it can be COPYed flat into
|
||||||
|
the sidecar bundle.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import urllib.error
|
||||||
|
import urllib.request
|
||||||
|
|
||||||
|
DEFAULT_TIMEOUT_SECONDS = 2.0
|
||||||
|
|
||||||
|
|
||||||
|
class PolicyResolveError(RuntimeError):
|
||||||
|
"""The orchestrator was unreachable or returned an unexpected status —
|
||||||
|
distinct from a clean `403` (unattributed), which returns None."""
|
||||||
|
|
||||||
|
|
||||||
|
class PolicyResolver:
|
||||||
|
"""Resolves each client's policy from the orchestrator, fresh per call."""
|
||||||
|
|
||||||
|
def __init__(self, base_url: str, *, timeout: float = DEFAULT_TIMEOUT_SECONDS) -> None:
|
||||||
|
self._base = base_url.rstrip("/")
|
||||||
|
self._timeout = timeout
|
||||||
|
|
||||||
|
def resolve(self, source_ip: str, identity_token: str) -> str | None:
|
||||||
|
"""The calling bottle's policy blob, or None if unattributed. Always
|
||||||
|
fetches from the orchestrator so revocations / changes / teardowns
|
||||||
|
are honored immediately. Raises `PolicyResolveError` if the
|
||||||
|
orchestrator can't be reached / errors."""
|
||||||
|
body = json.dumps(
|
||||||
|
{"source_ip": source_ip, "identity_token": identity_token}
|
||||||
|
).encode()
|
||||||
|
req = urllib.request.Request(
|
||||||
|
f"{self._base}/resolve", data=body, method="POST",
|
||||||
|
headers={"Content-Type": "application/json"},
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
with urllib.request.urlopen(req, timeout=self._timeout) as resp:
|
||||||
|
payload = json.loads(resp.read())
|
||||||
|
except urllib.error.HTTPError as e:
|
||||||
|
if e.code == 403:
|
||||||
|
return None # unattributed → fail closed (caller denies)
|
||||||
|
raise PolicyResolveError(f"/resolve returned HTTP {e.code}") from e
|
||||||
|
except (urllib.error.URLError, TimeoutError, OSError, ValueError) as e:
|
||||||
|
raise PolicyResolveError(f"/resolve unreachable or malformed: {e}") from e
|
||||||
|
policy = payload.get("policy") if isinstance(payload, dict) else None
|
||||||
|
return policy if isinstance(policy, str) else ""
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["PolicyResolver", "PolicyResolveError"]
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
"""Integration: DockerSidecar.image_exists reflects real docker state.
|
||||||
|
|
||||||
|
Gated on a reachable Docker daemon. Deliberately does NOT build the full
|
||||||
|
sidecar bundle (a heavy, slow image build) — it exercises the `image_exists`
|
||||||
|
primitive that `ensure_built` gates on, against a tiny pulled image and a
|
||||||
|
name that can't exist.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
from bot_bottle.orchestrator.sidecar import DockerSidecar
|
||||||
|
from tests._docker import skip_unless_docker
|
||||||
|
|
||||||
|
IMAGE = "busybox"
|
||||||
|
|
||||||
|
|
||||||
|
@skip_unless_docker()
|
||||||
|
class TestDockerSidecarImageExists(unittest.TestCase):
|
||||||
|
def test_image_exists_true_for_present_false_for_absent(self) -> None:
|
||||||
|
# Ensure the tiny image is present (build_if_missing is disabled here
|
||||||
|
# so this never triggers a Dockerfile.sidecars build).
|
||||||
|
subprocess.run(
|
||||||
|
["docker", "pull", IMAGE],
|
||||||
|
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, check=False,
|
||||||
|
)
|
||||||
|
self.assertTrue(DockerSidecar(IMAGE, dockerfile=None).image_exists())
|
||||||
|
self.assertFalse(
|
||||||
|
DockerSidecar("bot-bottle-nonexistent:doesnotexist", dockerfile=None).image_exists()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
@@ -123,6 +123,54 @@ class TestDispatch(unittest.TestCase):
|
|||||||
self.assertEqual(200, status)
|
self.assertEqual(200, status)
|
||||||
self.assertEqual(False, payload["configured"])
|
self.assertEqual(False, payload["configured"])
|
||||||
|
|
||||||
|
def test_launch_stores_policy_and_resolve_returns_it(self) -> None:
|
||||||
|
_, reg = dispatch(
|
||||||
|
self.orch, "POST", "/bottles",
|
||||||
|
_body({"source_ip": "10.243.0.5", "policy": '{"a":1}'}),
|
||||||
|
)
|
||||||
|
status, payload = dispatch(
|
||||||
|
self.orch, "POST", "/resolve",
|
||||||
|
_body({"source_ip": "10.243.0.5", "identity_token": reg["identity_token"]}),
|
||||||
|
)
|
||||||
|
self.assertEqual(200, status)
|
||||||
|
self.assertEqual(reg["bottle_id"], payload["bottle_id"])
|
||||||
|
self.assertEqual('{"a":1}', payload["policy"])
|
||||||
|
|
||||||
|
def test_resolve_forbidden_on_bad_token(self) -> None:
|
||||||
|
dispatch(self.orch, "POST", "/bottles", _body({"source_ip": "10.243.0.5"}))
|
||||||
|
status, _ = dispatch(
|
||||||
|
self.orch, "POST", "/resolve",
|
||||||
|
_body({"source_ip": "10.243.0.5", "identity_token": "nope"}),
|
||||||
|
)
|
||||||
|
self.assertEqual(403, status)
|
||||||
|
|
||||||
|
def test_put_policy_updates_live(self) -> None:
|
||||||
|
_, reg = dispatch(self.orch, "POST", "/bottles", _body({"source_ip": "10.243.0.1"}))
|
||||||
|
bid = reg["bottle_id"]
|
||||||
|
status, payload = dispatch(
|
||||||
|
self.orch, "PUT", f"/bottles/{bid}/policy", _body({"policy": '{"v":9}'})
|
||||||
|
)
|
||||||
|
self.assertEqual(200, status)
|
||||||
|
self.assertEqual(True, payload["updated"])
|
||||||
|
_, resolved = dispatch(
|
||||||
|
self.orch, "POST", "/resolve",
|
||||||
|
_body({"source_ip": "10.243.0.1", "identity_token": reg["identity_token"]}),
|
||||||
|
)
|
||||||
|
self.assertEqual('{"v":9}', resolved["policy"])
|
||||||
|
|
||||||
|
def test_put_policy_missing_bottle_404(self) -> None:
|
||||||
|
status, _ = dispatch(
|
||||||
|
self.orch, "PUT", "/bottles/ghost/policy", _body({"policy": "{}"})
|
||||||
|
)
|
||||||
|
self.assertEqual(404, status)
|
||||||
|
|
||||||
|
def test_put_policy_requires_string(self) -> None:
|
||||||
|
_, reg = dispatch(self.orch, "POST", "/bottles", _body({"source_ip": "10.243.0.1"}))
|
||||||
|
status, _ = dispatch(
|
||||||
|
self.orch, "PUT", f"/bottles/{reg['bottle_id']}/policy", _body({})
|
||||||
|
)
|
||||||
|
self.assertEqual(400, status)
|
||||||
|
|
||||||
|
|
||||||
class TestServerRoundTrip(unittest.TestCase):
|
class TestServerRoundTrip(unittest.TestCase):
|
||||||
def test_http_register_health_attribute(self) -> None:
|
def test_http_register_health_attribute(self) -> None:
|
||||||
|
|||||||
@@ -97,6 +97,30 @@ class TestRegistryStore(unittest.TestCase):
|
|||||||
self.assertNotIn("identity_token", rec.redacted())
|
self.assertNotIn("identity_token", rec.redacted())
|
||||||
self.assertEqual("10.243.0.1", rec.redacted()["source_ip"])
|
self.assertEqual("10.243.0.1", rec.redacted()["source_ip"])
|
||||||
|
|
||||||
|
def test_register_with_policy_resolves_via_attribution(self) -> None:
|
||||||
|
rec = self.store.register("10.243.0.1", policy='{"allow":["x"]}')
|
||||||
|
self.assertEqual('{"allow":["x"]}', rec.policy)
|
||||||
|
got = self.store.attribute("10.243.0.1", rec.identity_token)
|
||||||
|
assert got is not None
|
||||||
|
self.assertEqual('{"allow":["x"]}', got.policy)
|
||||||
|
|
||||||
|
def test_set_policy_updates_live(self) -> None:
|
||||||
|
rec = self.store.register("10.243.0.1")
|
||||||
|
self.assertEqual("", rec.policy)
|
||||||
|
self.assertTrue(self.store.set_policy(rec.bottle_id, '{"v":2}'))
|
||||||
|
got = self.store.get(rec.bottle_id)
|
||||||
|
assert got is not None
|
||||||
|
self.assertEqual('{"v":2}', got.policy)
|
||||||
|
|
||||||
|
def test_set_policy_missing_is_false(self) -> None:
|
||||||
|
self.assertFalse(self.store.set_policy("ghost", "{}"))
|
||||||
|
|
||||||
|
def test_policy_defaults_empty_and_persists(self) -> None:
|
||||||
|
rec = self.store.register("10.243.0.1")
|
||||||
|
got = RegistryStore(self.db).get(rec.bottle_id)
|
||||||
|
assert got is not None
|
||||||
|
self.assertEqual("", got.policy)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|||||||
@@ -30,8 +30,12 @@ class _FakeSidecar(Sidecar):
|
|||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
self.name = "fake-sidecar"
|
self.name = "fake-sidecar"
|
||||||
self.ensured = 0
|
self.ensured = 0
|
||||||
|
self.built = 0
|
||||||
self._running = False
|
self._running = False
|
||||||
|
|
||||||
|
def ensure_built(self) -> None:
|
||||||
|
self.built += 1
|
||||||
|
|
||||||
def ensure_running(self) -> None:
|
def ensure_running(self) -> None:
|
||||||
self.ensured += 1
|
self.ensured += 1
|
||||||
self._running = True
|
self._running = True
|
||||||
@@ -82,6 +86,22 @@ class TestOrchestrator(unittest.TestCase):
|
|||||||
def test_teardown_unknown_is_false(self) -> None:
|
def test_teardown_unknown_is_false(self) -> None:
|
||||||
self.assertFalse(self.orch.teardown_bottle("ghost"))
|
self.assertFalse(self.orch.teardown_bottle("ghost"))
|
||||||
|
|
||||||
|
def test_launch_with_policy_is_resolvable(self) -> None:
|
||||||
|
rec = self.orch.launch_bottle("10.243.0.1", policy='{"routes":[]}')
|
||||||
|
got = self.orch.attribute("10.243.0.1", rec.identity_token)
|
||||||
|
assert got is not None
|
||||||
|
self.assertEqual('{"routes":[]}', got.policy)
|
||||||
|
|
||||||
|
def test_set_policy_live_reload(self) -> None:
|
||||||
|
rec = self.orch.launch_bottle("10.243.0.3")
|
||||||
|
self.assertTrue(self.orch.set_policy(rec.bottle_id, '{"x":1}'))
|
||||||
|
got = self.orch.attribute("10.243.0.3", rec.identity_token)
|
||||||
|
assert got is not None
|
||||||
|
self.assertEqual('{"x":1}', got.policy)
|
||||||
|
|
||||||
|
def test_set_policy_unknown_is_false(self) -> None:
|
||||||
|
self.assertFalse(self.orch.set_policy("ghost", "{}"))
|
||||||
|
|
||||||
def test_launch_rolls_back_registry_on_broker_failure(self) -> None:
|
def test_launch_rolls_back_registry_on_broker_failure(self) -> None:
|
||||||
orch = Orchestrator(self.store, _FailingBroker(self.secret), self.secret)
|
orch = Orchestrator(self.store, _FailingBroker(self.secret), self.secret)
|
||||||
with self.assertRaises(RuntimeError):
|
with self.assertRaises(RuntimeError):
|
||||||
@@ -100,7 +120,8 @@ class TestOrchestrator(unittest.TestCase):
|
|||||||
orch.sidecar_status(),
|
orch.sidecar_status(),
|
||||||
)
|
)
|
||||||
orch.ensure_sidecar()
|
orch.ensure_sidecar()
|
||||||
self.assertEqual(1, sc.ensured)
|
self.assertEqual(1, sc.built) # ensure_sidecar builds first,
|
||||||
|
self.assertEqual(1, sc.ensured) # then runs
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
{"configured": True, "name": "fake-sidecar", "running": True},
|
{"configured": True, "name": "fake-sidecar", "running": True},
|
||||||
orch.sidecar_status(),
|
orch.sidecar_status(),
|
||||||
|
|||||||
@@ -75,5 +75,55 @@ class TestDockerSidecar(unittest.TestCase):
|
|||||||
self.sc.stop()
|
self.sc.stop()
|
||||||
|
|
||||||
|
|
||||||
|
class TestDockerSidecarBuild(unittest.TestCase):
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self.sc = DockerSidecar() # defaults to the real bundle image + dockerfile
|
||||||
|
|
||||||
|
def test_image_exists_reads_docker_inspect(self) -> None:
|
||||||
|
with patch(_RUN_DOCKER, return_value=_proc(returncode=0)):
|
||||||
|
self.assertTrue(self.sc.image_exists())
|
||||||
|
with patch(_RUN_DOCKER, return_value=_proc(returncode=1)):
|
||||||
|
self.assertFalse(self.sc.image_exists())
|
||||||
|
|
||||||
|
def test_ensure_built_is_noop_when_image_present(self) -> None:
|
||||||
|
with patch(_RUN_DOCKER, return_value=_proc(returncode=0)) as m:
|
||||||
|
self.sc.ensure_built()
|
||||||
|
self.assertEqual(1, m.call_count) # only the image-inspect probe
|
||||||
|
|
||||||
|
def test_ensure_built_builds_from_dockerfile_when_missing(self) -> None:
|
||||||
|
calls: list[list[str]] = []
|
||||||
|
|
||||||
|
def fake(argv: list[str]) -> Mock:
|
||||||
|
calls.append(argv)
|
||||||
|
if argv[:3] == ["docker", "image", "inspect"]:
|
||||||
|
return _proc(returncode=1) # missing
|
||||||
|
return _proc()
|
||||||
|
|
||||||
|
with patch(_RUN_DOCKER, side_effect=fake):
|
||||||
|
self.sc.ensure_built()
|
||||||
|
|
||||||
|
builds = [c for c in calls if c[:2] == ["docker", "build"]]
|
||||||
|
self.assertEqual(1, len(builds))
|
||||||
|
self.assertIn(self.sc.image_ref, builds[0])
|
||||||
|
self.assertIn("-f", builds[0])
|
||||||
|
self.assertTrue(any(a.endswith("Dockerfile.sidecars") for a in builds[0]))
|
||||||
|
|
||||||
|
def test_ensure_built_noop_when_no_dockerfile(self) -> None:
|
||||||
|
sc = DockerSidecar("busybox", dockerfile=None)
|
||||||
|
with patch(_RUN_DOCKER) as m:
|
||||||
|
sc.ensure_built()
|
||||||
|
m.assert_not_called()
|
||||||
|
|
||||||
|
def test_ensure_built_raises_on_build_failure(self) -> None:
|
||||||
|
def fake(argv: list[str]) -> Mock:
|
||||||
|
if argv[:3] == ["docker", "image", "inspect"]:
|
||||||
|
return _proc(returncode=1)
|
||||||
|
return _proc(returncode=1, stderr="build boom")
|
||||||
|
|
||||||
|
with patch(_RUN_DOCKER, side_effect=fake):
|
||||||
|
with self.assertRaises(SidecarError):
|
||||||
|
self.sc.ensure_built()
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|||||||
@@ -0,0 +1,71 @@
|
|||||||
|
"""Unit tests for the sidecar-side PolicyResolver (PRD 0070). HTTP mocked."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import unittest
|
||||||
|
import urllib.error
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
from bot_bottle.policy_resolver import PolicyResolveError, PolicyResolver
|
||||||
|
|
||||||
|
_URLOPEN = "bot_bottle.policy_resolver.urllib.request.urlopen"
|
||||||
|
|
||||||
|
|
||||||
|
def _resp(payload: object) -> MagicMock:
|
||||||
|
"""A urlopen() return value: a context manager whose read() yields JSON."""
|
||||||
|
m = MagicMock()
|
||||||
|
m.__enter__.return_value.read.return_value = json.dumps(payload).encode()
|
||||||
|
return m
|
||||||
|
|
||||||
|
|
||||||
|
def _http_error(code: int) -> urllib.error.HTTPError:
|
||||||
|
return urllib.error.HTTPError("http://x/resolve", code, "err", {}, None) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
|
||||||
|
class TestPolicyResolver(unittest.TestCase):
|
||||||
|
def setUp(self) -> None:
|
||||||
|
self.r = PolicyResolver("http://orch:8080")
|
||||||
|
|
||||||
|
def test_resolve_returns_policy(self) -> None:
|
||||||
|
with patch(_URLOPEN, return_value=_resp({"bottle_id": "b1", "policy": "P"})):
|
||||||
|
self.assertEqual("P", self.r.resolve("10.243.0.1", "tok"))
|
||||||
|
|
||||||
|
def test_resolve_always_fetches_fresh(self) -> None:
|
||||||
|
# No cache — every resolve hits the orchestrator so revocations /
|
||||||
|
# policy changes are honored immediately.
|
||||||
|
with patch(_URLOPEN, return_value=_resp({"policy": "P"})) as m:
|
||||||
|
self.r.resolve("10.243.0.1", "tok")
|
||||||
|
self.r.resolve("10.243.0.1", "tok")
|
||||||
|
self.assertEqual(2, m.call_count)
|
||||||
|
|
||||||
|
def test_unattributed_403_is_none_fail_closed(self) -> None:
|
||||||
|
with patch(_URLOPEN, side_effect=_http_error(403)):
|
||||||
|
self.assertIsNone(self.r.resolve("10.243.0.9", "tok"))
|
||||||
|
|
||||||
|
def test_other_http_error_raises(self) -> None:
|
||||||
|
with patch(_URLOPEN, side_effect=_http_error(500)):
|
||||||
|
with self.assertRaises(PolicyResolveError):
|
||||||
|
self.r.resolve("10.243.0.1", "tok")
|
||||||
|
|
||||||
|
def test_unreachable_raises(self) -> None:
|
||||||
|
with patch(_URLOPEN, side_effect=urllib.error.URLError("refused")):
|
||||||
|
with self.assertRaises(PolicyResolveError):
|
||||||
|
self.r.resolve("10.243.0.1", "tok")
|
||||||
|
|
||||||
|
def test_missing_policy_field_is_empty(self) -> None:
|
||||||
|
with patch(_URLOPEN, return_value=_resp({"bottle_id": "b1"})):
|
||||||
|
self.assertEqual("", self.r.resolve("10.243.0.1", "tok"))
|
||||||
|
|
||||||
|
def test_posts_source_ip_and_token(self) -> None:
|
||||||
|
with patch(_URLOPEN, return_value=_resp({"policy": "P"})) as m:
|
||||||
|
self.r.resolve("10.243.0.7", "the-token")
|
||||||
|
req = m.call_args.args[0]
|
||||||
|
self.assertTrue(req.full_url.endswith("/resolve"))
|
||||||
|
sent = json.loads(req.data)
|
||||||
|
self.assertEqual("10.243.0.7", sent["source_ip"])
|
||||||
|
self.assertEqual("the-token", sent["identity_token"])
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
Reference in New Issue
Block a user