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

Jump to bottom

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

merged 7 commits into from
Jul 1, 2024

Conversation

Jayclifford345
Copy link
Contributor

Fixed the naming convention for buckets within docs and added a warning linking to this security post:
https://grafana.com/blog/2024/06/27/grafana-security-update-grafana-loki-and-unintended-data-write-attempts-to-amazon-s3-buckets/

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
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • 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

@Jayclifford345 Jayclifford345 requested a review from a team as a code owner June 27, 2024 20:38
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jun 27, 2024
@Jayclifford345 Jayclifford345 changed the title doc: Updated bucket names and added warning fix: Updated bucket names and added warning Jun 27, 2024
@Jayclifford345 Jayclifford345 changed the title fix: Updated bucket names and added warning docs: Updated bucket names and added warning Jun 27, 2024
RichiH
RichiH reviewed Jul 1, 2024
View reviewed changes
docs/sources/setup/install/helm/install-microservices/_index.md Outdated
@@ -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" >}}
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."

RichiH
RichiH approved these changes Jul 1, 2024
View reviewed changes
Copy link
Member

@RichiH RichiH left a comment

Choose a reason for hiding this comment

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

LGTM taking the MinIO comments into account

docs/sources/setup/install/helm/install-scalable/_index.md Outdated
@@ -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" >}}
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

@Jayclifford345
Copy link
Contributor Author

I like the second one better! I have updated both pages to match

JStickler
JStickler approved these changes Jul 1, 2024
View reviewed changes
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] LTGM.

@grafanabot
Copy link
Collaborator

This PR must be merged before a backport PR will be created.

@JStickler JStickler merged commit 86fbfff into main Jul 1, 2024
61 checks passed
@JStickler JStickler deleted the hotfix-helm-docs branch July 1, 2024 14:34
grafanabot pushed a commit that referenced this pull request Jul 1, 2024
@Jayclifford345 @grafana-delivery-bot
docs: Updated bucket names and added warning (#13347)
19f82fe 
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 86fbfff)
@grafanabot grafanabot mentioned this pull request Jul 1, 2024
Merged
7 tasks
@JStickler JStickler mentioned this pull request Jul 19, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JStickler JStickler JStickler approved these changes

@RichiH RichiH RichiH approved these changes

Assignees
No one assigned
Labels
backport release-3.0.x size/S type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Jayclifford345 @grafanabot @RichiH @JStickler