docs: document credentials_base64 and add Google Cloud Storage monitoring guide - #11395
Open
AvilaJulio wants to merge 1 commit into
Open
docs: document credentials_base64 and add Google Cloud Storage monitoring guide#11395AvilaJulio wants to merge 1 commit into
AvilaJulio wants to merge 1 commit into
Conversation
Google Cloud Storage was listed as a supported monitoring integrations sink, but the docs never explained how to authenticate it. The `gcp_cloud_storage` sink needs a service account key on disk via `credentials_path`, and files can't be uploaded to a deployment, so the supported path was undiscoverable. Document the `credentials_base64` sink option, which accepts a Base64-encoded JSON key (inline or as a `$CUBE_CLOUD_MONITORING_*` env var reference) and is mounted into the Vector agent at `/etc/credentials/<sink name>.json`. - Add a "Credentials files" section to the monitoring integrations overview, including the lowercase/no-underscore sink naming constraint and a note that sinks authenticate independently from data source credentials (a BigQuery service account is not reused for log export). - Add a Google Cloud Storage guide with service account setup, log export, Query History export, and troubleshooting. - Register the new page in docs.json and the overview card group. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
RusovDmitriy
approved these changes
Jul 28, 2026
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.
Problem
Google Cloud Storage is listed as a supported sink on the Monitoring Integrations page, but the docs never explain how to authenticate it.
The
gcp_cloud_storagesink reads a service account key from a file path (credentials_path), and falls back toGOOGLE_APPLICATION_CREDENTIALSor the instance service account. None of those are actionable for a customer: you can't upload a file to a deployment, and the Vector agent runs in Cube's infrastructure, so the instance service account isn't in the customer's GCP project.The supported mechanism — the
credentials_base64sink option — was undocumented, so the feature was effectively undiscoverable. This came up in a customer question that also surfaced a related misconception: that the BigQuery data source service account is reused for log export.Changes
New page —
admin/monitoring/monitoring-integrations/gcs.mdx, following the structure of the existing S3 and CloudWatch guides: service account setup, log export, Query History export, and troubleshooting.Overview page — new
Credentials filessection documentingcredentials_base64generically, since the option is sink-agnostic (onlycredentials_pathis GCP-specific). It accepts a Base64-encoded JSON credentials file, either inline or as a$CUBE_CLOUD_MONITORING_*environment variable reference, and is mounted into the Vector agent at/etc/credentials/<sink name>.json.Also documented, because both generate support tickets:
credentials_base64must be named with lowercase letters, numbers, and dashes only — the sink name becomes a Kubernetes object name, so[sinks.gcp_cloud_storage]silently fails.Navigation — registered in
docs.jsonand added a card to the overview card group.Verification
docs.jsonparses as valid JSON; the diff is a single added line.scripts/check_links.pyreports no broken links in either changed file. (It reports many pre-existing failures elsewhere in the repo, unrelated to this change.)#credentials-files,#query-history-export,#environment-variables) verified to exist.Behavior documented here was read off the
credentials_base64handling in the Cube Cloud operator rather than inferred, including the accepted value forms, the JSON validation step, the mount path, and the sink naming constraint.🤖 Generated with Claude Code