Skip to content

docs(config): document supported VikingDB regions (add ap-southeast-1 from #2297)#2334

Open
r266-tech wants to merge 1 commit into
volcengine:mainfrom
r266-tech:docs-config-vikingdb-supported-regions
Open

docs(config): document supported VikingDB regions (add ap-southeast-1 from #2297)#2334
r266-tech wants to merge 1 commit into
volcengine:mainfrom
r266-tech:docs-config-vikingdb-supported-regions

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Merged PR #2297 added ap-southeast-1 host mappings to the VikingDB clients, but the configuration guide's volcengine vectordb backend example only ever shows region: cn-beijing and never enumerates which regions are supported — so users outside Beijing (e.g. the new Southeast Asia region) have no way to discover the option from the docs.

This adds a short supported-regions note (EN + ZH) inside the existing volcengine vikingDB example block. The region set is sourced from openviking/storage/vectordb/collection/volcengine_clients.py:

  • ClientForConsoleApi._global_host and ClientForDataApi._global_host both enumerate cn-beijing, cn-shanghai, cn-guangzhou, ap-southeast-1.

The note is qualified ("when no explicit host is set") since the clients do host if host else _global_host[region], so a custom-host deployment isn't restricted to the built-in region keys.

Pure docs, no code change.

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

2297 - Fully compliant

Compliant requirements:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

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

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

1 participant