docs: document ClickHouse for Intake in Helm deployment - #1085
Open
BrianNewsom wants to merge 3 commits into
Open
docs: document ClickHouse for Intake in Helm deployment#1085BrianNewsom wants to merge 3 commits into
BrianNewsom wants to merge 3 commits into
Conversation
Adds ClickHouse coverage across the Helm deployment docs to match the existing PostgreSQL documentation pattern: database-setup, install, persistent-volumes, backup-and-restore, security, and requirements. Also simplifies the Helm README/template ClickHouse section, removing the verbose sizing guidance and migration-ownership prose in favor of a concise intro and external configuration steps. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Brian Newsom <brnewsom@nvidia.com>
Contributor
Adds back the sizing guidance table and recommendations without the SQL query block that was previously removed. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Brian Newsom <brnewsom@nvidia.com>
Contributor
📝 WalkthroughWalkthroughChangesClickHouse deployment documentation
Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@docs/set-up/security.mdx`:
- Around line 56-57: Update the port 9000 table entry to use the exact
description “Embedded ClickHouse native TCP protocol,” replacing the current
“native administration interface” wording while leaving the port and protocol
unchanged.
In `@k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl`:
- Around line 47-49: Update the external ClickHouse Secret instructions in both
k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl (lines 47-49) and
k8s/helm/README.md (lines 47-49): define NMP_NAMESPACE before the command and
use the shell-safe --namespace "$NMP_NAMESPACE" argument instead of the
placeholder namespace.
- Around line 47-49: Replace any ClickHouse password command-line examples using
--from-literal with --from-file or a secret-manager workflow in
k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl:47-49 and
docs/set-up/helm/database-setup.mdx:97-103. Regenerate k8s/helm/README.md:47-49
from the corrected template so the generated documentation contains no password
literals.
🪄 Autofix
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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 14c3e0fa-6a16-462e-881d-56e7f5577022
📒 Files selected for processing (10)
docs/requirements.mdxdocs/set-up/helm/backup-and-restore.mdxdocs/set-up/helm/database-setup.mdxdocs/set-up/helm/index.mdxdocs/set-up/helm/install.mdxdocs/set-up/helm/persistent-volumes.mdxdocs/set-up/security.mdxk8s/helm/README.mdk8s/helm/helm-docs-template/nemo-helm-readme.md.gotmplk8s/helm/values.yaml
Contributor
|
Signed-off-by: Brian Newsom <brnewsom@nvidia.com>
Contributor
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)
k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl (1)
75-76: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRemove the retained sizing block.
The heading is still followed by the verbose sizing table and operational recommendations in Lines 77-105. This conflicts with the PR objective to replace that guidance with concise external-configuration instructions. Remove or replace the block.
🤖 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 `@k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl` around lines 75 - 76, Remove the verbose ClickHouse sizing content following the “ClickHouse sizing” heading, including its sizing table and operational recommendations. Replace it with the concise external-configuration instructions required by the PR objective, or remove the heading if no replacement guidance remains.
🤖 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 `@k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl`:
- Around line 75-76: Remove the verbose ClickHouse sizing content following the
“ClickHouse sizing” heading, including its sizing table and operational
recommendations. Replace it with the concise external-configuration instructions
required by the PR objective, or remove the heading if no replacement guidance
remains.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 7169abbc-37f2-4201-9ec6-857054a5d838
📒 Files selected for processing (4)
docs/set-up/helm/database-setup.mdxdocs/set-up/security.mdxk8s/helm/README.mdk8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/set-up/security.mdx
- docs/set-up/helm/database-setup.mdx
- k8s/helm/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit