Skip to content

docs: add missing options to the Agent Relay configuration reference - #31837

Closed
coder[bot] wants to merge 3 commits into
docs/agent-relay-siem-messagesfrom
docs/agent-relay-config-reference
Closed

coder[bot] wants to merge 3 commits into
docs/agent-relay-siem-messagesfrom
docs/agent-relay-config-reference

Conversation

@coder

@coder coder Bot commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

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/5. Review and merge in order:

Refs DOCS-1171

Generated by Coder Agents.

@linear-code

linear-code Bot commented Nov 6, 2026

Copy link
Copy Markdown

DOCS-1171

Comment thread docs/agent-relay/configuration.md Resolved
Comment thread docs/agent-relay/configuration.md Resolved
Comment thread docs/agent-relay/configuration.md Resolved
Comment thread docs/agent-relay/configuration.md Resolved
@nickvigilante
nickvigilante force-pushed the docs/agent-relay-config-reference branch from 236645a to f9fec25 Compare November 6, 2026 20:02
Comment thread docs/agent-relay/configuration.md Resolved

@dluman dluman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small comment about Cursor's repo-scoped pools. Not sure if it's worth defining the way they work in order to make the feature clearer (i.e. describe why someone would want to do this).

nickvigilante added a commit that referenced this pull request Nov 9, 2026
Agent Relay v0.15.0 replaced the fixed 300-second Claude Code spawn
budget with a per-pool `dispatch_deadline`
([agent-relay#147](coder/agent-relay#147)).

- `claude-code.md`: rewrite **Build budget** (default `5m`, `10s` to
`15m`, whole seconds, can't be turned off, sent to Anthropic as the hint
TTL, needs v0.15.0) and add the field to both pool examples.
- `configuration.md`: add `dispatch_deadline` to the Claude Code pool
fields.
- `troubleshooting.md`, `monitoring/siem.md`: drop the fixed 300-second
wording.

Verification notes:
- Checked against `internal/services/serviceclaudecoderunners`
(`parseDispatchDeadline`, `poller.go` constants) at v0.15.0 (`9b96578`).
- The old text said Agent Relay returns a missed-budget session as
**retryable**. In v0.15.0, Claude requests use `TerminalOnDeadline`
([agent-relay#138](coder/agent-relay#138)), so a
failure at or after the deadline is nacked non-retryable. The page now
says Agent Relay "reports the failure" and doesn't claim either way.

Stack 1/5. Review and merge in order:
- #31834
- #31835
- #31836
- #31837
- #31838

Refs DOCS-1171

> Generated by Coder Agents.

---------

Co-authored-by: coder[bot] <137810501+coder[bot]@users.noreply.github.com>
Co-authored-by: Nick Vigilante <nick.vigilante@coder.com>
coder Bot and others added 2 commits November 9, 2026 14:09
Document the status page, TLS, and parameter credential transport options, the Cursor repo_url pool field, and the statusUI and tls Helm values, and update the source note to Agent Relay v0.15.0.
…t Relay config reference

Replace the Helm values table with a commented YAML example.
@nickvigilante
nickvigilante force-pushed the docs/agent-relay-config-reference branch from f9fec25 to 88647ed Compare November 9, 2026 19:09
Comment thread docs/agent-relay/configuration.md Resolved
@coderagents

coderagents Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Documentation Check

Blocking

  • docs/agent-relay/configuration.md (open) - Wrap the <owner>/<repo> placeholders in the repo_url field in backticks; they are parsed as raw HTML and stripped, so make lint/docs-html fails.
Findings for agents
- id: structure-1
  persona: structure
  class: broken
  blocking: true
  file: docs/agent-relay/configuration.md
  line: 145
  quote: "The URL path must end in `<owner>/<repo>`."
  evidence:
    - scripts/docshtmlcheck/main.go:530-539
    - scripts/docshtmlcheck/main_test.go:23-25
  rule: null
  problem: The unwrapped <owner> and <repo> angle-bracket placeholders are parsed as unknown HTML tags and stripped from the rendered page, so readers see broken text, and docshtmlcheck fails make lint/docs-html.
  fix: "The URL path must end in `<owner>/<repo>`." (wrap the placeholders in backticks)
  verified: true

Automated review via Coder Agents. Reply to a finding's thread with the reason if the finding is wrong.

…rom Agent Relay docs

Review feedback on #31837 asked how repo-scoped Cursor pools differ from
pools without a repository and why someone would set repo_url. Cursor
decides that routing, so link Cursor's any-repo pools section instead of
restating it, and add a two-pool example to Source control. The
repo_url row now says the template clones the repository, matching the
module README, rather than requiring it in the image.

Remove the HTML comment at the top of the configuration reference. It
named a private repository, internal paths, and a Linear issue, none of
which belong in published docs.

Refs DOCS-1171
@nickvigilante

Copy link
Copy Markdown
Collaborator

Closing and reopening under a human author, as required for this repository.

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

Labels

community Pull Requests and issues created by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants