Repository navigation
[docs] Fix a typo in preset resource tables in the README's - #1172
Conversation
Signed-off-by: Nick Volynkin <[email protected]>
WalkthroughThe CPU allocation for the Changes
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/apps/tcp-balancer/README.md (1)
49-57: Minor formatting inconsistency in CPU columnThe 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→periodicto 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
📒 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 from3to2restores 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 thelargepreset were updated as wellThe CPU value in the preset table changed from
3to2, which looks fine here.
Please double-check the rest of this README (and any cross-referencing docs) for lingering mentions of “3 CPUs” for thelargepreset to avoid confusing readers.packages/apps/nats/README.md (1)
45-45: Verify chart values stay in sync with the doc changeREADME now says
largepreset =2CPU. Double-check thatvalues.yaml(or any.tplthat 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 newlargepreset (2CPU).The doc shift from
3→2CPUs is fine, but it will confuse users if the Helm chart (orresourcesPresetenum in code) still deploys3CPUs. 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 stalelarge = 3references remainRan repo-wide searches in Markdown and YAML files for any occurrences of
| large | 3orlarge: 3and found none. Thelargepreset CPU value has been consistently updated to2across the codebase. LGTM.packages/apps/tcp-balancer/README.md (1)
55-55: ✅ No stray “3”-CPU entries found
Thelargepreset is correctly updated to2CPUs 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 thelargepreset 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 – Alllargepresets now usecpu: 2; no lingeringcpu: 3entries found in anyvalues*.yamlfiles.packages/apps/http-cache/README.md (1)
103-104: Double-check Helm chart defaults for thelargepresetOur searches found no remaining “| large | 3 |” entries in any README.md, and no
presets:blocks in anyvalues.yaml. It’s possible the CPU defaults are set directly in your chart templates or CRD defaults rather thanvalues.yaml. Please manually verify that:
- Deployment/statefulset templates (e.g.
packages/apps/http-cache/charts/.../templates/*.yaml) useresources.requests.cpu: "2"for thelargepreset.- Any CRD or helper function that maps preset names to CPU values has been updated from
3to2.- No other docs (examples, code snippets outside README.md) still reference
3CPUs forlarge.packages/apps/ferretdb/README.md (1)
65-65: Alllargepreset CPU defaults updated to2– no stale entries found
- README.md (packages/apps/ferretdb/README.md) shows “|
large|2|2Gi”.- No occurrences of “|
large|3” in any README or Helmvalues.yaml.packages/apps/ferretdb/values.yamldoes not define apresets: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 alargepreset block in packages/apps/clickhouse/values.yaml—please manually verify that:
- The chart (or any external preset file) defines a
largepreset withcpu: 2(not3)- All resource-preset definitions for nano→2xlarge have been updated consistently across apps
2 participants
Signed-off-by: Nick Volynkin [email protected]
Summary by CodeRabbit