Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added additional GCS authentication information (backport release-3.0.x) #15127

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

loki-gh-app[bot]
Copy link
Contributor

@loki-gh-app loki-gh-app bot commented Nov 26, 2024

Backport 39c47e5 from #15112


What this PR does / why we need it:

Added some basic info about GCS authentication.

Special notes for your reviewer:

Not all of Loki/GEL's services support ADC. I had to use loki.structuredConfig.admin_client.storage.gcs.service_account to force the Admin API to use service account credentials. It did not seem capable of utilizing GOOGLE_APPLICATION_CREDENTIALS.

I'm uncertain how to document this other than to exhaustive documentation. Maybe such detail is more appropriate in the Helm chart docs/examples?

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 39c47e5)
@loki-gh-app loki-gh-app bot requested a review from a team as a code owner November 26, 2024 15:58
@loki-gh-app loki-gh-app bot added backport size/S type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories labels Nov 26, 2024
@loki-gh-app loki-gh-app bot requested a review from JStickler November 26, 2024 15:58
@JStickler JStickler merged commit 8b5e56e into release-3.0.x Nov 26, 2024
52 of 55 checks passed
@JStickler JStickler deleted the backport-15112-to-release-3.0.x branch November 26, 2024 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport size/S type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants