docs(thanos): add migration doc for thanos storage clients #16133
Conversation
github-actions
bot
added
the
type/docs
|
💻 Deploy preview available: https://deploy-preview-loki-16133-zb444pucvq-vp.a.run.app/docs/loki/latest/ |
|
|
||
| Loki 3.4 release introduces new object storage clients based on [Thanos Object Storage Client Go module](https://github.com/thanos-io/objstore). | ||
|
|
||
| One of the reasons for making this change is to have a consistent storage configuration across LGTM+ stack. If you are already using Grafana Mimir or Pyroscope, you can reuse the storage configuration for setting up Loki. |
There was a problem hiding this comment.
| One of the reasons for making this change is to have a consistent storage configuration across LGTM+ stack. If you are already using Grafana Mimir or Pyroscope, you can reuse the storage configuration for setting up Loki. | |
| One of the reasons for making this change is to have a consistent storage configuration across the entire Loki, Grafana, Tempo, and Loki stack (LGTM+). If you are already using Grafana Mimir or Pyroscope, you can reuse the same storage configuration for setting up Loki. |
Co-authored-by: J Stickler <[email protected]> Signed-off-by: Ashwanth <[email protected]>
| gcs: | ||
| bucket_name: my-gcs-bucket | ||
|
|
||
| # JSON either from a Google Developers Console client_credentials.json file, |
There was a problem hiding this comment.
This comment is confusing to me. Does this whole comment apply to the service_account? Shouldn't the input be a file.json of some sort?
Is there a typo at line 30? Should it read service_account: service-account.json instead?
There was a problem hiding this comment.
JSON either from a Google Developers Console client_credentials.json file,
or a Google Developers service account key. Needs to be valid JSON, not a
filesystem path.
only this portion of the comment applies to the service_account field. It expects the json contents, not a file path.
Rest of the comment mentions how the google SDK picks up credentials either from env or known file locations.
There was a problem hiding this comment.
i took this content from our configuration reference, didn't trim it down for the sake of completeness. we could rewrite this in both places if its confusing :)
https://grafana.com/docs/loki/next/configure/#thanos_object_store_config
There was a problem hiding this comment.
I think I read this over half a dozen times, and while the commented text made sense to me, I was having trouble match it to the parameter. But reading it over again, I think the commented text is clear enough, i was just stuck trying to match it to the example parameter.
If you don't want to rewrite the comment, maybe change line 31 to read
service_account: your-service-account.json ?
Co-authored-by: J Stickler <[email protected]> Signed-off-by: Ashwanth <[email protected]>
What this PR does / why we need it:
Adds a migration doc to enable Thanos storage clients. These will replace the existing storage clients in a future release.
I have documented the configuration changes required to migrate clients for commonly used storage backends such as gcs, s3 and azure.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.mddeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PR