-
Notifications
You must be signed in to change notification settings - Fork 781
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: Rewrite Getting Started to use docker-compose, kind, and helm #5951
docs: Rewrite Getting Started to use docker-compose, kind, and helm #5951
Conversation
Signed-off-by: Charlie Le <charlie_le@apple.com>
Signed-off-by: Charlie Le <charlie_le@apple.com>
Signed-off-by: Charlie Le <charlie_le@apple.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR, great start
I have never heard of garage. it puts me at unease that is AGPL licensed
Do you think we can change garage for minio?. The reason for that is minio is already used in the e2e tests.
Probably a better option is https://github.com/seaweedfs/seaweedfs because of the LICENSE but I have never tried it either.
Signed-off-by: Charlie Le <charlie_le@apple.com>
Minio is also AGPLv3. I've updated the guide to use SeaweedFS. Thanks for the suggestion. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for implementing of the suggestion 🙇 !. I found more things though
|
||
# You can choose between local storage and Amazon S3, Google GCS and Azure storage. Each option requires additional configuration | ||
# as shown below. All options can be configured via flags as well which might be handy for secret inputs. | ||
backend: filesystem # s3, gcs, azure or filesystem are valid options |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
backend: filesystem # s3, gcs, azure or filesystem are valid options | |
backend: s3 # s3, gcs, azure or filesystem are valid options |
Because we want to use seaweed right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is for the docker composer example. However, I could have it use seaweedfs here as well to make it match.
filesystem: | ||
dir: ./data/tsdb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
filesystem: | |
dir: ./data/tsdb | |
#filesystem: | |
# dir: ./data/tsdb |
@@ -0,0 +1,90 @@ | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
target: all, compactor |
compactor is not started by default
- use SeaweedFS - add healthcheck - documentation Signed-off-by: Charlie Le <charlie_le@apple.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah filesystem is not something we should be promoting in general. People get the idea that they can use that for production, for some reason.
Looks pretty enough for me!
In a follow up PR we can try adding a e2e test for this
Nice! Thanks for this! |
What this PR does:
Rewrites the Getting Started guide to use docker-compose, kind, and helm. We are vendoring the values files for helm charts to make it easier to experiment with different settings. Additionally, we make use of Garage as an S3-compatible endpoint to facilitate local testing without any online dependencies.
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]