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

doc(storage-example-configs): AWS single store configs #6196

Merged
merged 2 commits into from
May 20, 2022

Conversation

kavirajk
Copy link
Contributor

What this PR does / why we need it:
Our example configs are bit misleading here. Particularly AWS deployment.
https://grafana.com/docs/loki/latest/storage/#examples

As a new user, I come here and all I can conclude is, we cannot use s3 as a single store under AWS deployment. Doc seems to recommend AWS deployment always needs S3 + DynamoDB.
(in fact it was real confusion for new user from the community)

https://grafana.slack.com/archives/CEPJRLQNL/p1652867888720979

Signed-off-by: Kaviraj kavirajkanagaraj@gmail.com

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Documentation added

Our example configs are bit misleading here. Particularly AWS deployment.
https://grafana.com/docs/loki/latest/storage/#examples

As a new user, I come here and all I can conclude is, we cannot use s3 as a single store under AWS deployment. Doc seems to recommend AWS deployment always  needs S3 + DynamoDB.
(in fact it was real confusion for new user from the community)

https://grafana.slack.com/archives/CEPJRLQNL/p1652867888720979

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>
@kavirajk kavirajk marked this pull request as ready for review May 19, 2022 09:24
@grafanabot
Copy link
Collaborator

./tools/diff_coverage.sh ../loki-main/test_results.txt test_results.txt ingester,distributor,querier,querier/queryrange,iter,storage,chunkenc,logql,loki

Change in test coverage per package. Green indicates 0 or positive change, red indicates that test coverage for a package fell.

+           ingester	0%
-        distributor	-0.3%
+            querier	0%
+ querier/queryrange	0%
+               iter	0%
+            storage	0%
+           chunkenc	0%
+              logql	0%
+               loki	0%

Copy link
Contributor

@sandeepsukhani sandeepsukhani left a comment

Choose a reason for hiding this comment

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

Thanks for fixing it! One minor change, store under schema_config.configs needs to be update to boltdb-shipper

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>
Copy link
Contributor

@sandeepsukhani sandeepsukhani left a comment

Choose a reason for hiding this comment

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

LGTM

@grafanabot
Copy link
Collaborator

./tools/diff_coverage.sh ../loki-main/test_results.txt test_results.txt ingester,distributor,querier,querier/queryrange,iter,storage,chunkenc,logql,loki

Change in test coverage per package. Green indicates 0 or positive change, red indicates that test coverage for a package fell.

+           ingester	0%
+        distributor	0.3%
+            querier	0%
+ querier/queryrange	0%
+               iter	0%
+            storage	0%
+           chunkenc	0%
+              logql	0%
+               loki	0%

@kavirajk kavirajk added the backport release-2.5.x Tag a PR with this label to create a PR which cherry pics it into the release-2.5.x branch label May 19, 2022
@sandeepsukhani sandeepsukhani merged commit a58dc3f into main May 20, 2022
@sandeepsukhani sandeepsukhani deleted the kavirajk/config-examples-aws-deployment branch May 20, 2022 07:05
grafanabot pushed a commit that referenced this pull request May 20, 2022
* doc(storage-example-configs): AWS single store configs

Our example configs are bit misleading here. Particularly AWS deployment.
https://grafana.com/docs/loki/latest/storage/#examples

As a new user, I come here and all I can conclude is, we cannot use s3 as a single store under AWS deployment. Doc seems to recommend AWS deployment always  needs S3 + DynamoDB.
(in fact it was real confusion for new user from the community)

https://grafana.slack.com/archives/CEPJRLQNL/p1652867888720979

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Update schema_config.configs.store

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>
(cherry picked from commit a58dc3f)
kavirajk added a commit that referenced this pull request May 20, 2022
* doc(storage-example-configs): AWS single store configs

Our example configs are bit misleading here. Particularly AWS deployment.
https://grafana.com/docs/loki/latest/storage/#examples

As a new user, I come here and all I can conclude is, we cannot use s3 as a single store under AWS deployment. Doc seems to recommend AWS deployment always  needs S3 + DynamoDB.
(in fact it was real confusion for new user from the community)

https://grafana.slack.com/archives/CEPJRLQNL/p1652867888720979

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>

* Update schema_config.configs.store

Signed-off-by: Kaviraj <kavirajkanagaraj@gmail.com>
(cherry picked from commit a58dc3f)

Co-authored-by: Kaviraj Kanagaraj <kavirajkanagaraj@gmail.com>
@osg-grafana osg-grafana added type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories and removed area/docs labels Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-2.5.x Tag a PR with this label to create a PR which cherry pics it into the release-2.5.x branch 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.

4 participants