Skip to content

docs(docs/ai-coder): deprecate env-based AI Bridge provider config#24898

Closed
dannykopping wants to merge 1 commit into
dk/aibridge-providers-chatd-plumbingfrom
dk/aibridge-providers-deprecate-env
Closed

docs(docs/ai-coder): deprecate env-based AI Bridge provider config#24898
dannykopping wants to merge 1 commit into
dk/aibridge-providers-chatd-plumbingfrom
dk/aibridge-providers-deprecate-env

Conversation

@dannykopping
Copy link
Copy Markdown
Contributor

@dannykopping dannykopping commented May 1, 2026

Disclaimer: implemented by a Coder Agent using Claude Opus 4.7

Part of the implementation of RFC: Common AI Provider Configs (AIGOV-201).

What this PR does

Updates docs/ai-coder/ai-gateway/setup.md to reflect the new database-backed provider configuration:

  1. Adds a deprecation banner under "Configure Providers" explaining that the legacy CODER_AIBRIDGE_OPENAI_*, CODER_AIBRIDGE_ANTHROPIC_*, CODER_AIBRIDGE_BEDROCK_*, and indexed CODER_AIBRIDGE_PROVIDER_<N>_* env vars are deprecated. They still work and are seeded into the ai_providers database table on startup.
  2. Adds a new "Manage providers via the API" subsection with curl examples for creating OpenAI and Bedrock-routed Anthropic providers, documenting the discriminated _type / _version settings shape and the ai_providers_changed pubsub-driven hot-reload.
  3. Marks the indexed env var form as deprecated in its own subsection heading and links the GitHub Copilot section to the new anchor.

No code changes.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

Docs preview

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

Copy link
Copy Markdown
Contributor Author

dannykopping commented May 1, 2026

@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch from e6263e1 to c0ca02a Compare May 1, 2026 18:34
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 7c002bf to 181fbab Compare May 1, 2026 18:34
@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch from c0ca02a to 9d381bb Compare May 1, 2026 19:24
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 181fbab to f5cada2 Compare May 1, 2026 19:24
@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch from 9d381bb to ebe85d2 Compare May 13, 2026 15:19
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from f5cada2 to 235dbe2 Compare May 13, 2026 15:22
@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch from ebe85d2 to f50344a Compare May 14, 2026 10:57
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 235dbe2 to 00a44ab Compare May 14, 2026 10:57
@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch from f50344a to fe2d5e5 Compare May 14, 2026 11:23
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 00a44ab to 5b7999f Compare May 14, 2026 11:23
@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch from fe2d5e5 to 42d6c00 Compare May 14, 2026 11:41
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch 2 times, most recently from a40c13d to 4e30ce3 Compare May 14, 2026 13:20
@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch from 42d6c00 to d57f04a Compare May 14, 2026 13:20
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 4e30ce3 to f99cef6 Compare May 14, 2026 13:38
@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch 2 times, most recently from 5d9e052 to 59d051d Compare May 14, 2026 14:13
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch 2 times, most recently from d706c4b to be0e216 Compare May 15, 2026 11:39
@dannykopping dannykopping force-pushed the dk/aibridge-providers-pool-reload branch from 59d051d to 0268595 Compare May 15, 2026 11:39
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from be0e216 to 31df373 Compare May 15, 2026 13:16
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch from 1aa13bc to 9ca1546 Compare May 18, 2026 16:34
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from b78ec1c to d012b70 Compare May 18, 2026 16:41
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch 2 times, most recently from 36424ab to b82947f Compare May 19, 2026 10:41
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from d012b70 to aef956b Compare May 19, 2026 10:41
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch from b82947f to 6501ec5 Compare May 19, 2026 11:39
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from aef956b to 000e627 Compare May 19, 2026 11:39
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch from 6501ec5 to edf9cda Compare May 19, 2026 12:52
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 000e627 to 51eff19 Compare May 19, 2026 12:52
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 51eff19 to 9fdd52f Compare May 19, 2026 13:03
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch from edf9cda to 50471c3 Compare May 19, 2026 13:03
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 9fdd52f to 21d0426 Compare May 19, 2026 13:22
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch from 50471c3 to 6273989 Compare May 19, 2026 13:22
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 21d0426 to 27129d6 Compare May 20, 2026 08:39
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch from 6273989 to dee1635 Compare May 20, 2026 08:39
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 27129d6 to f91ad41 Compare May 20, 2026 12:23
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch 2 times, most recently from 6a2e247 to e3cc4e3 Compare May 20, 2026 12:46
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from f91ad41 to 383984d Compare May 20, 2026 12:47
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch from e3cc4e3 to ab5f744 Compare May 20, 2026 15:05
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 383984d to 02f7de8 Compare May 20, 2026 15:05
@dannykopping dannykopping force-pushed the dk/aibridge-providers-chatd-plumbing branch from ab5f744 to 554e36a Compare May 20, 2026 15:34
@dannykopping dannykopping force-pushed the dk/aibridge-providers-deprecate-env branch from 02f7de8 to c6dcfce Compare May 20, 2026 15:35
…eys API

Adds a deprecation banner under the 'Configure Providers' section
explaining that environment-driven provider configuration is now
reconciled into the database-backed ai_providers table at startup and
that the recommended way to manage providers going forward is the
/api/v2/aibridge/providers HTTP API.

Documents the new providers/keys split:

  - POST /api/v2/aibridge/providers no longer carries an api_key
    field; provider rows are now created first, and keys are
    attached via POST /api/v2/aibridge/providers/{name}/keys.
  - The keys sub-resource (GET/POST/DELETE) is the canonical place
    to manage bearer tokens, with multi-key failover (oldest key
    wins, future versions will rotate on 401/quota errors) and
    rotation semantics (add new, then delete old).
  - Bedrock-routed Anthropic providers have zero keys; their AWS
    credentials live in the encrypted settings.bedrock_access_key
    and settings.bedrock_access_key_secret because Bedrock
    authenticates via SigV4 rather than a bearer token. POST keys
    against a Bedrock provider returns 400.
  - Key add and delete also publish on ai_providers_changed so the
    runtime pool reloads.

Marks the indexed CODER_AIBRIDGE_PROVIDER_<N>_* form as deprecated in
its own subsection heading and points readers at the API.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant