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.

Sign up for GitHub

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

Jump to bottom

docs: Replace SSD sizing tool with cluster tiers for distributed/microservices mode #15820

Merged
merged 13 commits into from
Jan 23, 2025
Merged

docs: Replace SSD sizing tool with cluster tiers for distributed/microservices mode #15820

merged 13 commits into from
Jan 23, 2025

Conversation

poyzannur
Copy link
Contributor

@poyzannur poyzannur commented Jan 17, 2025 •
edited
Loading

What this PR does / why we need it:
We are retiring the existing loki sizing tool for SSD mode sizing which was inaccurate.
This PR replaces the tool with a guide to size 3 tiers for Loki clusters based on their expected ingestion patterns. It Adds general notes and guidelines for query performance.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:
Follow up PRs will add

  • retire the code for the sizing tool.
  • guide for RAM based and Disk Based memcached sizing to this doc.
  • update node types on this doc.

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jan 17, 2025
@poyzannur poyzannur changed the title add new tables Update cluster sizing page for distributed/microservices mode Jan 17, 2025
@poyzannur poyzannur changed the title Update cluster sizing page for distributed/microservices mode docs: Update cluster sizing page for distributed/microservices mode Jan 17, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 17, 2025 •
edited
Loading

💻 Deploy preview deleted.

@poyzannur poyzannur force-pushed the poyzan/update-sizing-calculator branch 2 times, most recently from fd55781 to 2032ba6 Compare January 17, 2025 21:03
@JStickler
Copy link
Contributor

Looking at the preview for this, we probably want to add some instructions so that people know what to do with the information presented here.
I would add a line before the "Node Type?" that says something like, "Select your node type from the following menu." and then before the table add an explanation of what's being displayed in the table, and also make it clear that there are three tabs, because the UI indicator is rather subtle.

@poyzannur poyzannur marked this pull request as ready for review January 20, 2025 16:28
@poyzannur poyzannur requested a review from a team as a code owner January 20, 2025 16:28
@poyzannur poyzannur changed the title docs: Update cluster sizing page for distributed/microservices mode docs: Replace SSD sizing tool with cluster tiers for distributed/microservices mode Jan 20, 2025
@poyzannur poyzannur force-pushed the poyzan/update-sizing-calculator branch from 33bc13f to 995f7a4 Compare January 22, 2025 11:58
Jayclifford345
Jayclifford345 reviewed Jan 22, 2025
View reviewed changes
Copy link
Contributor

@Jayclifford345 Jayclifford345 left a comment

Choose a reason for hiding this comment

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

Just a couple of notes from me! Such a great win for the docs @poyzannur !

docs/sources/setup/size/_index.md Show resolved Hide resolved
docs/sources/setup/size/_index.md Outdated Show resolved Hide resolved
Jayclifford345
Jayclifford345 reviewed Jan 22, 2025
View reviewed changes
docs/sources/setup/size/_index.md Outdated

<blockquote v-if="help">
<span v-if="help === 'ingest'">
Defines the log volume in gigabytes, ie 1e+9 bytes, expected to be ingested each day.
</span>
<span v-else-if="help === 'node'">
Defines the node type of the Kubernetes cluster. Is a vendor or type
Copy link
Contributor

Choose a reason for hiding this comment

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

Just looking at how this renders:
https://deploy-preview-loki-15820-zb444pucvq-vp.a.run.app/docs/loki/latest/setup/size/

I wonder if we move this span up and change the wording

<span v-else-if="help === 'node'">
We currently recommend these nodes when running a production cluster of Loki. If a vendor, type or latest release is missing please let us know!
</span>

Copy link
Contributor

Choose a reason for hiding this comment

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

I just checked the preview, yeah, we need to do something about hiding line 76 and 77 in the generated output.

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, if we're not computing a value, do we need to include anything after line 71? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

+1 we can totally remove it.

Jayclifford345
Jayclifford345 approved these changes Jan 22, 2025
View reviewed changes
Copy link
Contributor

@Jayclifford345 Jayclifford345 left a comment

Choose a reason for hiding this comment

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

LGTM!

JStickler
JStickler approved these changes Jan 22, 2025
View reviewed changes
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] LGTM, just needs a few very small tweaks.

docs/sources/setup/size/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/size/_index.md Outdated Show resolved Hide resolved
docs/sources/setup/size/_index.md Outdated Show resolved Hide resolved
@poyzannur poyzannur merged commit e7cf1de into main Jan 23, 2025
62 checks passed
@poyzannur poyzannur deleted the poyzan/update-sizing-calculator branch January 23, 2025 11:48
loki-gh-app bot pushed a commit that referenced this pull request Jan 23, 2025
@poyzannur @grafana-delivery-bot
docs: Replace SSD sizing tool with cluster tiers for distributed/micr…
0cedceb 
…oservices mode (#15820)

Signed-off-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit e7cf1de)
@loki-gh-app loki-gh-app bot mentioned this pull request Jan 23, 2025
Merged
6 tasks
loki-gh-app bot pushed a commit that referenced this pull request Jan 23, 2025
@poyzannur @grafana-delivery-bot
docs: Replace SSD sizing tool with cluster tiers for distributed/micr…
3832afe 
…oservices mode (#15820)

Signed-off-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit e7cf1de)
loki-gh-app bot pushed a commit that referenced this pull request Jan 23, 2025
@poyzannur @grafana-delivery-bot
docs: Replace SSD sizing tool with cluster tiers for distributed/micr…
894c827 
…oservices mode (#15820)

Signed-off-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit e7cf1de)
@loki-gh-app loki-gh-app bot mentioned this pull request Jan 23, 2025
Merged
6 tasks
loki-gh-app bot pushed a commit that referenced this pull request Jan 23, 2025
@poyzannur @grafana-delivery-bot
docs: Replace SSD sizing tool with cluster tiers for distributed/micr…
b337d5a 
…oservices mode (#15820)

Signed-off-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit e7cf1de)
This was referenced Jan 23, 2025
Merged
Merged
This was referenced Jan 23, 2025
Merged
Merged
This was referenced Jan 23, 2025
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JStickler JStickler JStickler approved these changes

@Jayclifford345 Jayclifford345 Jayclifford345 approved these changes

Assignees
No one assigned
Labels
backport release-3.0.x backport release-3.1.x backport release-3.2.x backport release-3.3.x size/L type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@poyzannur @JStickler @Jayclifford345