Updated diagrams on the architecture page #1459

09jvilla · 2022-03-10T23:41:42Z

Removed the diagram at the top of the architecture page, since we have almost the same diagram on the deployment-modes.md page under the 'microservices' header.

Replaced the read and write diagrams with svg files (formerly png) for higher resolution. Changed the background to white since @pstibrany pointed out it improves the contrast.

For the read diagram, I added a bubble to represent the caches, with the caches labeled as optional.

Since we have no overall architecture diagram which shows the ruler (the one on deployment-modes.md excludes the optional components), I added a ruler specific diagram to the ruler.md page.

All diagrams come from here:
https://docs.google.com/presentation/d/1LemaTVqa4Lf_tpql060vVoDGXrthp-Pie_SQL7qwHjc/edit

Fixes #1192 and replaces #1360

RichiH

The arrows to/from "cache" should arguably go both ways, else LGTM.

pstibrany · 2022-03-11T08:17:35Z

Thank for you addressing my feedback from the other PR.

"black text on red background" combination used for caches still looks strange to my eyes.
Can we change orange arrows to black ones in Read diagram? (Thin orange lines are not very contrasting on white background)
When I view the original SVG files in Safari and Firefox I see:
Read path

Ruler

Write path

pracucci

Love it! The diagrams look good to me.

[not a blocker, can be done in a follow up PR] The diagrams in the deployment modes page still have the gray background. Can we remove the background from there too?

pracucci · 2022-03-11T11:18:18Z

When I view the original SVG files in Safari and Firefox I see:

Same happen to me when I look at the raw file from github, but if I compile the website make docs and navigate though it, the images are displayed correctly.

pstibrany

Forgot to send my comment.

pstibrany · 2022-03-11T08:06:18Z

docs/sources/architecture/_index.md

@@ -11,13 +11,9 @@ The system has multiple horizontally scalable microservices that can run separat
 Grafana Mimir microservices are called components.

 Grafana Mimir's design compiles the code for all components into a single binary.
-The `-target` parameter controls which component that single binary will behave as. For those looking for a simple way to get started, Grafana Mimir can also be run as a monolith, with all components running simultaneously in one process.
+The `-target` parameter controls which component that single binary will behave as. For those looking for a simple way to get started, Grafana Mimir can also be run in monolithic mode, with all components running simultaneously in one process.


This is configured using -target=all, should it be mentioned?

that is mentioned in the deployment-modes.md file so I'm going to leave it off. I add a link to that section of the docs under "monolithic mode"

pstibrany · 2022-03-11T08:07:00Z

docs/sources/architecture/_index.md

@@ -11,13 +11,9 @@ The system has multiple horizontally scalable microservices that can run separat
 Grafana Mimir microservices are called components.

 Grafana Mimir's design compiles the code for all components into a single binary.
-The `-target` parameter controls which component that single binary will behave as. For those looking for a simple way to get started, Grafana Mimir can also be run as a monolith, with all components running simultaneously in one process.
+The `-target` parameter controls which component that single binary will behave as. For those looking for a simple way to get started, Grafana Mimir can also be run in monolithic mode, with all components running simultaneously in one process.


The -target parameter controls which componentS ...

I'd use plural, as it is possible to use -target=compactor,ingester for example.

Good point. I will updated to component(s)

Logiraptor

Just left some minor feedback. Looks good!

Logiraptor · 2022-03-11T16:04:50Z

docs/sources/architecture/_index.md

@@ -11,13 +11,9 @@ The system has multiple horizontally scalable microservices that can run separat
 Grafana Mimir microservices are called components.

 Grafana Mimir's design compiles the code for all components into a single binary.
-The `-target` parameter controls which component that single binary will behave as. For those looking for a simple way to get started, Grafana Mimir can also be run as a monolith, with all components running simultaneously in one process.
+The `-target` parameter controls which component that single binary will behave as. For those looking for a simple way to get started, Grafana Mimir can also be run in monolithic mode, with all components running simultaneously in one process.


Suggested change

The `-target` parameter controls which component that single binary will behave as. For those looking for a simple way to get started, Grafana Mimir can also be run in monolithic mode, with all components running simultaneously in one process.

The `-target` parameter controls which components that single binary will behave as. For those looking for a simple way to get started in a development environment, Grafana Mimir can also be run in monolithic mode by setting `-target=all`. This will run the minimally required components in one process.

Just clarified that monolithic mode is for development only and it technically doesn't run everything, just the minimally necessary components.

Just clarified that monolithic mode is for development only and it technically doesn't run everything, just the minimally necessary components.

I don't think that's true. It's not for development only, and it actually runs most of the components. Notably missing is alertmanager, but it's easy to enable it as well. (-target=all,alertmanager).

While it's not recommended for production, because it's easier to control resources of individual components, it's absolutely possible to use Mimir that way.

Fair enough, I was thinking of this from a support perspective at Grafana Labs, but you're right that it can work.

@pstibrany @Logiraptor we already have some of this information in deployment-modes.md file so I'm going to leave it off.

09jvilla · 2022-03-12T21:57:59Z

@pstibrany changed all the arrows to be black and updated the cache to be the same color as the object store to help improve readability. Lemme know if you think its good to go.

09jvilla · 2022-03-12T22:20:37Z

@pracucci - I think this might be related to your relref observation/proposal for how to rework things but I see that the diagram on the ruler.md page renders correctly when I run make docs but it does not render correctly if I just look at the markdown on Github.

pracucci · 2022-03-14T08:43:03Z

@pracucci - I think this might be related to your relref observation/proposal for how to rework things but I see that the diagram on the ruler.md page renders correctly when I run make docs but it does not render correctly if I just look at the markdown on Github.

Right now, due to how URLs are built in grafana.com website, either we make it work for GitHub or grafana.com. We obviously need images working in grafana.com so we start prioritizing them. At the moment, the docs/ in this repo should be seen as "source code", while doc is expected to be read through grafana.com (or locally via make docs while writing doc).

pracucci

LGTM, thanks!

…iagram. Adding ruler diagram.

Signed-off-by: Marco Pracucci <marco@pracucci.com>

pracucci · 2022-03-14T15:09:29Z

I rebased and fixed conflicts.

* Refreshing read and write diagrams and removing parent architecture diagram. Adding ruler diagram. * Moved images Signed-off-by: Marco Pracucci <marco@pracucci.com> Co-authored-by: Marco Pracucci <marco@pracucci.com>

09jvilla mentioned this pull request Mar 11, 2022

Updating architecture diagram with newer picture. #1360

Closed

09jvilla requested review from pracucci, jdbaldry, pstibrany, Logiraptor, RichiH and bboreham March 11, 2022 04:04

RichiH approved these changes Mar 11, 2022

View reviewed changes

pracucci approved these changes Mar 11, 2022

View reviewed changes

pstibrany reviewed Mar 11, 2022

View reviewed changes

Logiraptor approved these changes Mar 11, 2022

View reviewed changes

09jvilla requested a review from pstibrany March 12, 2022 21:56

09jvilla requested a review from chri2547 March 12, 2022 21:59

09jvilla mentioned this pull request Mar 12, 2022

Diagrams for deployment-modes page updated to remove grey background #1471

Merged

pracucci approved these changes Mar 14, 2022

View reviewed changes

pracucci force-pushed the overall-diagram-2 branch from 66c9062 to a3f56a5 Compare March 14, 2022 14:57

09jvilla and others added 2 commits March 14, 2022 15:59

Refreshing read and write diagrams and removing parent architecture d…

b4c142e

…iagram. Adding ruler diagram.

Moved images

e0dc3ee

Signed-off-by: Marco Pracucci <marco@pracucci.com>

pracucci force-pushed the overall-diagram-2 branch from a3f56a5 to e0dc3ee Compare March 14, 2022 15:07

chri2547 approved these changes Mar 14, 2022

View reviewed changes

pracucci merged commit 7252d08 into main Mar 14, 2022

pracucci deleted the overall-diagram-2 branch March 14, 2022 16:13

pracucci mentioned this pull request Mar 21, 2022

Prepare 2.0.0-rc.4 #1515

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated diagrams on the architecture page #1459

Updated diagrams on the architecture page #1459

09jvilla commented Mar 10, 2022 •

edited

Loading

RichiH left a comment

pstibrany commented Mar 11, 2022

pracucci left a comment

pracucci commented Mar 11, 2022

pstibrany left a comment

pstibrany Mar 11, 2022

09jvilla Mar 12, 2022

pstibrany Mar 11, 2022

09jvilla Mar 12, 2022

Logiraptor left a comment

Logiraptor Mar 11, 2022

pstibrany Mar 11, 2022

Logiraptor Mar 11, 2022

09jvilla Mar 12, 2022

09jvilla commented Mar 12, 2022 •

edited

Loading

09jvilla commented Mar 12, 2022

pracucci commented Mar 14, 2022

pracucci left a comment

pracucci commented Mar 14, 2022

	The `-target` parameter controls which component that single binary will behave as. For those looking for a simple way to get started, Grafana Mimir can also be run in monolithic mode, with all components running simultaneously in one process.
	The `-target` parameter controls which components that single binary will behave as. For those looking for a simple way to get started in a development environment, Grafana Mimir can also be run in monolithic mode by setting `-target=all`. This will run the minimally required components in one process.

Updated diagrams on the architecture page #1459

Updated diagrams on the architecture page #1459

Conversation

09jvilla commented Mar 10, 2022 • edited Loading

RichiH left a comment

Choose a reason for hiding this comment

pstibrany commented Mar 11, 2022

pracucci left a comment

Choose a reason for hiding this comment

pracucci commented Mar 11, 2022

pstibrany left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Logiraptor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

09jvilla commented Mar 12, 2022 • edited Loading

09jvilla commented Mar 12, 2022

pracucci commented Mar 14, 2022

pracucci left a comment

Choose a reason for hiding this comment

pracucci commented Mar 14, 2022

09jvilla commented Mar 10, 2022 •

edited

Loading

09jvilla commented Mar 12, 2022 •

edited

Loading