Skip to content

docs(guest-agent): say why v1 Health names containers ungated - #1360

Open
kvinwang wants to merge 1 commit into
nextfrom
docs/guest-agent-health-names
Open

kvinwang wants to merge 1 commit into
nextfrom
docs/guest-agent-health-names

Conversation

@kvinwang

@kvinwang kvinwang commented Sep 24, 2026

Copy link
Copy Markdown
Collaborator

HealthResponse.unhealthy names containers regardless of public_sysinfo/public_logs, which looks like a leak next to the gated dashboard. It is deliberate: the gateway is the consumer, and the external listener has no auth, so it cannot answer only the gateway. Adds a two-line proto comment saying so. Comment-only.

The dashboard's container table is gated on `public_sysinfo` or
`public_logs`; `Health` names unhealthy containers to anyone. That reads
as an oversight until you follow the consumer: `describe_unhealthy` in
`gateway/src/proxy/health_check.rs` is the only thing outside the agent
that reads the field, its output becomes `Observation.reason`, and
`record_instance_health` prints it. Routing uses `healthy` alone -- but
that log line is the only place a gateway operator learns which container
held an instance out of rotation, and the external listener is one
`0.0.0.0` socket, so there is no way to answer the gateway and not
answer everyone else. Record the reasoning next to the field.
@kvinwang
kvinwang force-pushed the docs/guest-agent-health-names branch from ad3fc87 to c88ab33 Compare September 24, 2026 09:07

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant