🌐 US-Proxy
class="logged-out env-production page-responsive" style="word-wrap: break-word;" >
Skip to content

docs: document AI providers seeding mechanism & support for new types - #25855

Merged
dannykopping merged 1 commit into
mainfrom
dk/docs-ai-gateway-ui-api-setup
Jun 1, 2026
Merged

docs: document AI providers seeding mechanism & support for new types#25855
dannykopping merged 1 commit into
mainfrom
dk/docs-ai-gateway-ui-api-setup

Conversation

@dannykopping

@dannykopping dannykopping commented May 29, 2026

Copy link
Copy Markdown
Contributor

Adds a new Provider Configuration reference page (providers.md) covering:

  • The migration from environment-variable-based provider config to database-backed management introduced in v2.34, including the one-time seeding behavior and deprecation of CODER_AI_GATEWAY_PROVIDER_<N>_* and related flags
  • All supported provider types (openai, anthropic, bedrock, copilot, azure, google, openrouter, vercel, openai-compat) with setup notes for each
  • Provider lifecycle statuses (enabled, disabled, error) and their effect on request handling
  • Reload behavior and how configuration changes apply without restarting coderd
  • Bring Your Own Key (BYOK) and failure mode reference table

Updates Setup (setup.md) to replace the environment-variable-based provider configuration instructions with dashboard-driven steps (Add provider form, provider list, edit/disable flow), referencing the new providers.md page for deeper detail. Screenshots of the provider list, add, and edit forms are included.

Adds a Provider metrics section to Monitoring (monitoring.md) documenting the coder_aibridged_* and coder_aibridgeproxyd_* Prometheus metrics for provider status and reload timestamps, along with two suggested PromQL alert queries.

@github-actions

github-actions Bot commented May 29, 2026

Copy link
Copy Markdown

Docs preview

📖 View docs preview for docs/ai-coder/ai-gateway/monitoring.md

dannykopping commented May 29, 2026

Copy link
Copy Markdown
Contributor Author

@dannykopping
dannykopping changed the base branch from dk/aibridge-providers-deprecate-seeding-env to graphite-base/25855 May 29, 2026 14:45
@dannykopping
dannykopping force-pushed the dk/docs-ai-gateway-ui-api-setup branch from 07ff199 to 36f2a0e Compare June 1, 2026 10:00
@dannykopping
dannykopping changed the base branch from graphite-base/25855 to dk/copilot-provider June 1, 2026 10:00
@dannykopping dannykopping changed the title WIP docs: document AI providers seeding mechanism & support for new types Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

/coder-agents-review

@coder-agents-review

coder-agents-review Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Chat: Review posted | View chat
Requested: 2026-06-01 10:02 UTC by @dannykopping
Spend: $3.88 / $100.00

Review history
  • R1 (2026-06-01), 2 P2, 1 P3, COMMENT. Review

deep-review v0.6.0 | Round 1 | 23b60ef..36f2a0e

Last posted: Round 1, 3 findings (2 P2, 1 P3), COMMENT. Review

Finding inventory

Findings

# Sev Status Location Summary Round Reviewer Posted
CRF-1 P2 Open clients/copilot.md:20 Broken link: ../setup.md#github-copilot heading removed, should point to ../providers.md#github-copilot R1 Netero Yes
CRF-2 P2 Open clients/coder-agents.md:47 Broken link: ../setup.md#multiple-instances-of-the-same-provider heading removed, no replacement anchor exists R1 Netero Yes
CRF-3 P3 Open providers.md (missing) ChatGPT provider config deleted from setup.md but not added to providers.md; codex.md still references chatgpt provider R1 Netero Yes

Round log

Round 1

Netero-only. 2 P2, 1 P3. Reviewed against 23b60ef6dfaa..36f2a0eaaf59. Panel gated on P2 findings; author should fix broken links and missing ChatGPT documentation before full panel review.

About deep-review

CRF = Coder Review Finding (P0-P4, Nit, Note)

Reviewer Focus
Bisky tests
Chopper ops/errors
Churn-guard change verification
Ging language modernization
Gon naming
Hisoka edge cases
Killua perf
Kite change integrity
Knov contracts
Knuckle SQL
Kurapika security
Law decomposition
Leorio docs
Luffy product
Mafu-san process
Mafuuu contracts
Melody dispatch/pairing
Meruem structural
Nami frontend
Netero mechanical checks
Pariston premise testing
Pen-botter product gaps
Razor verification
Robin duplication
Ryosuke Go arch
Takumi concurrency
Zoro shape

🤖 Managed by Coder Agents.

@coder-agents-review coder-agents-review Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

First-pass review (Netero). 2 P2, 1 P3.

This is a first-pass review only: these are mechanical findings, the full review panel has not yet reviewed this PR. The panel will review after these findings are addressed.

The new providers.md page is well structured, the provider-type table and lifecycle status table are clear, and the monitoring metrics section with PromQL alert examples is a useful addition. The migration from env-var docs to dashboard-driven setup is well-motivated.

The three findings are all broken cross-references caused by removing headings from setup.md without updating the docs that linked to them, plus one content gap (ChatGPT provider type dropped entirely).


docs/ai-coder/ai-gateway/clients/copilot.md:20

P2 [CRF-1] This line links to ../setup.md#github-copilot, but the ### GitHub Copilot heading was removed from setup.md by this PR. The anchor resolves to nothing.

The target should be ../providers.md#github-copilot, which has the replacement content.

(Netero)

🤖

docs/ai-coder/ai-gateway/clients/coder-agents.md:47

P2 [CRF-2] This line links to ../setup.md#multiple-instances-of-the-same-provider, but that heading was removed from setup.md by this PR. The anchor is now dead.

Unlike the Copilot heading, there is no equivalent anchor in providers.md to redirect to. The concept of named provider instances with distinct routes is now implicit in the dashboard flow but needs an explicit section or anchor that this file can link to.

(Netero)

🤖

🤖 This review was automatically generated with Coder Agents.

Comment thread docs/ai-coder/ai-gateway/providers.md
@dannykopping
dannykopping requested a review from ibetitsmike June 1, 2026 10:16

@ibetitsmike ibetitsmike 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.

approved with a question

[Provider Configuration](./providers.md) for the lifecycle these
metrics describe.

| Metric | Type | Labels | Purpose |

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.

IIRC nothing in the stack actually adds those metrics, we just didn't have the docs before?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Correct

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.

"a Anthropic provider" just hurts to look at, but unrelated to this PR

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed downstack 👍

@dannykopping
dannykopping force-pushed the dk/docs-ai-gateway-ui-api-setup branch from 36f2a0e to e5df169 Compare June 1, 2026 11:26
@dannykopping
dannykopping force-pushed the dk/copilot-provider branch from 23b60ef to 8bea045 Compare June 1, 2026 11:26
@dannykopping
dannykopping force-pushed the dk/docs-ai-gateway-ui-api-setup branch from e5df169 to cc99a93 Compare June 1, 2026 11:44
@dannykopping
dannykopping force-pushed the dk/copilot-provider branch from 8bea045 to 2e2fe02 Compare June 1, 2026 11:44
@dannykopping
dannykopping marked this pull request as ready for review June 1, 2026 12:01
@coder-tasks

coder-tasks Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Documentation Check

Updates Needed

  • docs/ai-coder/ai-gateway/clients/copilot.md (line 20) - Broken link: ../setup.md#github-copilot anchor was removed from setup.md. Should point to ../providers.md#github-copilot.
  • docs/ai-coder/ai-gateway/clients/coder-agents.md (line 47) - Broken link: ../setup.md#multiple-instances-of-the-same-provider section was removed. The concept of named provider instances is still valid (providers have unique names and routes); the link should point to a suitable anchor, e.g. ../providers.md or a new section covering named-instance routing.
  • docs/ai-coder/ai-gateway/clients/coder-agents.md (line 196) - Link ../setup.md in "AI Gateway setup" related links still works but now covers less ground. Consider updating text or pointing to ../providers.md as well.

New Documentation Needed

  • docs/ai-coder/ai-gateway/providers.md - ChatGPT provider configuration was deleted from setup.md but not carried over to providers.md. clients/codex.md (lines 57-73) still references a chatgpt provider name and route (/aibridge/chatgpt/v1). Either add a ChatGPT subsection to providers.md or document that it is configured as an openai type with the Codex base URL.

Automated review via Coder Agents

dannykopping commented Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

Merge activity

  • Jun 1, 1:15 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jun 1, 1:28 PM UTC: Graphite rebased this pull request as part of a merge.
  • Jun 1, 1:33 PM UTC: @dannykopping merged this pull request with Graphite.

@dannykopping
dannykopping changed the base branch from dk/copilot-provider to graphite-base/25855 June 1, 2026 13:16

@nickvigilante nickvigilante left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM overall! I have some other nits that I think I'll need to change more holistically, but I need to establish a style guide and clearly defined rules first and distribute that across the wider team, but this PR is informative and has no glaring issues that need to be fixed in the next 24 hours. :shipit: 🚀

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: can you edit the web page for this prior to taking the screenshot and change the header label from a to an?

@dannykopping
dannykopping changed the base branch from graphite-base/25855 to main June 1, 2026 13:26
Signed-off-by: Danny Kopping <danny@coder.com>
@dannykopping
dannykopping force-pushed the dk/docs-ai-gateway-ui-api-setup branch from cc99a93 to eeff9a4 Compare June 1, 2026 13:27
@dannykopping
dannykopping merged commit f9937a8 into main Jun 1, 2026
29 checks passed
@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown

Cherry-pick PR created: #25906

f0ssel pushed a commit that referenced this pull request Jun 1, 2026
…#25855) (#25906)

Cherry-pick of #25855

Original PR: #25855 — docs: document AI providers seeding mechanism &
support for new types
Merge commit: f9937a8
Requested by: @dannykopping

---------

Co-authored-by: Danny Kopping <danny@coder.com>
Co-authored-by: Susana Ferreira <susana@coder.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants