docs: add Amazon Bedrock custom endpoints guide#706
docs: add Amazon Bedrock custom endpoints guide#706suryaiyer95 wants to merge 3 commits intomainfrom
Conversation
- Add dedicated guide for custom Bedrock endpoints (API gateways, proxies, VPC endpoints) covering bearer token auth, AWS credential chain, config structure, cross-region model ID prefixing, and troubleshooting - Fix provider key from incorrect `bedrock` to `amazon-bedrock` across all docs (providers.md, quickstart.md, models.md) to match actual code - Update config examples to use `options` nesting structure matching the provider implementation - Add nav entry under Configure > LLMs Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
📝 WalkthroughWalkthroughDocs updated to rename the Bedrock provider from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/configure/providers.md`:
- Around line 78-110: Update the "Provider Options Reference" so the Bedrock
fields are shown under the provider.amazon-bedrock.options namespace (e.g.,
provider.amazon-bedrock.options.region,
provider.amazon-bedrock.options.accessKeyId,
provider.amazon-bedrock.options.secretAccessKey,
provider.amazon-bedrock.options.baseURL) instead of as top-level properties;
edit the examples and property list in the "Provider Options Reference" section
to reflect this new nesting and ensure all sample JSON snippets and descriptions
reference provider.amazon-bedrock.options.*.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 0dc01d14-3d5d-42ef-b390-e1f55bd7b380
📒 Files selected for processing (5)
docs/docs/configure/bedrock-custom-endpoints.mddocs/docs/configure/models.mddocs/docs/configure/providers.mddocs/docs/getting-started/quickstart.mddocs/mkdocs.yml
There was a problem hiding this comment.
Pull request overview
Adds and wires up documentation for configuring Amazon Bedrock with custom endpoints, and corrects the Bedrock provider ID/config shape across existing docs to match the implementation (amazon-bedrock with nested options).
Changes:
- Add new guide for Amazon Bedrock custom endpoints (gateways/proxies/VPC endpoints), including auth and troubleshooting.
- Update docs to use the correct provider key (
amazon-bedrock) and model prefix (amazon-bedrock/...). - Add mkdocs navigation entry for the new guide.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/mkdocs.yml | Adds the “Bedrock Custom Endpoints” page to the Configure → LLMs nav. |
| docs/docs/getting-started/quickstart.md | Updates the Bedrock quickstart example to amazon-bedrock + options.region and links to the new guide. |
| docs/docs/configure/providers.md | Fixes the Bedrock provider key/config shape and adds a short custom endpoint example + link. |
| docs/docs/configure/models.md | Updates the Bedrock example model string to the amazon-bedrock/... prefix. |
| docs/docs/configure/bedrock-custom-endpoints.md | New end-to-end guide for using Bedrock via custom endpoints, including auth, config, prefixing, and troubleshooting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 5 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/docs/configure/bedrock-custom-endpoints.md">
<violation number="1" location="docs/docs/configure/bedrock-custom-endpoints.md:110">
P2: The cross-region section overstates prefix behavior: prefixing is conditional by model/region, not a universal default. This can lead to incorrect gateway expectations when model IDs are not auto-prefixed.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review, or fix all with cubic.
|
@suryaiyer95 can you address code review comments? |
- Fix CLI auth command: `altimate-code auth login --provider amazon-bedrock` - Clarify cross-region prefixing is conditional on model family + region - Add "Models prefixed" column to region prefix table - Fix backwards "unprefixed ID" guidance with accurate pass-through behavior - Add warning about no option to disable auto-prefixing - Fix log line format to match actual `service=config loading config from ...` - Remove ambiguous "provide credentials directly" wording - Fix Provider Options Reference: `options.region/profile/baseURL` not top-level Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/docs/configure/providers.md (1)
333-335: Consider documentingoptions.endpointalias in this reference table.The dedicated Bedrock guide documents
endpointas an alias forbaseURL, but this summary table only listsoptions.baseURL. Addingoptions.endpointhere would keep references consistent.🧾 Suggested table row
| `options.baseURL` | `string` | Custom endpoint URL for Bedrock gateway/proxy (Amazon Bedrock only) | +| `options.endpoint` | `string` | Alias for `options.baseURL`; if both are set, `endpoint` takes precedence (Amazon Bedrock only) |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/docs/configure/providers.md` around lines 333 - 335, Add documentation for the alias by adding a table row for `options.endpoint` alongside `options.baseURL` in the reference table: state that `options.endpoint` is a string and is an alias for `options.baseURL` (Custom endpoint URL for Bedrock gateway/proxy, Amazon Bedrock only, default: `us-east-1` where applicable), ensuring both `options.baseURL` and `options.endpoint` are listed and indicate they are interchangeable in the Bedrock guide and code examples.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/configure/bedrock-custom-endpoints.md`:
- Around line 126-131: The text currently contradicts itself by saying the
gateway expects a "bare model ID" but the example uses a prefixed model string
("amazon-bedrock/us.anthropic.claude-sonnet-4-6-v1"); pick one and make them
consistent — either change the explanatory sentence to say the gateway may
expect a prefixed model ID and keep the example, or change the example to a bare
model ID (e.g., "claude-sonnet-4-6-v1") so it matches the "bare model ID"
guidance; update the sentence around "If your gateway handles routing
independently and expects the bare model ID" and the JSON example so both
describe the same expectation.
---
Nitpick comments:
In `@docs/docs/configure/providers.md`:
- Around line 333-335: Add documentation for the alias by adding a table row for
`options.endpoint` alongside `options.baseURL` in the reference table: state
that `options.endpoint` is a string and is an alias for `options.baseURL`
(Custom endpoint URL for Bedrock gateway/proxy, Amazon Bedrock only, default:
`us-east-1` where applicable), ensuring both `options.baseURL` and
`options.endpoint` are listed and indicate they are interchangeable in the
Bedrock guide and code examples.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: f36317a7-37d2-4d20-ba82-f293353dbdb1
📒 Files selected for processing (2)
docs/docs/configure/bedrock-custom-endpoints.mddocs/docs/configure/providers.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/docs/configure/bedrock-custom-endpoints.md`:
- Around line 70-82: Convert the fenced triple-backtick JSON blocks to the
repo’s expected indented code-block style: replace the ```json ... ``` fences
with a 4-space-indented block containing the same JSON (e.g., the block
containing "model": "amazon-bedrock/anthropic.claude-sonnet-4-6-v1"), and do the
same for the other occurrences referenced (the blocks around lines 102-104,
128-132, 143-145, 163-165, 169-182) so the content remains identical but uses
indented code block formatting.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 1d9c9321-0c95-45c8-b3d3-295f780f6487
📒 Files selected for processing (1)
docs/docs/configure/bedrock-custom-endpoints.md
Summary
docs/configure/bedrock-custom-endpoints.md) for using Altimate Code with custom Bedrock endpoints — API gateways, corporate proxies, VPC endpointsbedrocktoamazon-bedrockacross all docs to match the actual provider implementation inpackages/opencode/src/provider/provider.tsoptionsnesting structureContext
Customer feedback confirmed the existing docs used the wrong provider key (
bedrockinstead ofamazon-bedrock) and didn't cover the custom endpoint use case at all. The new guide covers bearer token auth, AWS credential chain,baseURLconfiguration, cross-region model ID prefixing, and troubleshooting.Test plan
cd docs && mkdocs build)🤖 Generated with Claude Code
Summary by cubic
Adds a guide for using Amazon Bedrock with custom endpoints and updates docs to use the
amazon-bedrockprovider with the correctoptionsconfig. Clarifies cross‑region model prefixing, fixes the CLI auth command, and corrects guidance on bare model IDs.New Features
configure/bedrock-custom-endpoints.md(covers bearer token auth, AWS credential chain,options.baseURL, cross‑region prefixing by region+model family with pass‑through behavior and no disable switch, and troubleshooting with correct log lines).Bug Fixes
altimate-code auth login --provider amazon-bedrock.amazon-bedrockand moved Bedrock config underoptions.region/options.profile/options.baseURLacrossmodels.md,providers.md,quickstart.md, and nav.Written for commit 56334d2. Summary will update on new commits.
Summary by CodeRabbit