pdurlej/platform

Fork 0

docs(platformctl): document health prerequisites #657

Merged

pdurlej merged 1 commit from codex/213-health-prereqs-docs into main

2026-06-01 14:03:03 +02:00

codex commented

2026-06-01 08:47:21 +02:00

Collaborator

Canary status: missing - docs-only platformctl health prerequisite update; run canary manually if branch policy requires it.

Canary Context Pack

Product story

Operators and agents need to distinguish a broken platformctl health invocation from a genuinely unhealthy module. Health checks are part of the deploy/CI feedback loop, so their prerequisites and failure modes need to be explicit.

What changed

Documented platformctl health single-module and --all invocation examples, required PLATFORMCTL_* environment variables, remote smoke prerequisites, and common failure-mode interpretation.

Why it changed

Issue #213 asks for operator-facing health command prerequisites so agents do not misread missing Tailnet/SSH/runtime configuration as module health evidence.

Files touched

docs/ci/README.md

Relevant context

docs/ci/README.md trust-tier and deploy feedback model
tests/smoke.sh runtime smoke contract

Runtime evidence

No runtime commands or remote probes were run. Validation was local and read-only:

PYTHONPATH=control-plane UV_CACHE_DIR=/private/tmp/codex-uv-cache uv run --project control-plane python -m platformctl.cli validate all --json

Result: exitCode 0.

Known constraints

This is documentation only. It does not change platformctl health, smoke behavior, SSH behavior, runner state, or production runtime.

Explicit out-of-scope

No production restart.
No runtime apply.
No secret or token handling change.
No tests/smoke.sh behavior change.
No host allowlist implementation change.

Requested decision

Approve and merge if the documentation matches current operational expectations.

Merge blockers

The documented environment variables are wrong.
The failure-mode distinction is misleading.
Branch policy requires a canary result that is not yet attached.

Spec sources read

docs/ci/README.md - target operator/CI documentation surface.
runbooks/forgejo-actions-runner.md - runner capability and trust-boundary context.
tests/smoke.sh - source of smoke prerequisites and remote host env vars.

Closes #213

Canary status: missing - docs-only platformctl health prerequisite update; run canary manually if branch policy requires it. ## Canary Context Pack ### Product story Operators and agents need to distinguish a broken `platformctl health` invocation from a genuinely unhealthy module. Health checks are part of the deploy/CI feedback loop, so their prerequisites and failure modes need to be explicit. ### What changed Documented `platformctl health` single-module and `--all` invocation examples, required `PLATFORMCTL_*` environment variables, remote smoke prerequisites, and common failure-mode interpretation. ### Why it changed Issue #213 asks for operator-facing health command prerequisites so agents do not misread missing Tailnet/SSH/runtime configuration as module health evidence. ### Files touched - `docs/ci/README.md` ### Relevant context - `docs/ci/README.md` trust-tier and deploy feedback model - `tests/smoke.sh` runtime smoke contract ### Runtime evidence No runtime commands or remote probes were run. Validation was local and read-only: ```bash PYTHONPATH=control-plane UV_CACHE_DIR=/private/tmp/codex-uv-cache uv run --project control-plane python -m platformctl.cli validate all --json ``` Result: exitCode 0. ### Known constraints This is documentation only. It does not change `platformctl health`, smoke behavior, SSH behavior, runner state, or production runtime. ### Explicit out-of-scope - No production restart. - No runtime apply. - No secret or token handling change. - No `tests/smoke.sh` behavior change. - No host allowlist implementation change. ### Requested decision Approve and merge if the documentation matches current operational expectations. ### Merge blockers - The documented environment variables are wrong. - The failure-mode distinction is misleading. - Branch policy requires a canary result that is not yet attached. ## Spec sources read - `docs/ci/README.md` - target operator/CI documentation surface. - `runbooks/forgejo-actions-runner.md` - runner capability and trust-boundary context. - `tests/smoke.sh` - source of smoke prerequisites and remote host env vars. Closes #213

codex added this to the 06 - Agent execution and CI governance milestone

2026-06-01 08:47:21 +02:00

codex added the

class/security-sensitive

label

2026-06-01 08:47:21 +02:00

codex added 1 commit

2026-06-01 08:47:21 +02:00

docs(platformctl): document health prerequisites

canary-required / collect-diff (pull_request) Successful in 6s

Details

infra-docs-drift / docs-drift (pull_request) Successful in 7s

Details

patchwarden-pr-sanity / collect-diff (pull_request) Successful in 6s

Details

python-ci / Python 3.11 (pull_request) Successful in 46s

Details

python-ci / Python 3.12 (pull_request) Successful in 47s

Details

python-ci / Python 3.13 (pull_request) Successful in 47s

Details

workflow-lint / lint (pull_request) Successful in 7s

Details

base-is-main / guard (pull_request) Successful in 1s

Details

canary-required / canary (pull_request) Has been skipped

Details

patchwarden-client-dry-run / dry-run (pull_request) Successful in 1m6s

Details

patchwarden-client-dry-run / collect-diff (pull_request) Successful in 6s

Details

patchwarden-pr-sanity / sanity (pull_request) Successful in 2m44s

Details

2ef6c3532a

codex commented

2026-06-01 09:36:54 +02:00

Author

Collaborator

Patchwarden PR sanity

Status: eligible_sanity_clean
PR: 657
Commit: 2ef6c3532a5e238902b8415fef85a452cf78e9bc
Security-sensitive label: present
Authority: advisory model review plus deterministic blockers only
3+3 canary: still alive; this does not replace it

Deterministic findings

No deterministic findings.

Model reviewers

`global-glm` / `glm-5.1:cloud`

Status: ok
Verdict: OK
Findings: none

`global-deepseek` / `deepseek-v4-pro:cloud`

Status: ok
Verdict: OK
Findings: none

`redteam` / `kimi-k2.6:cloud`

Status: ok
Verdict: OK
Findings: none

Policy notes

GLM 5.1 + DeepSeek V4 Pro are the operator-required model mix for this bot.
Optional red-team model is enabled only when PLATFORMCTL_PR_SANITY_REDTEAM_MODEL is configured.
Auto-merge is not enabled here.

# Patchwarden PR sanity - Status: `eligible_sanity_clean` - PR: `657` - Commit: `2ef6c3532a5e238902b8415fef85a452cf78e9bc` - Security-sensitive label: `present` - Authority: advisory model review plus deterministic blockers only - 3+3 canary: still alive; this does not replace it ## Deterministic findings No deterministic findings. ## Model reviewers ### `global-glm` / `glm-5.1:cloud` - Status: `ok` - Verdict: `OK` - Findings: none ### `global-deepseek` / `deepseek-v4-pro:cloud` - Status: `ok` - Verdict: `OK` - Findings: none ### `redteam` / `kimi-k2.6:cloud` - Status: `ok` - Verdict: `OK` - Findings: none ## Policy notes - GLM 5.1 + DeepSeek V4 Pro are the operator-required model mix for this bot. - Optional red-team model is enabled only when `PLATFORMCTL_PR_SANITY_REDTEAM_MODEL` is configured. - Auto-merge is not enabled here.