Skip to content

docs: update networking guidance#877

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

docs: update networking guidance#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 ClickHouse SHA-256 password hash generation and matching plaintext secret credentials
  • add validated Kube-OVN Egress Gateway capacity guidance for BFD settings and dedicated gateway nodes

Verification

  • yarn lint

Summary by CodeRabbit

  • Documentation
    • Updated operator deployment guidance with a clearer ClickHouse setup example, including a separate configuration snippet and improved authentication instructions.
    • Clarified how to generate and apply the ClickHouse root password hash, and how to keep username/password values consistent when changing credentials.
    • Added validated Kube-OVN egress gateway capacity guidance, including supported high-availability scaling recommendations, reference limits, and node sizing notes.

@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: 99b1ae93-b08d-44fb-ab62-2003c672199e

📥 Commits

Reviewing files that changed from the base of the PR and between 3b81fbd and 585fd43.

📒 Files selected for processing (2)
  • docs/en/networking/how_to/kube_ovn/configure_egress_gateway.mdx
  • docs/en/networking/observability/operator-deployment.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/en/networking/how_to/kube_ovn/configure_egress_gateway.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/en/networking/observability/operator-deployment.mdx

Walkthrough

This PR updates ClickHouseInstallation documentation to move system log disabling into a dedicated config file and expand authentication setup guidance. It also adds a new validated capacity guidance section for BFD-based Kube-OVN egress gateway scaling.

Changes

ClickHouseInstallation Configuration and Authentication

Layer / File(s) Summary
Configuration File and Password Authentication 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 SHA-256 password hash generation instructions; ck-auth.env example updated to use username=clickhouse_root and password=<PLAINTEXT_PASSWORD> with guidance for consistent username substitution.

BFD Validated Capacity Guidance

Layer / File(s) Summary
Validated BFD Capacity Guidance Section
docs/en/networking/how_to/kube_ovn/configure_egress_gateway.mdx
New "Validated Capacity Guidance" section documents BFD interval/multiplier configurations validated with ACP 4.3.2 and Kube-OVN v1.15.13, including a table mapping BFD settings to gateway and Pod scale ranges plus dedicated-node capacity guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A config file blooms where logs used to stay,
With hashes and secrets now shown the right way.
Then BFD scales upward, capacity in sight,
Hop-hop, docs updated, all neat and bright!

🚥 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 is broad, but it accurately reflects that the PR updates networking documentation guidance.
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.

@zhangzujian zhangzujian force-pushed the docs/netobserv-clickhouse-auth branch from 02c3520 to 3b81fbd Compare June 24, 2026 02:10
@zhangzujian zhangzujian changed the title docs: clarify NetObserv ClickHouse credentials docs: update networking guidance Jun 24, 2026
@zhangzujian zhangzujian force-pushed the docs/netobserv-clickhouse-auth branch from 3b81fbd to 585fd43 Compare June 24, 2026 08:17
@fanzy618

Copy link
Copy Markdown
Contributor

/ok-to-test

@zhangzujian zhangzujian force-pushed the docs/netobserv-clickhouse-auth branch from 585fd43 to f96715f Compare June 24, 2026 10:35
@zhangzujian zhangzujian force-pushed the docs/netobserv-clickhouse-auth branch from f96715f to 4a992e5 Compare June 24, 2026 12:08
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.

2 participants