Skip to content

Update Console/Cortex requirements #602

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

juma-conduktor
Copy link
Contributor

This PR updates the Console documentation as follows:

  1. Adds minimum and recommended requirements for Cortex based on real customer usage
  2. Updates the documentation to show the Cortex is a mandatory part of the deployment
  3. Re-emphasises that we recommend block storage for historical metrics.

…state that Cortex container is not optional.
Copy link

vercel bot commented Jan 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
conduktor-docs ✅ Ready (Inspect) Visit Preview Apr 2, 2025 10:19am

Comment on lines +52 to +62
**Minimum**

- 4 CPU Cores
- 6 GB of RAM
- 10 GB of disk space

**Recommended**

- 8 CPU Cores
- 8+ GB of RAM
- [block storage](/platform/get-started/configuration/env-variables#monitoring-properties)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is weird to me. First, it doesn't match our defaults in the helm chart, so we're not consistent. Second, for the "recommended", I'd mention it should depend on the amount of metrics we're getting. We wrote a KB article to explain how to properly size it

Copy link
Contributor

Choose a reason for hiding this comment

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

Also I believe the disk space should depend on if we externalize the storage of the metrics or not. This leads to mentioning how long the metrics are persisted locally, how often they're pushed to the storage, ...

Copy link
Contributor Author

@juma-conduktor juma-conduktor Jan 23, 2025

Choose a reason for hiding this comment

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

This is a platform consistency problem which we are not trying to solve in this PR. Our Helm Charts are also not our official documentation, and while I agree they should be consistent, I can only fix one issue at a time.

In addition, every customer I encounter has different settings for Cortex, which causes a lot of problems/support cases. Based on the data I have gathered, I have made the above recommendations. Will these fit every use case, certainly not, however they will greatly reduce the number of issues our customers have hit over the past several months.

The KB article you mentioned, unfortunately, is too limited in scope when it comes to sizing. Simply knowing how many metrics you have and calculating the amount of RAM required, does not solve the majority of metrics issues I've encountered. It's certainly a good starting point when troubleshooting, but it's not a solution in and of itself in most cases.

The ultimate solution is for engineering to perform benchmarking and provide a sizing guide either in chart form or using a formula, along with the settings to adjust. I don't believe that will happen in the short or even medium term, so the goal here is to stop the bleeding as much as possible today.

I also think we need to completely re-evaluate how we think of and provide metrics in general, but again that is much bigger discussion, that has a lot more stake holders.

TL:DR - I hear you, however this PR is meant as a bandaid, as the other solutions will take more more time and energy with buy in from other stake holders.

Copy link
Contributor

Choose a reason for hiding this comment

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

The ultimate solution is for engineering to perform benchmarking and provide a sizing guide either in chart form or using a formula > YES

Completely agree with you, my point is just not to say "with this, it will work", but be a bit more nuanced and say "this is the recommended resources, but based on your infra you might need more or less. If this is not enough, because you have many topics, partitions etc, please consider adding more resources", or something like that, wdyt?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So do you think we should reduce the minimum here and leave the recommended as is, or should we adjust both?

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's reduce the minimum and leave the recommended, but add a sentence to explain this might depend on their infra, and that the bigger the cluster, the more resources they should give

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am happy to reduce the minimum and leave the recommended.

Copy link
Contributor

Choose a reason for hiding this comment

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

@AurelieMarcuzzo - good with the change?


The Console container provides the web interface while the Cortex container provides the metrics.

**Note:** It is not supported to run Console without the Cortex container.

Jump to:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we remove this mini-doc entirely? The right-hand navigation is there to help you navigate what's on the page; this seems unnecessary. We've also been removing these from other pages (like SNI routing), so would be good to keep consistency.

@RG-conduktor
Copy link
Collaborator

@juma-conduktor hey, is this PR ready to be completed? :)

@Stu-conduktor
Copy link
Contributor

@RG-conduktor - I suggest you add some of your minor text changes to resolve the Comments.
I've asked Aurelie about the main change which is the requirements at the top thread.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants