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.

Sign up for GitHub

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: Updated bucket names and added warning #13347

Merged
merged 7 commits into from
Jul 1, 2024
Merged

docs: Updated bucket names and added warning #13347

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
30712aa
hotfix: Updated bucket names and added warning
Jayclifford345 Jun 27, 2024
955c2f8
Update docs/sources/setup/install/helm/install-microservices/_index.md
Jayclifford345 Jul 1, 2024
5dbb915
Update docs/sources/setup/install/helm/install-scalable/_index.md
Jayclifford345 Jul 1, 2024
994c063
Updated microservices with suggestion
Jayclifford345 Jul 1, 2024
ff83592
Updated simple scalable with suggestion
Jayclifford345 Jul 1, 2024
b4b1c54
Update docs/sources/setup/install/helm/install-scalable/_index.md
JStickler Jul 1, 2024
7cbe047
Fixed Typo
Jayclifford345 Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/sources/setup/install/helm/install-microservices/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,10 @@ It is not recommended to run scalable mode with `filesystem` storage. For the pu

After testing Loki with MinIO, it is recommended to configure Loki with an object storage provider. The following examples shows how to configure Loki with different object storage providers:

{{< admonition type="note" >}}
Jayclifford345 marked this conversation as resolved.
Show resolved Hide resolved
When deploying Loki using S3 Storage **DO NOT** use the default bucket names; `chunk`, `ruler` and `admin`. Choose a unique name for each bucket. For more information see the following [security update](https://grafana.com/blog/2024/06/27/grafana-security-update-grafana-loki-and-unintended-data-write-attempts-to-amazon-s3-buckets/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine when using MinIO and we still use & ~recommend it there as it's easiest. Not sure if or how to reflect that properly

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two ideas (I think the second is probably the clearest).
Option ONE
"When deploying Loki using S3 Storage without MinIO DO NOT use the default bucket names; chunk, ruler and admin. Choose a unique name for each bucket. For more information see the following security update."

Option TWO
When deploying Loki using S3 Storage DO NOT use the default bucket names; chunk, ruler and admin. Choose a unique name for each bucket. For more information see the following security update. This caution does not apply when you are using MinIO. When using MinIO we recommend using the default bucket names."

{{< /admonition >}}

{{< code >}}

```s3
Expand All @@ -192,9 +196,9 @@ After testing Loki with MinIO, it is recommended to configure Loki with an objec
storage:
type: s3
bucketNames:
chunks: "chunks"
ruler: "ruler"
admin: "admin"
chunks: "<INSERT BUCKET NAME>"
ruler: "<INSERT BUCKET NAME>"
admin: "<INSERT BUCKET NAME>"
s3:
# s3 URL can be used to specify the endpoint, access key, secret key, and bucket name
s3: s3://access_key:secret_access_key@custom_endpoint/bucket_name
Expand Down
10 changes: 7 additions & 3 deletions docs/sources/setup/install/helm/install-scalable/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,10 @@ It is not recommended to run scalable mode with `filesystem` storage. For the pu

After testing Loki with MinIO, it is recommended to configure Loki with an object storage provider. The following examples shows how to configure Loki with different object storage providers:

{{< admonition type="note" >}}
Jayclifford345 marked this conversation as resolved.
Show resolved Hide resolved
When deploying Loki using S3 Storage **DO NOT** use the default bucket names; `chunk`, `ruler` and `admin`. Choose a unique name for each bucket. For more information see the following [security update](https://grafana.com/blog/2024/06/27/grafana-security-update-grafana-loki-and-unintended-data-write-attempts-to-amazon-s3-buckets/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

{{< /admonition >}}

{{< code >}}

```s3
Expand All @@ -151,9 +155,9 @@ loki:
storage:
type: s3
bucketNames:
chunks: "chunks"
ruler: "ruler"
admin: "admin"
chunks: "<INSERT BUCKET NAME>"
ruler: "<INSERT BUCKET NAME>"
admin: "<INSERT BUCKET NAME>"
s3:
# s3 URL can be used to specify the endpoint, access key, secret key, and bucket name
s3: s3://access_key:secret_access_key@custom_endpoint/bucket_name
Expand Down
Loading