Skip to content

[docs] Fix a typo in preset resource tables in the README's #1172

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
Merged
merged 1 commit into from
Jul 9, 2025
Merged

[docs] Fix a typo in preset resource tables in the README's #1172

merged 1 commit into from
Jul 9, 2025

Conversation

NickVolynkin
Copy link
Collaborator

@NickVolynkin NickVolynkin commented Jul 8, 2025 •
edited by coderabbitai bot
Loading

Signed-off-by: Nick Volynkin nick.volynkin@gmail.com

Summary by CodeRabbit

  • Documentation
    • Updated documentation across multiple applications to reflect a change in the CPU allocation for the "large" resource preset from 3 CPUs to 2 CPUs. Memory allocation for this preset remains unchanged at 2Gi. No other documentation changes were made.

@NickVolynkin
[docs] Fix a typo in preset resource tables in the README's
1609931 
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 8, 2025 •
edited
Loading

Walkthrough

The CPU allocation for the large resource preset was updated from 3 CPUs to 2 CPUs across multiple application README files. The memory allocation for the large preset remains unchanged at 2Gi. No other modifications were made to the resource presets or related documentation.

Changes

Files Summary
packages/apps/clickhouse/README.md
packages/apps/ferretdb/README.md
packages/apps/http-cache/README.md
packages/apps/kafka/README.md
packages/apps/kubernetes/README.md
packages/apps/mysql/README.md
packages/apps/nats/README.md
packages/apps/postgres/README.md
packages/apps/redis/README.md
packages/apps/tcp-balancer/README.md
packages/apps/vpn/README.md		 Updated CPU allocation for large preset from 3 CPUs to 2 CPUs; memory remains at 2Gi.

Suggested reviewers

  • lllamnyp

Poem

A tweak to the docs, a hop and a cheer,
The CPUs for "large" are now less, never fear!
From three down to two, with memory the same,
Across all the apps, the rabbits proclaim:
"Efficiency’s here—let’s optimize gear!"
🐇✨

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Jul 8, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
packages/apps/tcp-balancer/README.md (1)

49-57: Minor formatting inconsistency in CPU column

The table mixes CPU units (250m, 500m) with plain integers (1, 2, 4).
For clarity, consider using either millicores everywhere (e.g. 1000m, 2000m) or attaching a unit note (e.g. 1 (core), 2 (cores)).

packages/apps/postgres/README.md (1)

65-65: Nit: “pereiodic” typo

pereiodic → periodic to keep the docs polished.

-| `backup.enabled`         | Enable pereiodic backups                                             | `false`                             |
+| `backup.enabled`         | Enable periodic backups                                              | `false`                             |
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 699d38d and 1609931.

📒 Files selected for processing (11)
  • packages/apps/clickhouse/README.md (1 hunks)
  • packages/apps/ferretdb/README.md (1 hunks)
  • packages/apps/http-cache/README.md (1 hunks)
  • packages/apps/kafka/README.md (1 hunks)
  • packages/apps/kubernetes/README.md (1 hunks)
  • packages/apps/mysql/README.md (1 hunks)
  • packages/apps/nats/README.md (1 hunks)
  • packages/apps/postgres/README.md (1 hunks)
  • packages/apps/redis/README.md (1 hunks)
  • packages/apps/tcp-balancer/README.md (1 hunks)
  • packages/apps/vpn/README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings 
Learnt from: NickVolynkin
PR: cozystack/cozystack#1120
File: packages/apps/ferretdb/README.md:35-37
Timestamp: 2025-07-02T09:58:11.406Z
Learning: In the cozystack repository, the maintainer NickVolynkin prefers to keep realistic-looking example credentials in README documentation rather than using generic placeholders like <ACCESS_KEY>, even though they are just examples and not real secrets.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build
🔇 Additional comments (12)
packages/apps/redis/README.md (1)

48-48: Documentation fix aligns ‘large’ preset with repository-wide standard
Changing CPU from 3 to 2 restores the expected 2× scaling progression and matches the values in other service READMEs. Looks good.

packages/apps/kafka/README.md (1)

49-50: Confirm that all narrative references to the large preset were updated as well

The CPU value in the preset table changed from 3 to 2, which looks fine here.
Please double-check the rest of this README (and any cross-referencing docs) for lingering mentions of “3 CPUs” for the large preset to avoid confusing readers.

packages/apps/nats/README.md (1)

45-45: Verify chart values stay in sync with the doc change

README now says large preset = 2 CPU. Double-check that values.yaml (or any .tpl that holds the preset map) was updated to the same figure; otherwise users will receive 3 CPU while reading 2 CPU in docs.

packages/apps/mysql/README.md (1)

120-123: Verify chart values.yaml now matches the new large preset (2 CPU).

The doc shift from 3 → 2 CPUs is fine, but it will confuse users if the Helm chart (or resourcesPreset enum in code) still deploys 3 CPUs. Please confirm the preset constants were updated everywhere, or open a follow-up PR to keep docs and code in sync.

packages/apps/vpn/README.md (1)

53-61: No stale large = 3 references remain

Ran repo-wide searches in Markdown and YAML files for any occurrences of | large | 3 or large: 3 and found none. The large preset CPU value has been consistently updated to 2 across the codebase. LGTM.

packages/apps/tcp-balancer/README.md (1)

55-55: ✅ No stray “3”-CPU entries found
The large preset is correctly updated to 2 CPUs in packages/apps/tcp-balancer/README.md, and a global search across all README.md files yields no remaining | large|3 | rows. Approving this change.

packages/apps/kubernetes/README.md (2)

149-149: CPU downsizing looks good
Dropping the large preset from 3 → 2 CPUs is consistent with the updated sizing philosophy applied across the repo.
No issues spotted here.

143-151: No stale “large = 3 CPU” references found
I searched all Markdown and YAML files for any “3 CPU” mentions or a `large` preset paired with “3” and found none.

packages/apps/postgres/README.md (1)

106-106: Large-preset CPU update verified – All large presets now use cpu: 2; no lingering cpu: 3 entries found in any values*.yaml files.

packages/apps/http-cache/README.md (1)

103-104: Double-check Helm chart defaults for the large preset

Our searches found no remaining “| large | 3 |” entries in any README.md, and no presets: blocks in any values.yaml. It’s possible the CPU defaults are set directly in your chart templates or CRD defaults rather than values.yaml. Please manually verify that:

  • Deployment/statefulset templates (e.g. packages/apps/http-cache/charts/.../templates/*.yaml) use resources.requests.cpu: "2" for the large preset.
  • Any CRD or helper function that maps preset names to CPU values has been updated from 3 to 2.
  • No other docs (examples, code snippets outside README.md) still reference 3 CPUs for large.
packages/apps/ferretdb/README.md (1)

65-65: All large preset CPU defaults updated to 2 – no stale entries found

  • README.md (packages/apps/ferretdb/README.md) shows “| large | 2 | 2Gi”.
  • No occurrences of “| large | 3” in any README or Helm values.yaml.
  • packages/apps/ferretdb/values.yaml does not define a presets: section, so there are no lingering CPU mappings to update.
packages/apps/clickhouse/README.md (1)

72-80: Double-check ClickHouse Helm resource presets
I didn’t find a large preset block in packages/apps/clickhouse/values.yaml—please manually verify that:

  • The chart (or any external preset file) defines a large preset with cpu: 2 (not 3)
  • All resource-preset definitions for nano→2xlarge have been updated consistently across apps

@kvaps kvaps merged commit e9435c2 into main Jul 9, 2025
43 of 49 checks passed
@kvaps kvaps deleted the managed-apps-reference branch July 9, 2025 08:42
This was referenced Aug 18, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@kvaps kvaps kvaps approved these changes

@lllamnyp lllamnyp Awaiting requested review from lllamnyp lllamnyp is a code owner

@klinch0 klinch0 Awaiting requested review from klinch0 klinch0 is a code owner

Assignees

@kvaps kvaps

@NickVolynkin NickVolynkin

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@NickVolynkin @kvaps