From 3d6069fc29cd50fc569ef6006950a879b91d6e2e Mon Sep 17 00:00:00 2001 From: zhangzujian Date: Mon, 3 Aug 2026 17:05:27 +0800 Subject: [PATCH] [release-4.3] docs: update NetObserv and Kube-OVN guidance --- .../kube_ovn/configure_egress_gateway.mdx | 5 ++ .../how_to/kube_ovn/multiple_networks.mdx | 3 ++ .../observability/operator-deployment.mdx | 53 +++++++++++++++---- 3 files changed, 50 insertions(+), 11 deletions(-) diff --git a/docs/en/configure/networking/how_to/kube_ovn/configure_egress_gateway.mdx b/docs/en/configure/networking/how_to/kube_ovn/configure_egress_gateway.mdx index 1cec08a23..e079aa829 100644 --- a/docs/en/configure/networking/how_to/kube_ovn/configure_egress_gateway.mdx +++ b/docs/en/configure/networking/how_to/kube_ovn/configure_egress_gateway.mdx @@ -106,6 +106,11 @@ Before creating the gateway, prepare the following resources: - An external subnet - A Network Attachment Definition (NAD) for that subnet +:::note + The NetworkAttachmentDefinition name MUST NOT contain a dot (`.`). + Each NetworkAttachmentDefinition can be used by only one subnet. Do not reuse the same NetworkAttachmentDefinition across multiple subnets. +::: + The following example uses a Kube-OVN underlay subnet as the external network. :::note diff --git a/docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx b/docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx index cad73ab88..8446be49a 100644 --- a/docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx +++ b/docs/en/configure/networking/how_to/kube_ovn/multiple_networks.mdx @@ -32,6 +32,9 @@ Create an attachnet subnet according to the following example: `network-attachme :::note The provider format in config is `..ovn`, where `` and `` are the name and namespace of this NetworkAttachmentDefinition CR respectively. + +The NetworkAttachmentDefinition name MUST NOT contain a dot (`.`). +Each NetworkAttachmentDefinition can be used by only one subnet. Do not reuse the same NetworkAttachmentDefinition across multiple subnets. ::: ```yaml diff --git a/docs/en/networking/observability/operator-deployment.mdx b/docs/en/networking/observability/operator-deployment.mdx index a6e829d01..61f6d19e2 100644 --- a/docs/en/networking/observability/operator-deployment.mdx +++ b/docs/en/networking/observability/operator-deployment.mdx @@ -78,15 +78,23 @@ metadata: spec: configuration: files: - disable-trace-log: | + 99-disable-system-logs.xml: | # [!code callout] - - - - - - - + + + + + + + + + + + + + + + clusters: - layout: @@ -98,7 +106,7 @@ spec: - 127.0.0.1 - 0.0.0.0/0 - ::/0 - clickhouse_root/password_sha256_hex: + clickhouse_root/password_sha256_hex: # [!code callout] defaults: templates: dataVolumeClaimTemplate: default @@ -152,6 +160,26 @@ spec: storage: 15Gi ``` + + +1. Additional ClickHouse configuration file for disabling system logs that are not required by NetObserv. The `99-` prefix makes the file load after the default configuration, and `remove="1"` removes the corresponding log configuration entries. +2. SHA-256 hash of the password for the ClickHouse user `clickhouse_root`. Generate the hash from the original plaintext password and replace `` with the command output. + + + +For example, to use `NetObserv@123` as the ClickHouse password, run: + +```bash +printf '%s' 'NetObserv@123' | sha256sum | awk '{print $1}' +``` + +Use the generated hash in `clickhouse_root/password_sha256_hex`. +When you create the `ck-auth` secret later, use `clickhouse_root` as the username and the original plaintext password as the password. + +If you want to use a different ClickHouse username, replace `clickhouse_root` in both `clickhouse_root/networks/ip` and `clickhouse_root/password_sha256_hex`. +For example, for a user named `netobserv_user`, use `netobserv_user/networks/ip` and `netobserv_user/password_sha256_hex`. +Then use the same username in the `ck-auth` secret. + After the ClickHouse instance is ready, get the service endpoint by inspecting field `.status.endpoint` of the ClickHouseInstallation instance. You can also run the following command to get the endpoint: @@ -190,10 +218,13 @@ This secret is referenced by `.spec.clickhouse.authSecret.name` in the FlowColle 1. Create a local file named _ck-auth.env_ with the following content: ```ini - username= - password= + username=clickhouse_root + password= ``` + If you use the ClickHouseInstallation example in this section, set `password` to the original plaintext password that was used to generate ``. + If you use a different ClickHouse username, set `username` to that value. + 2. Create the Kubernetes secret: ```bash