ROB-3611: updated docs to match new cluster-sizes approach#2066
ROB-3611: updated docs to match new cluster-sizes approach#2066
Conversation
|
|
|
ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (3)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughDocumentation across multiple installation and GitOps setup guides is updated to reflect a Helm configuration parameter change from ChangesParameter Migration Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
✅ Docker image ready for
Use this tag to pull the image for testing. 📋 Copy commandsgcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:c3f8f37
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:c3f8f37 me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:c3f8f37
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:c3f8f37Patch Helm values in one line: helm upgrade --install robusta robusta/robusta \
--reuse-values \
--set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:c3f8f37 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst`:
- Around line 80-86: The docs say to use --set clusterSize=small but the chart
templates check .Values.isSmallCluster (e.g., in runner.yaml and
forwarder.yaml), so add a mapping so clusterSize controls isSmallCluster: update
values.yaml to include clusterSize: "" (or "small") and set isSmallCluster
default false, then add logic in your helper templates (e.g., _helpers.tpl) to
set isSmallCluster = true when .Values.clusterSize == "small" (or accept boolean
|| string) so .Values.isSmallCluster is driven by .Values.clusterSize;
alternatively, if you prefer the docs change instead, update the docs snippet to
use --set isSmallCluster=true and remove the incorrect clusterSize example.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e152c07f-4b47-4ef0-a924-1cf5f45f1b24
📒 Files selected for processing (6)
docs/help.rstdocs/setup-robusta/gitops/argocd.rstdocs/setup-robusta/gitops/flux.rstdocs/setup-robusta/installation/_helm_install_no_prometheus.inc.rstdocs/setup-robusta/installation/_helm_install_with_prometheus.inc.rstdocs/setup-robusta/multi-cluster.rst
| Test clusters tend to have fewer resources. To lower Robusta's resource requests, set ``clusterSize=small``. | ||
|
|
||
| .. code-block:: bash | ||
| :name: cb-helm-install-test-clusters | ||
|
|
||
| helm repo add robusta https://robusta-charts.storage.googleapis.com && helm repo update | ||
| helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME> --set isSmallCluster=true \ | ||
| helm install robusta robusta/robusta -f ./generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME> --set clusterSize=small \ |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== References in chart values/templates =="
rg -n -C2 'clusterSize|isSmallCluster|Values\.clusterSize|Values\.isSmallCluster' helm/robusta
echo
echo "== Check for mapping logic (helpers/templates) =="
rg -n -C2 'isSmallCluster.*clusterSize|clusterSize.*isSmallCluster|eq .*clusterSize.*small' helm/robusta
echo
echo "== Docs switched to clusterSize =="
rg -n -C1 'clusterSize:\s*small|--set clusterSize=small' docs/setup-robusta docs/help.rstRepository: robusta-dev/robusta
Length of output: 3404
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Check values.yaml for clusterSize and isSmallCluster =="
rg -n 'clusterSize|isSmallCluster' helm/robusta/values.yaml
echo
echo "== Check _helpers.tpl for mapping logic =="
rg -n 'clusterSize|isSmallCluster' helm/robusta/templates/_helpers.tpl
echo
echo "== List all yaml files in helm/robusta =="
fd -e yaml -e yml helm/robustaRepository: robusta-dev/robusta
Length of output: 122
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== List all files in helm/robusta =="
find helm/robusta -type f | head -30
echo
echo "== Check if values.yaml exists and read first 50 lines =="
if [ -f helm/robusta/values.yaml ]; then
head -50 helm/robusta/values.yaml
else
echo "values.yaml not found at helm/robusta/values.yaml"
fi
echo
echo "== Check Chart.yaml =="
if [ -f helm/robusta/Chart.yaml ]; then
cat helm/robusta/Chart.yaml
fiRepository: robusta-dev/robusta
Length of output: 3219
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== Search entire values.yaml for clusterSize/isSmallCluster =="
grep -n 'clusterSize\|isSmallCluster' helm/robusta/values.yaml || echo "Not found in values.yaml"
echo
echo "== Read the actual .rst file (lines 75-95) =="
sed -n '75,95p' docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst
echo
echo "== Check _helpers.tpl =="
cat helm/robusta/templates/_helpers.tplRepository: robusta-dev/robusta
Length of output: 6246
Fix documentation or chart: --set clusterSize=small does not reduce resource requests.
The docs instruct --set clusterSize=small, but the Helm chart never reads clusterSize. Templates check .Values.isSmallCluster (in runner.yaml and forwarder.yaml) to reduce memory/storage requests for test clusters. No mapping exists between the two parameters, so following the docs produces no effect—test clusters will use full resource requests and may fail silently.
Either update docs to use --set isSmallCluster=true, or add mapping logic in the chart (e.g., in _helpers.tpl or values.yaml) to set isSmallCluster based on clusterSize.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/setup-robusta/installation/_helm_install_with_prometheus.inc.rst` around
lines 80 - 86, The docs say to use --set clusterSize=small but the chart
templates check .Values.isSmallCluster (e.g., in runner.yaml and
forwarder.yaml), so add a mapping so clusterSize controls isSmallCluster: update
values.yaml to include clusterSize: "" (or "small") and set isSmallCluster
default false, then add logic in your helper templates (e.g., _helpers.tpl) to
set isSmallCluster = true when .Values.clusterSize == "small" (or accept boolean
|| string) so .Values.isSmallCluster is driven by .Values.clusterSize;
alternatively, if you prefer the docs change instead, update the docs snippet to
use --set isSmallCluster=true and remove the incorrect clusterSize example.
2 participants
No description provided.