docs: add native Google Vertex AI provider RFC#331
Open
mason5052 wants to merge 2 commits into
Open
Conversation
Issue vxcontrol#321 requests a native Vertex AI provider with service-account / ADC auth, opened after vxcontrol#310 clarified Vertex is not supported today. The issue carries a full implementation outline and four open questions, and the author asks for direction on adapter strategy and Gemini-vs-Claude scope before implementing. Add examples/proposals/vertex_ai_provider.md, a planning RFC that frames the work before any code is written: - Distinguishes the current options (AI Studio gemini, direct Anthropic, AWS Bedrock, and the custom OpenAI-compatible LiteLLM proxy workaround) from the proposed native vertex provider. - Recommends a staged approach: v1 Gemini-on-Vertex with ADC / service-account auth; Claude-on-Vertex deferred to a maintainer decision, noting it likely belongs on the Anthropic adapter (Vertex auth/endpoint mode) rather than the Gemini-shaped path because the message schema differs. - Models auth on the existing Bedrock multi-auth precedent (ADC default chain plus service-account file), and flags that service-account JSON is sensitive and must be file-mounted/secret-managed, never pasted into UI or logs. - Captures config/migration touch points (provider checklist, REST Valid() whitelist, PROVIDER_TYPE enum-swap migration) so the eventual implementation size is clear, and restates the issue's open questions. Docs/RFC only. No code, schema, migration, generated, frontend, or provider runtime files are touched, and no new env vars or types are added; every VERTEX_* key and type named is labeled as a candidate. No overlap with the provider files in open PR vxcontrol#328.
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds an RFC proposing a future native Google Vertex AI provider (“vertex”) to support GCP IAM-based authentication and Gemini-on-Vertex, documenting scope, architecture options, migration/config considerations, and open questions.
Changes:
- Introduces an RFC document outlining motivation, goals/non-goals, and a staged implementation plan for a
vertexprovider. - Documents candidate configuration keys and authentication approaches (ADC / service-account file).
- Captures migration considerations, testing strategy, security considerations, and open questions for maintainers.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Drop the hard-coded provider count to avoid doc drift as providers are added; list the current provider types instead. - Use the ADC-specific command (gcloud auth application-default login) rather than the ambiguous 'gcloud login'. - Reference the enum-swap migration pattern generically under backend/migrations/sql/ instead of a single timestamped filename that may be renamed or squashed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add
examples/proposals/vertex_ai_provider.md, a planning RFC for a future native Google Vertex AI provider (vertex). RFC/docs only - no code, schema, migration, frontend, or provider runtime changes, and no new env vars or types. EveryVERTEX_*key and type named is explicitly labeled a candidate.Problem
Issue #321 requests a native Vertex AI provider with service-account / ADC auth, opened after #310 clarified that Vertex AI is not natively supported today (the only Google option,
gemini, targets AI Studio and takes an API key, not GCP project credentials). The issue already contains a full implementation outline and four open questions, and the author explicitly asks for maintainer direction on adapter strategy and Gemini-vs-Claude scope before implementing. Per PentAGI's recent contribution pattern (and the lesson from #268), a planning RFC is the right first step for provider-sized work rather than a speculative implementation PR.Solution
A self-contained RFC under
examples/proposals/(matching the existingmcp_client_integration.md/flow_concurrency.mdstyle) that:gemini, direct Anthropic, AWS Bedrock, and the custom OpenAI-compatible LiteLLM-proxy workaround - from the proposed nativevertexprovider.CLAUDE.mdprovider checklist, the RESTValid()whitelist, and thePROVIDER_TYPEenum-swap migration pattern) so the eventual implementation size is clear, and restates the issue's open questions for maintainers.All wording is framed as proposed/candidate/future; the RFC states up front that native Vertex support does not exist today.
User Impact
Test Plan
git diff --checkclean.examples/proposals/vertex_ai_provider.md. No code, schema, migration, generated, frontend, or provider runtime files changed.config.go,providers.go,provider/provider.go,server/models/providers.go, andminimax/*); this RFC touches none of those.vertexprovider package, proposal, or open PR exists.main: the 10 current provider types, the AI StudiogeminiAPI-key path, the Bedrock multi-auth fields, and the20260227_120000_add_cn_providers.sqlenum-swap migration.Refs #321