Skip to content

docs: clarify NetObserv ClickHouse credentials#877

Open
zhangzujian wants to merge 1 commit into
alauda:masterfrom
zhangzujian:docs/netobserv-clickhouse-auth
Open

docs: clarify NetObserv ClickHouse credentials#877
zhangzujian wants to merge 1 commit into
alauda:masterfrom
zhangzujian:docs/netobserv-clickhouse-auth

Conversation

@zhangzujian

@zhangzujian zhangzujian commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • document the ClickHouse system-log disable config override for NetObserv
  • clarify SHA-256 password hash generation and matching plaintext secret credentials
  • explain how to use a non-default ClickHouse username consistently

Verification

  • ./node_modules/.bin/doom lint

Note: the standard yarn lint hook could not resolve the local doom binary in this workspace, so the commit was created with --no-verify after running the equivalent local linter successfully.

Summary by CodeRabbit

  • Documentation
    • Updated operator deployment documentation with revised configuration examples.
    • Enhanced authentication setup instructions with password hash generation guidance.
    • Clarified ClickHouse username and credential configuration parameters.

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0b9e3bfa-e252-486a-8936-7a5ebccda526

📥 Commits

Reviewing files that changed from the base of the PR and between 89cf1b8 and 02c3520.

📒 Files selected for processing (1)
  • docs/en/networking/observability/operator-deployment.mdx

Walkthrough

This PR updates operator deployment documentation for ClickHouseInstallation configuration. It replaces inline system log disabling settings with a dedicated config file, adds password hash generation guidance, and clarifies the authentication secret setup with explicit plaintext password and username examples.

Changes

ClickHouseInstallation Setup Documentation

Layer / File(s) Summary
ClickHouseInstallation Configuration and Password Setup
docs/en/networking/observability/operator-deployment.mdx
YAML example restructured to use file-based 99-disable-system-logs.xml configuration instead of inline log disabling; callout marker added for password hash reference; new callouts explain the config file purpose and provide step-by-step instructions (including OpenSSL command example) for generating SHA-256 password hashes and updating authentication credentials; ck-auth.env example updated to use username=clickhouse_root and password=<PLAINTEXT_PASSWORD> with guidance for consistent username/password substitution.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A config file blooms in the logs' old place,
With hashes and passwords now shown face to face,
The root user's secret, in plaintext laid bare,
Then hashed with SHA-256, with utmost care! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: clarify NetObserv ClickHouse credentials' is directly related to the main change, which updates documentation to clarify ClickHouse authentication credentials and configuration for NetObserv.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant