docs: align Kubernetes guide with Helm chart - #28
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe documentation now covers official Helm chart installation, standalone and distributed deployments, storage and networking behavior, authentication constraints, upgrades, verification, troubleshooting, and uninstall procedures. ChangesKubernetes deployment documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
dagu-sh-docs | 945fe80 | Aug 01 2026, 12:35 PM |
|
@coderabbitai review |
✅ Action performedReview finished.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@getting-started/installation/uninstall.md`:
- Around line 90-100: Update the uninstall documentation commands to use a
consistent Helm release-name variable or placeholder instead of the hardcoded
dagu value, including the helm uninstall command and PVC selector. Ensure every
command targets the actual release name described by the surrounding
custom-release guidance.
- Around line 102-108: Clarify the uninstall instructions around the kubectl
delete pvc command so it applies only to the chart-created PVC; explicitly
instruct operators to skip manual deletion when persistence.existingClaim is
configured, since that claim is managed externally.
🪄 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 Plus
Run ID: abac9a0d-5582-4525-8bb5-58abac0b0352
📒 Files selected for processing (7)
getting-started/installation/kubernetes.mdgetting-started/installation/uninstall.mdoverview/architecture.mdserver-admin/authentication/proxy.mdserver-admin/deployment/kubernetes.mdserver-admin/distributed/networking.mdserver-admin/distributed/workers/shared-filesystem.md
|
@coderabbitai review |
✅ Action performedReview finished.
|
|
@coderabbitai review |
✅ Action performedReview finished.
|
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
getting-started/installation/kubernetes.md (1)
36-40: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick winPreserve intentional Helm value overrides across upgrades.
The upgrade command in the Install section only passes
dagu-values.yaml, which covers Ingress andpublicUrl. If the release was installed with an override such as--set-string persistence.storageClass=standard, that override is not carried forward unless it is repeated on upgrade. Use--reuse-values, or keep the override in a reusable values file and pass that file with every upgrade.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@getting-started/installation/kubernetes.md` around lines 36 - 40, Update the Helm upgrade command in the installation instructions to preserve previously supplied release values across upgrades by adding --reuse-values, or by consistently passing the reusable values file containing overrides such as persistence.storageClass. Keep the existing dagu release, namespace, and wait behavior unchanged.Source: MCP tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@getting-started/installation/kubernetes.md`:
- Around line 36-40: Update the Helm upgrade command in the installation
instructions to preserve previously supplied release values across upgrades by
adding --reuse-values, or by consistently passing the reusable values file
containing overrides such as persistence.storageClass. Keep the existing dagu
release, namespace, and wait behavior unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 5d8fccbc-e889-4ad7-92e1-55e16a5b4f20
📒 Files selected for processing (3)
getting-started/installation/kubernetes.mdgetting-started/installation/uninstall.mdserver-admin/deployment/kubernetes.md
🚧 Files skipped from review as they are similar to previous changes (2)
- getting-started/installation/uninstall.md
- server-admin/deployment/kubernetes.md
|
@coderabbitai review |
✅ Action performedReview finished.
|
1 participant
Summary
Why
The public documentation still described the previous distributed-by-default chart and referenced removed values, old resource names, and mandatory RWX storage. That guidance would block a plug-and-play installation and obscure the new Ingress path.
Impact
New users can install the default chart without custom storage values, reach the UI through port forwarding or Ingress, and opt into distributed mode with the correct storage requirements.
Related to dagucloud/dagu#2476.
Validation
pnpm buildhelm lint --strict ../charts/daguSummary by cubic
Aligns Kubernetes and Helm docs with the chart’s standalone-by-default design, clarifies Ingress/TLS and OIDC for secure UI access, and adds guidance to keep Helm values in a file and reuse them across upgrades. Improves uninstall safety and documents service accounts, workload identity, private registries, worker networking/storage, and mounting extra files. Addresses dagucloud/dagu#2476.
Refactors
ReadWriteOnce, simple install andkubectl port-forward, and release notes viahelm get notes.config.publicUrl, TLS Secret requirements, and OIDC setup: setauth.oidc.clientUrlto the same URL and use/oidc-callback; UI and API share one origin; proxy-auth cannot use the chart-managed Ingress.existingClaimsupport, RWX for distributed, and image tag defaults to chartappVersion; addedimagePullSecrets.extraVolumes/extraVolumeMountswithextraEnvandconfig.envPassthrough(e.g., custom CA bundle); notedfsGroup: 1000.dagu-coordinator:50055.helm upgrade; showedhelm templateto review manifests.Migration
ReadWriteOnce; access via port-forward or enableingressand setconfig.publicUrl, hostname, class, and TLS Secret; or useui.service.type: LoadBalancer.deploymentMode: distributedandpersistence.accessMode: ReadWriteMany; workers do not mount the shared PVC.helm upgrade; usehelm templateto preview changes.persistence.existingClaimare external and never removed by the chart.Written for commit 945fe80. Summary will update on new commits.
Summary by CodeRabbit
ReadWriteOncestorage, retained PVCs, external claims, and release-specific cleanup.