Skip to content

Commit 533c90c

Browse files
authored
Merge pull request #254 from ByConity/fky@add-more-comments-on-local
docs: more instructions on local mode.
2 parents 16c81fe + c08dfd2 commit 533c90c

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/deployment/03-package-deployment.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,9 @@ Create any `XML` file in `conf.d/` to configure the `service_discovery` and `hdf
421421
422422
In ByConity, there are three methods of mutual discovery between components. The `mode` tag is used to specify the method, with three modes: `local`, `dns`, and `consul`. In `local` mode, users need to specify the IP addresses or hostnames of all components in this configuration file by replacing the placeholder `{your_xxx_address}` (for example, `{your_server_address}`), which should be the component's actual IP address, such as `10.0.2.72`.
423423
424+
In `local` mode, the specific address of a service is mainly obtained between services via `host` (`service_discovery > xxx > node[] > host`).
425+
Therefore, it is important to make sure that the value of this item (e.g. an IP or domain name that can be used for external access) can be used for service discovery.
426+
424427
For the `hdfs_nnproxy` tag, it includes the address of the HDFS namenode.
425428
426429
### Starting the Program

i18n/zh-cn/docusaurus-plugin-content-docs/current/deployment/03-package-deployment.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,6 @@ dpkg -i byconity-worker-write_${VERSION}_${ARCH}.deb
390390
dpkg -i byconity-daemon-manager_${VERSION}_${ARCH}.deb
391391
```
392392

393-
394393
#### 推荐的配置文件结构示例
395394

396395
通常,一项配置要么是专属于一种组件的,要么是集群共用的(如 HDFS/FDB 的连接参数),
@@ -425,6 +424,9 @@ dpkg -i byconity-daemon-manager_${VERSION}_${ARCH}.deb
425424
在 ByConity 中,组件之间有三种相互发现的方式。`mode` 标签用于指定方式,有三种模式:`local``dns``consul`
426425
`local` 模式下,用户需要在此配置文件中指定所有组件的 IP 地址或主机名,通过替换占位符 `{your_xxx_address}`(例如 `{your_server_address}`),该占位符实际上是组件的 IP 地址,例如 `10.0.2.72`
427426

427+
`local` 模式下,服务之间主要通过 `host` (`service_discovery > xxx > node[] > host`) 来获取某个服务的具体地址。
428+
因此,请务必确保该项的值(比如可用于外部访问的 IP 或者域名)能够用于服务发现。
429+
428430
对于 `hdfs_nnproxy` 标签,包含 HDFS 的 namenode 地址。
429431

430432
### 启动程序

0 commit comments

Comments
 (0)