Add Google Cloud Vertex AI connector documentation - #12987
Open
tonypiazza wants to merge 1 commit into
Open
Conversation
Documents the new first-class `google_cloud` connector protocol for GCP Vertex AI (ml-commons opensearch-project#4921), which mints and refreshes GCP OAuth2 tokens automatically, mirroring the existing `aws_sigv4` strategy. To keep cloud-provider auth protocols symmetric, connector protocols are now documented as peer child pages under Connectors rather than as inline sections of one page: - Add gcp-connectors.md: the google_cloud protocol, the plugins.ml_commons.connector.vertexai_enabled prerequisite, both auth modes (service-account key and ADC / Workload Identity), and credential/parameter options. - Move the Amazon SageMaker and Bedrock (aws_sigv4) examples out of connectors.md into a dedicated aws-connectors.md, regrouped so the AWS content is contiguous, with redirect_from for the old anchors. - Make connectors.md a parent page: shared concepts plus a "Native cloud provider authentication protocols" list linking the child pages, an updated page title, and a Google Cloud Vertex AI entry in the platform list. - Replace the legacy manual-token Vertex AI row in supported-connectors.md with the four new google_cloud blueprints (Gemini, embeddings, streaming, batch). Also fixes a pre-existing nav bug: guardrails.md declared has_children: true with no child pages, rendering an empty expand control in the sidebar. Signed-off-by: Tony Piazza <tony.piazza@aiven.io>
tonypiazza
requested review from
cwperks,
dlvenable,
epugh,
kolchfa-aws,
mgodwan,
peterzhuamazon and
sumobrian
as code owners
August 27, 2026 12:17
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
tonypiazza
changed the title
Collaborator
|
@jiapingzeng @mingshl Could you review this PR? |
Collaborator
|
@tonypiazza Is this going into 3.9? |
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
2 participants
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.
Description
Documents the new first-class
google_cloudconnector protocol for Google Cloud Vertex AI, added in ml-commons (opensearch-project/ml-commons#4921). The protocol mints and refreshes GCP OAuth2 access tokens automatically, mirroring the existingaws_sigv4strategy, so users no longer supply or rotate an access token by hand.To keep cloud-provider authentication protocols symmetric and prevent the Connectors page from growing unbounded as more providers are added, connector protocols are now documented as peer child pages under Connectors rather than as inline sections of a single page:
gcp-connectors.md— thegoogle_cloudprotocol: theplugins.ml_commons.connector.vertexai_enabledprerequisite (disabled by default), both authentication modes (service-account key and Application Default Credentials / Workload Identity), and the credential and parameter options.aws-connectors.md— the existing Amazon SageMaker and Bedrock (aws_sigv4) examples, moved out ofconnectors.mdand regrouped so the AWS content is contiguous, withredirect_fromentries for the old anchors.connectors.md— now a parent page holding shared concepts plus a "Native cloud provider authentication protocols" list linking the child pages, an updated page title, and a Google Cloud Vertex AI entry in the platform list.supported-connectors.md— replaces the legacy manual-token Vertex AI row with the four newgoogle_cloudblueprints (Gemini, embeddings, streaming, batch).Additionally fixes a small pre-existing navigation bug:
guardrails.mddeclaredhas_children: truewith no child pages, which rendered an empty expand control in the sidebar. Called out here since it touches a file outside the Vertex AI change.Issues Resolved
N/A
Version
3.x (
latest)Frontend features
N/A
Checklist