-
Notifications
You must be signed in to change notification settings - Fork 537
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
Add a docker-compose local setup to fully test Mimir #1049
Conversation
Removed |
4ab2d4f
to
72df0fd
Compare
Well, the plan was to write a documentation page too but it hasn't been written yet (reason why PR is still a draft). |
@KMiller-Grafana, this looks like it is in your court because it relates to configuration. I agree with you that this should not be in the user documentation. |
72df0fd
to
d45db53
Compare
d45db53
to
62a8cd2
Compare
docs/configurations/demo-with-docker-compose/docker-compose.yml
Outdated
Show resolved
Hide resolved
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.
I like how simple the config is.
docs/configurations/demo-with-docker-compose/docker-compose.yml
Outdated
Show resolved
Hide resolved
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 looks good to me.
I spun it up on Ubuntu 20.04 and I can successfully access Grafana and query some of the metrics
Shall we add a script that starts all of this ( |
I think you've approved too quickly. This will come along with a tutorial I'm going to write. It also miss some config, like Alertmanager sharding. |
I approved because I'm perfectly fine merging this in the current state and iterating on it over next several PRs. |
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.
Please move this to a demo
subdirectory and out of docs/sources/
.
This should publish out of grafana/tutorials after the Mimir launch as the tutorials repo is public. For now, we should move the file out of the /docs directory to avoid issues with the docs publication pipeline. I'm happy to work with you on this, @pracucci to make it sparkle. The template for tutorials was created some time ago, but it can be a guide and something I'm open to refining along the way (as long as it doesn't slow us down too much). |
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.
Unblocking with the assumption that it is moved out of the docs/
directory.
67c63d9
to
763b066
Compare
@GrafanaWriter @osg-grafana I've moved it outside of docs/ and I've written a tutorial. As noted in the PR description, I've try to follow the Grafana tutorial style, but I haven't used tutorial markdown syntax yet given for the moment it won't be published as a Grafana tutorial. Could I get your review, please? |
@pstibrany @replay This PR is now ready to review. The tutorial and docker-compose setup includes everything I had in mind when I started working on it. Could you take another look, please? |
b05e71a
to
a07fdbc
Compare
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 writing this, @pracucci, and for adopting/adapting the template. Please let me know of any questions or comments.
b048ea6
to
c330ff3
Compare
Thanks @GrafanaWriter for your review. I've accepted most suggestions and replied to a couple of them. Could you take another look, please? |
Signed-off-by: Marco Pracucci <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Fiona Artiaga <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Fiona Artiaga <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]> Co-authored-by: Jennifer Villa <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]>
e641c0a
to
ef432db
Compare
Very good point. Changed to I've also accepted all suggestions. |
Signed-off-by: Marco Pracucci <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]>
I did follow the tutorial one last time and looks good to me. I'm going to merge this PR. Edit: I will add the integration test of the config in a follow up PR and the diagram to the tutorial once ready. |
What this PR does:
In this PR I propose to introduce a docker-compose local setup (based on single binary and memberlist) to allow the community to have a quick way to try the latest stable release of Mimir in a HA setup. It also runs Prometheus (used both to scrape Mimir metrics and run recording rules) as well as Grafana with our dashboard provisioned.
The PR includes a tutorial-style
README.md
guiding the user step-by-step. I've try to follow the Grafana tutorial style, but I haven't used tutorial markdown syntax given for the moment won't be published as a Grafana tutorial.Which issue(s) this PR fixes:
Fixes #991
Fixes #1024
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]