docs: Replace SSD sizing tool with cluster tiers for distributed/microservices mode #15820
Conversation
github-actions
bot
added
the
type/docs
poyzannur
changed the title
poyzannur
changed the title
|
💻 Deploy preview available: https://deploy-preview-loki-15820-zb444pucvq-vp.a.run.app/docs/loki/latest/ |
poyzannur
force-pushed
the
poyzan/update-sizing-calculator
branch
2 times, most recently
from
fd55781 to
2032ba6
Compare
|
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. |
poyzannur
changed the title
poyzannur
force-pushed
the
poyzan/update-sizing-calculator
branch
from
33bc13f to
995f7a4
Compare
There was a problem hiding this comment.
Just a couple of notes from me! Such a great win for the docs @poyzannur !
| This tool helps to generate a Helm Charts `values.yaml` file based on specified | ||
| expected ingestion, retention rate and node type. It will always configure a | ||
| [scalable]({{< relref "../../get-started/deployment-modes#simple-scalable" >}}) deployment. The storage needs to be configured after generation. | ||
| This section is a guide to size base resource needs of a Loki cluster. |
There was a problem hiding this comment.
I can't select the right line as a comment but lines 2 - 4 will need to be removed so it appears in the docs
_build:
list: false
noindex: true
docs/sources/setup/size/_index.md
Outdated
|
|
||
| Based on the expected ingestion volume, Loki clusters can be categorised into three tiers. Recommendations below are based on p90 resource utilisations of the relevant components. Each tab represents a different tier. | ||
| Please use this document as a rough guide to specify CPU and Memory requests in your deployment. This is only documented for microservices/distributed mode at this time. |
There was a problem hiding this comment.
| Please use this document as a rough guide to specify CPU and Memory requests in your deployment. This is only documented for microservices/distributed mode at this time. | |
| Please use this document as a rough guide to specify CPU and Memory requests in your deployment. This is only documented for [microservices/distributed](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#microservices-mode) mode at this time. |
|
|
||
| <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 |
There was a problem hiding this comment.
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>
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
Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.mddeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PR