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.

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

Initiate node sizing docs #5018

Merged
merged 5 commits into from
May 23, 2024
Merged

Initiate node sizing docs #5018

merged 5 commits into from
May 23, 2024

Conversation

rdettai
Copy link
Contributor

@rdettai rdettai commented May 21, 2024

Description

Add a doc entry to help users dimension their QW clusters.

How was this PR tested?

Describe how you tested this PR.

@rdettai rdettai self-assigned this May 21, 2024
@rdettai rdettai added the documentation Improvements or additions to documentation label May 21, 2024
@rdettai rdettai requested a review from guilload May 22, 2024 07:46
@rdettai rdettai marked this pull request as ready for review May 22, 2024 08:04
Copy link
Member

@guilload guilload left a comment

Choose a reason for hiding this comment

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

I suggest we move this guide to the deployment section.

docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
Copy link
Member

@guilload guilload left a comment

Choose a reason for hiding this comment

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

Looking good.

I'd add a warning "you mileage may vary blabla, use this guide to establish baseline and increase or decrease the resources depending on your workload."

I would remove the file-backed section and create a dedicated metastore section with two subsections one for the service and one for the database. Up to you.

docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
docs/get-started/node-sizing.md Outdated Show resolved Hide resolved
@rdettai
Copy link
Contributor Author

rdettai commented May 23, 2024

create a dedicated metastore section with two subsections one for the service and one for the database

In many setups, the Postgres config will be a bit separate from the QW cluster config (e.g they might have different lifecycles, so live in different terraform scripts). So I think its more readable for the typical ops user to have the sizing suggestions organized accordingly.

@rdettai rdettai force-pushed the node-sizing-docs branch from 0d61218 to 265762e Compare May 23, 2024 08:28
@rdettai rdettai enabled auto-merge (squash) May 23, 2024 08:37
@rdettai rdettai merged commit 9986a3b into main May 23, 2024
5 checks passed
@rdettai rdettai deleted the node-sizing-docs branch May 23, 2024 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants