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

docs: add AI Gateway rebranding migration guide - #26854

Merged
dannykopping merged 6 commits into
mainfrom
dk/gateway-migration-guide
Jul 1, 2026
Merged

docs: add AI Gateway rebranding migration guide#26854
dannykopping merged 6 commits into
mainfrom
dk/gateway-migration-guide

Conversation

@dannykopping

@dannykopping dannykopping commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds an operator-facing migration guide for the AI Bridge to AI Gateway rebrand, as a new docs page under AI Coder > AI Gateway (last child in the section).

The guide documents:

  • Config aliases (env vars, CLI flags, YAML group keys): old aibridge names still work as hidden, deprecated aliases; new ai_gateway names are canonical. Includes full env-var mapping tables and the mechanical substitution rules.
  • HTTP API: canonical path is now /api/v2/ai-gateway; legacy /api/v2/aibridge routes retained.
  • Metrics: prefixes renamed coder_aibridged_* -> coder_ai_gateway_* and coder_aibridgeproxyd_* -> coder_ai_gateway_proxy_*. Both old and new names are emitted today, so dashboards keep working; guidance to migrate before the old names are removed, plus an optional metric_relabel_configs drop snippet.
  • No database changes and no required config changes to upgrade.

Implements the docs/release-notes portion of AIGOV-240 (parent: AIGOV-207).

Notes

  • Content reflects what actually shipped in the codebase (metrics are aliased, not hard-renamed), which differs from the original RFC that assumed a hard rename.
  • Registered in docs/manifest.json with state: ["ai governance add-on"] to match sibling pages.

This PR was produced by opencode (agent) using the anthropic/claude-opus-4-8 model, under human direction and review.

Document the AI Bridge to AI Gateway rebrand for operators: config
(env/flag/YAML) aliases, HTTP API path, and Prometheus metric renames.
Clarifies that old names keep working as deprecated aliases, there are no
database changes, and metrics are emitted under both names today.

Adds the page as the last child of the AI Gateway docs section.
@github-actions

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown

Docs preview

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

@dannykopping
dannykopping marked this pull request as ready for review June 30, 2026 09:05
@coder-tasks

coder-tasks Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Documentation Check

Updates Needed

  • docs/ai-coder/ai-gateway/rebranding-migration.md - Missing CODER_AI_GATEWAY_PROVIDER_<N>_* indexed env vars. Added to the env var table and documented in a new "Provider configuration env vars" section, including the "cannot mix" restriction.
  • docs/ai-coder/ai-gateway/index.md - Lines 25-27 mention that AI Gateway was previously "AI Bridge" but don't link to the new migration guide. Cross-link added in 9702d4a.

Automated review via Coder Agents

Add the indexed CODER_AI_GATEWAY_PROVIDER_<N>_<KEY> env vars (deprecated
alias CODER_AIBRIDGE_PROVIDER_<N>_<KEY>) to the reference tables and a
dedicated section, noting the two prefixes cannot be mixed. Add a Note
column to the env var reference tables.

@ssncferreira ssncferreira 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 👍 just a few comments and suggestions, but nothing blocking 🙂

Comment thread docs/ai-coder/ai-gateway/index.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md
- Clarify the aibridge names are retained for backward compatibility with
  no planned removal date, rather than implying future removal.
- Move the no-breaking-changes statement into a NOTE and the new-name-only
  policy for future settings into an IMPORTANT callout scoped to all areas
  except the database.
- Show the exact startup error when provider env var prefixes are mixed.
- Note that AI client base URLs should be updated to the new API path.

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

Approved with changes. Thanks for submitting this! :shipit: 🚀

Comment thread docs/ai-coder/ai-gateway/index.md Outdated
Comment thread docs/ai-coder/ai-gateway/index.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Comment thread docs/ai-coder/ai-gateway/rebranding-migration.md Outdated
Signed-off-by: Danny Kopping <danny@coder.com>
@dannykopping
dannykopping merged commit e3ac65a into main Jul 1, 2026
30 of 31 checks passed
@dannykopping
dannykopping deleted the dk/gateway-migration-guide branch July 1, 2026 08:54
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 1, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants