Repository navigation
docs: fix smaller Agent Relay doc drift for v0.15.0 - #31987
Merged
Merged
Conversation
This was referenced Nov 12, 2026
nickvigilante
force-pushed
the
docs/agent-relay-smaller-fixes
branch
from
November 12, 2026 16:23
00977a7 to
661c611
Compare
nickvigilante
requested review from
BobbyHo,
dluman and
matifali
and removed request for
matifali
November 12, 2026 17:24
Contributor
|
Should it now be repurposed for 0.16.0? |
dluman
requested changes
Nov 12, 2026
dluman
left a comment
Collaborator
There was a problem hiding this comment.
Throughout, we're adopting "v0.16.0 or later"
nickvigilante
added a commit
that referenced
this pull request
Nov 12, 2026
Agent Relay v0.15.0 made the reaper's 15-minute startup window configurable ([agent-relay#152](coder/agent-relay#152)) and added a reap delay ([agent-relay#134](coder/agent-relay#134)). - `configuration.md`: add `--reap-startup-grace` (Helm `reapStartupGrace`) and `--reap-delay`, plus the per-pool `reap_delay` field, under an intro that says how the two options differ. The Cursor `dispatch_deadline: 0` row now points at the startup grace. - `setup.md`: fix the script-ordering note and **Workspace lifecycle**, which hardcoded 15 minutes and said failed builds are deleted "on the next sweep". **Workspace lifecycle** now states the 30-second gap between sweeps, and **Choose cleanup settings** maps each goal to its setting. - `cursor.md`: fix the **Build deadline** bullet and the `pending` lifecycle row. - `troubleshooting.md`: the "session ended but its workspace remains" row mentions the reap delay. - `monitoring/index.md`: add the `delayed` verdict to `agent_relay_reaper_verdicts_total` and define it as a wait before `delete` or `failed`. Verification notes: - The chart has **no `reapDelay` value** at v0.15.0 (only `reapStartupGrace`; checked `values.yaml` and `templates/_helpers.tpl`), so the docs say to set `CODER_AGENT_RELAY_REAP_DELAY` through `extraEnv`. - Pending or starting builds wait `max(grace, dispatch_deadline)`. A finished build whose runner reports `pending` or nothing fails after the grace alone (`workspacereaper/lifecycle.go`). - The reap delay counts from the latest build's `Job.CompletedAt`, not from the worker's exit, so a session that ran longer than the delay gets no extra time (`reapDeadline` in `workspacereaper/reaper.go`). - `delayed` is only a metric label. A sweep records it when the verdict is `delete` or `failed` but the delay hasn't passed. The `Verdict` type has only `keep`, `delete`, `failed`, and `stuck`. - The reaper sleeps 30 seconds after it sweeps every pool, rather than running on a fixed ticker (`sweepLoop` in `servicereaper/reaper.go`). Stack 2/6. Review and merge in order: - #31834 (merged) - #31984 - #31985 - #31986 - #31987 - #32094 Refs DOCS-1171 > Generated by Coder Agents. --------- Co-authored-by: coder[bot] <137810501+coder[bot]@users.noreply.github.com> Co-authored-by: Bobby Ho <bobby@coder.com>
nickvigilante
added a commit
that referenced
this pull request
Nov 12, 2026
Updates `monitoring/siem.md` to the log messages Agent Relay v0.15.0 writes. | Old `msg` | v0.15.0 `msg` | |---|---| | `workspace ready, runner handoff` | `workspace built, runner handoff` ([agent-relay#154](coder/agent-relay#154)) | | `workspace build passed the session deadline, reporting retryable and deleting` | `workspace build passed the session deadline, reporting failure` (also lists `workspace build succeeded after the session deadline`) | | `workspace build failed, reporting retryable and deleting` | `workspace build failed` | | `delete workspace failed, leaving for reconciliation` | `delete workspace failed, leaving it for the reaper` | The PR also adds the `agent_lifecycle` field, which appears on the handoff record and on reaper records. Verification notes: - Every other quoted `msg` in `siem.md` was checked by grepping `internal/` at `9b96578` and still matches. - `leaving for reconciliation` doesn't exist at v0.15.0. Its replacement comes from `Dispatcher.deleteWorkspace`. Stack 3/6. Review and merge in order: - #31834 (merged) - #31984 - #31985 - #31986 - #31987 - #32094 Refs DOCS-1171 > Generated by Coder Agents. Co-authored-by: coder[bot] <137810501+coder[bot]@users.noreply.github.com>
nickvigilante
force-pushed
the
docs/agent-relay-smaller-fixes
branch
from
November 12, 2026 18:16
661c611 to
35e7c86
Compare
Collaborator
Author
dluman
approved these changes
Nov 12, 2026
nickvigilante
force-pushed
the
docs/agent-relay-smaller-fixes
branch
from
November 12, 2026 18:27
35e7c86 to
60b930a
Compare
matifali
approved these changes
Nov 12, 2026
nickvigilante
force-pushed
the
docs/agent-relay-smaller-fixes
branch
from
November 12, 2026 18:39
60b930a to
49f7157
Compare
Correct Slack idle release guidance, release binaries, the setup verification log field, and minimum versions. Document missing metrics and active-version rebuilds (coder/agent-relay#135, coder/agent-relay#136, coder/agent-relay#154).
…rsions Drop the static binaries note; the docs cover the image and Helm chart.
nickvigilante
added a commit
that referenced
this pull request
Nov 12, 2026
…31986) Brings `configuration.md` closer to Agent Relay v0.15.0 and answers review questions about repo-scoped Cursor pools. - The Cursor `repo_url` pool field. The row says the template clones the repository before the worker starts, and links to **Source control** in `cursor.md`. - `cursor.md` **Source control**: when to set `repo_url`, a two-pool example, and a link to Cursor's any-repo pools docs for routing, which Cursor decides. - Helm values: a commented YAML example with defaults replaces the table. - Removes the HTML source comment at the top of `configuration.md`, which named the private repository, internal paths, and a Linear issue. Per review, this PR no longer documents the status page, its TLS options, or `--dangerous-allow-parameter-credential-transport`. Verification notes: - `repo_url`: agent-relay `internal/services/servicecursorworkers/cursorworkers.go` (`repoOwnerName`, `RegisterPool`) and `dispatch.go` (`buildParameters`), plus the `agent-relay-cursor` module README, which says the template must clone `agent_relay_cursor_repo_url`. - Helm defaults: `helm/coder-agent-relay/values.yaml`. - `reapStartupGrace` is covered in 2/5. `reapDelay` has no Helm value (see 2/5). Stack 4/6. Review and merge in order: - #31834 (merged) - #31984 - #31985 - #31986 - #31987 - #32094 Refs DOCS-1171 > Generated by Coder Agents. --------- Co-authored-by: coder[bot] <137810501+coder[bot]@users.noreply.github.com>
nickvigilante
force-pushed
the
docs/agent-relay-smaller-fixes
branch
from
November 12, 2026 18:44
49f7157 to
30fe17d
Compare
Contributor
|
I have read the CLA Document and I hereby sign the CLA 1 out of 2 committers have signed the CLA. |
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Smaller fixes so the Agent Relay docs match v0.15.0.
slack.md: idle release comes from the pool'sidle_release_timeout. Agent Relay setsagent_relay_claude_code_release_idle_session_minon every build, so the module'srelease_idle_session_mininput is only a fallback (confirmed in theagent-relay-claude-codemodule'smain.tf). This matchesclaude-code.md.setup.md: replace "release binaries aren't published yet"..github/workflows/release.yamlbuildslinuxanddarwinbinaries foramd64andarm64, pluschecksums.txt, on tags (there is no goreleaser config).setup.mdstep 6: checkcredential_transport=secrets, as the agent-relay README says.setup.md,index.md: say which features need v0.15.0.setup.mdStart the worker after workspace setup: point to the agent-ready and runner-up metrics.monitoring/index.md: addreaper_sweeps_total,reaper_sweep_seconds,reaper_claim_to_runner_up_seconds,reaper_claim_to_agent_ready_seconds(agent-relay#154),claude_code_polls_total,claude_code_last_poll_timestamp_seconds,claude_code_nacks_total,claude_code_pool_sessions,claude_code_issued_to_claimed_seconds,claude_code_queue_wait_seconds, and theclient_platform/spawn_reasonlabels onwork_orders_claimed_total.configuration.mdPin a template version: unpinned rebuilds move to the active version (agent-relay#135), and a refused rebuild is non-retryable (agent-relay#136).Verification notes:
400and403as non-retryable (dispatcher.go,retryable := ... != 400 && != 403), so the docs mention both.softprops/action-gh-release,draft: true). The v0.15.0 release is now published, but coder/agent-relay is an internal repository, so customers can't see GitHub release assets. Needs a decision on where binaries are distributed before this wording ships.Stack 5/6. Review and merge in order:
Refs DOCS-1171