7005b22bcf
Chunk 3 of the host-control-server stack: grow the broker op vocabulary
(PRD gap 3), starting with `list_live`, and invert `reconcile` onto it.
- broker: split the closed op vocabulary into mutation (`launch`/`teardown`,
carry a bottle id + static flags) and query (`list_live`, carries nothing
but its op name) kinds. `verify_request` now enforces a **strict schema**
(open question 1, resolved yes): unknown claim keys are rejected, a mutation
must name its bottle, and a query that smuggles any id/flag is refused.
- broker verb: `LaunchBroker.list_live` / `SubmitBroker.list_live` return the
backend's live source IPs; a backend enumeration failure is converted to the
single `BrokerUnavailableError` "live set unknown" signal. `DockerBroker`
enumerates its labelled containers; `StubBroker` derives from launches (or a
test override).
- host controller: `POST /broker/live` verifies a signed `list_live` token and
returns `{source_ips}`; `BrokerClient.list_live` is its drop-in client.
- reconcile: `OrchestratorCore.reconcile()` drops the `live_source_ips`
parameter and pulls the live set from the broker itself — the tell that the
orchestrator couldn't see the backend goes away. **Fail-safe**: if the broker
can't return an authoritative set the sweep is skipped, never run against an
empty/partial set (which would reap healthy rows). The `/reconcile` HTTP
contract + `OrchestratorClient.reconcile` become a bare trigger.
The macOS launcher's Apple-container enumeration stays for now; it becomes the
host controller's `list_live` when launch itself moves behind the broker (the
pulled-forward chunk 5, next in the stack).
Tests + pyright clean; pylint 10.0 on broker.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
218 lines
9.1 KiB
Python
218 lines
9.1 KiB
Python
"""Consolidated bottle launch sequence for the macOS backend (PRD 0070).
|
|
|
|
The docker backend allocates a free address, pins the agent to it with
|
|
`--ip`, registers it, *then* starts the agent — registration precedes launch
|
|
because the pinned address is known up front.
|
|
|
|
**Apple Container 1.0.0 has no `--ip`.** The `--network` flag takes only
|
|
`<name>[,mac=…][,mtu=…]`; the address is assigned by vmnet's DHCP and is
|
|
knowable only once the container is running. So the macOS order inverts:
|
|
|
|
ensure_gateway() -> caller starts the agent -> register_agent(source_ip)
|
|
|
|
That is why this module exposes two functions where docker has one — the
|
|
caller has to start the agent in between. `ensure_gateway` runs first because
|
|
the agent's proxy env needs the gateway's address at `container run` time; the
|
|
agent's *own* address (the attribution key) only exists afterwards.
|
|
|
|
The control plane and the gateway are **separate containers** here (see
|
|
`infra`): the orchestrator on the host-only control network, the gateway on the
|
|
agent network — `gateway_ip` is the gateway container's agent-network address,
|
|
distinct from the orchestrator's control-network host.
|
|
|
|
The consequence for the identity token: it is minted by registration, i.e.
|
|
*after* the agent container exists, so it cannot be baked into the run-time
|
|
env the way docker's compose spec does. It is delivered at `container exec`
|
|
time instead — see `bottle.MacosContainerBottle`.
|
|
|
|
That delivery is load-bearing, not a nicety: `/resolve` requires a matching
|
|
`(source_ip, identity_token)` pair and fail-closes with no source-IP-only
|
|
fallback (#366). So egress that does not carry the token is denied — which is
|
|
the safe direction, and is why the agent's init process is a bare `sleep` and
|
|
every real command arrives through `container exec`.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
|
|
from ...egress import EgressPlan
|
|
from ...git_gate import GitGatePlan
|
|
from ...log import info
|
|
from ...orchestrator.client import OrchestratorClient, OrchestratorClientError
|
|
from ...orchestrator.reprovision import reprovision_bottles
|
|
from ...orchestrator.store.secret_store import ENV_VAR_SECRET_NAME
|
|
from ..provision_bottle import deprovision_bottle, provision_bottle
|
|
from . import util as container_mod
|
|
from .enumerate import CONTAINER_NAME_PREFIX, EnumerationError, enumerate_active
|
|
from .gateway import GATEWAY_NETWORK
|
|
from .gateway_transport import MacosGatewayTransport
|
|
from .infra import MacosInfraService, OrchestratorStartError
|
|
|
|
|
|
class ConsolidatedLaunchError(RuntimeError):
|
|
"""The consolidated register/provision sequence could not complete."""
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class GatewayEndpoint:
|
|
"""What the agent `container run` needs to reach the shared gateway.
|
|
`gateway_ip` is the gateway container's agent-network address (the agent's
|
|
proxy target); `orchestrator_url` points at the separate control plane."""
|
|
|
|
orchestrator_url: str
|
|
gateway_ip: str # the gateway's address — the agent's proxy target
|
|
gateway_ca_pem: str # the shared CA the provisioner installs
|
|
network: str # the shared host-only network to attach to
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class LaunchContext:
|
|
"""What the running agent needs once it has been registered."""
|
|
|
|
bottle_id: str
|
|
identity_token: str
|
|
source_ip: str # the agent's DHCP-assigned address (attribution key)
|
|
gateway_ip: str
|
|
network: str
|
|
orchestrator_url: str
|
|
env_var_secret: str = "" # encryption key injected into the agent's env
|
|
|
|
|
|
def ensure_gateway(
|
|
*, service: MacosInfraService | None = None,
|
|
) -> GatewayEndpoint:
|
|
"""Ensure the per-host pair (orchestrator + gateway containers) is up and
|
|
report how to reach the gateway. Idempotent — one singleton pair, so N bottle
|
|
launches share it. Call before starting the agent container: the agent's
|
|
proxy env needs `gateway_ip` at run time."""
|
|
service = service or MacosInfraService()
|
|
orchestrator_url = service.ensure_running()
|
|
endpoint = GatewayEndpoint(
|
|
orchestrator_url=orchestrator_url,
|
|
gateway_ip=service.gateway().address(),
|
|
gateway_ca_pem=service.ca_cert_pem(),
|
|
network=service.network,
|
|
)
|
|
_reprovision_running_bottles(endpoint)
|
|
return endpoint
|
|
|
|
|
|
def _reprovision_running_bottles(endpoint: GatewayEndpoint) -> None:
|
|
"""Recover keys from live Apple containers and restore gateway tokens."""
|
|
try:
|
|
secrets_by_ip: dict[str, str] = {}
|
|
for agent in enumerate_active():
|
|
name = f"{CONTAINER_NAME_PREFIX}{agent.slug}"
|
|
source_ip = container_mod.inspect_container_network_ip(name, endpoint.network)
|
|
if not source_ip:
|
|
continue
|
|
secret = container_mod.read_container_env(name, ENV_VAR_SECRET_NAME)
|
|
if secret:
|
|
secrets_by_ip[source_ip] = secret
|
|
count = reprovision_bottles(
|
|
OrchestratorClient(endpoint.orchestrator_url), secrets_by_ip,
|
|
)
|
|
if count:
|
|
info(f"reprovisioned egress tokens for {count} macOS bottle(s)")
|
|
except (OrchestratorClientError, EnumerationError, OSError) as exc:
|
|
info(f"egress token reprovision skipped: {exc}")
|
|
|
|
|
|
def live_source_ips(network: str) -> list[str]:
|
|
"""Every running agent container's address on `network`.
|
|
|
|
The reconciliation input: the orchestrator lives inside the infra
|
|
container and cannot enumerate the host's containers, so the host has to
|
|
tell it which bottles are actually up. Containers that have not been
|
|
assigned an address yet contribute nothing — the reap's grace window, not
|
|
this list, is what protects an in-flight launch.
|
|
|
|
Raises `EnumerationError` when the live set cannot be determined
|
|
authoritatively: either the container listing fails or any individual
|
|
inspect fails. Callers must skip reconciliation in that case to avoid
|
|
unregistering healthy bottles."""
|
|
ips: list[str] = []
|
|
for agent in enumerate_active():
|
|
name = f"{CONTAINER_NAME_PREFIX}{agent.slug}"
|
|
ip = container_mod.inspect_container_network_ip(name, network)
|
|
if ip is None:
|
|
raise EnumerationError(
|
|
f"container inspect {name!r} failed; live set is not authoritative"
|
|
)
|
|
if ip:
|
|
ips.append(ip)
|
|
return ips
|
|
|
|
|
|
def register_agent(
|
|
egress_plan: EgressPlan,
|
|
git_gate_plan: GitGatePlan,
|
|
*,
|
|
source_ip: str,
|
|
endpoint: GatewayEndpoint,
|
|
image_ref: str = "",
|
|
tokens: dict[str, str] | None = None,
|
|
env_var_secret: str | None = None,
|
|
) -> LaunchContext:
|
|
"""Register the (already running) agent by its address and provision its
|
|
git-gate state into the gateway. `source_ip` must be read from the live
|
|
container — it is the attribution key the gateway resolves policy by.
|
|
Raises on failure; the caller tears down."""
|
|
client = OrchestratorClient(endpoint.orchestrator_url)
|
|
# Self-heal before registering: a launcher that died hard (SIGKILL, closed
|
|
# terminal, host sleep) never ran its teardown callback, leaving an active
|
|
# row with no container. vmnet recycles addresses, so such a row can
|
|
# collide with this bottle's — and `by_source_ip` fail-closes on ambiguity,
|
|
# which would resolve no policy at all and deny every host. Best-effort: a
|
|
# reconciliation failure must not block an otherwise-fine launch.
|
|
#
|
|
# The orchestrator now pulls the live set from the broker itself, so this is
|
|
# a bare trigger. Until macOS moves onto the host controller (the follow-up
|
|
# that routes launch through the broker), the orchestrator's broker is the
|
|
# stub, whose live set is the bottles it recorded launches for — so the sweep
|
|
# only under-reaps (leaves an orphan a cycle longer), never reaps a healthy
|
|
# bottle. The Apple-container enumeration below (`live_source_ips`) becomes
|
|
# that host controller's `list_live` there.
|
|
try:
|
|
client.reconcile()
|
|
except OrchestratorClientError as e:
|
|
info(f"registry reconciliation skipped: {e}")
|
|
reg = provision_bottle(
|
|
client, source_ip, egress_plan, git_gate_plan, MacosGatewayTransport(),
|
|
image_ref=image_ref, tokens=tokens,
|
|
env_var_secret=env_var_secret,
|
|
)
|
|
return LaunchContext(
|
|
bottle_id=reg.bottle_id,
|
|
identity_token=reg.identity_token,
|
|
source_ip=source_ip,
|
|
gateway_ip=endpoint.gateway_ip,
|
|
network=endpoint.network,
|
|
orchestrator_url=endpoint.orchestrator_url,
|
|
env_var_secret=reg.env_var_secret,
|
|
)
|
|
|
|
|
|
def deprovision_consolidated(
|
|
bottle_id: str, *, orchestrator_url: str, timeout: float | None = None,
|
|
) -> None:
|
|
"""Deregister the bottle and remove its git-gate state from the gateway.
|
|
Both steps are idempotent so this is safe from a cleanup trap. Does NOT
|
|
stop the gateway — it's a persistent per-host singleton."""
|
|
deprovision_bottle(bottle_id, MacosGatewayTransport(),
|
|
orchestrator_url=orchestrator_url, timeout=timeout)
|
|
|
|
|
|
__all__ = [
|
|
"GatewayEndpoint",
|
|
"LaunchContext",
|
|
"ensure_gateway",
|
|
"live_source_ips",
|
|
"register_agent",
|
|
"deprovision_consolidated",
|
|
"ConsolidatedLaunchError",
|
|
"OrchestratorStartError",
|
|
"GATEWAY_NETWORK",
|
|
]
|