This is an automated email from the ASF dual-hosted git repository. yiguolei pushed a commit to branch branch-2.1 in repository https://gitbox.apache.org/repos/asf/doris.git
commit fe082e374fcfca2d67900e16a0b780ec20fa2ffe Author: catpineapple <[email protected]> AuthorDate: Fri Jan 26 19:09:33 2024 +0800 [doc](fix) K8s doc modify configmap code (#30420) --- docs/en/docs/install/k8s-deploy/network.md | 4 ++-- docs/en/docs/install/k8s-deploy/persistent-volume.md | 12 ++++-------- docs/zh-CN/docs/install/k8s-deploy/network.md | 4 ++-- docs/zh-CN/docs/install/k8s-deploy/persistent-volume.md | 11 ++++------- 4 files changed, 12 insertions(+), 19 deletions(-) diff --git a/docs/en/docs/install/k8s-deploy/network.md b/docs/en/docs/install/k8s-deploy/network.md index 82031c89efc..6cec64dcaa3 100644 --- a/docs/en/docs/install/k8s-deploy/network.md +++ b/docs/en/docs/install/k8s-deploy/network.md @@ -253,12 +253,12 @@ doriscluster-sample-be-service NodePort 10.152.183.24 <none> 906 ## Doris data exchange ### Stream load -[Stream load](https://doris.apache.org/docs/data-operate/import/import-way/stream-load-manual) is a synchronous import method. Users send requests to import local files or data streams into Doris by sending HTTP protocol. +[Stream load](https://doris.apache.org/docs/dev/data-operate/import/import-way/stream-load-manual) is a synchronous import method. Users send requests to import local files or data streams into Doris by sending HTTP protocol. In a regular deployment, users submit import commands via the HTTP protocol. Generally, users will submit the request to FE, and FE will forward the request to a certain BE through the HTTP redirect command. However, in a Kubernetes-based deployment scenario, it is recommended that users **directly submit the import command to BE's Srevice**, and then the Service will be load balanced to a certain BE pod based on Kubernetes rules. The actual effects of these two operations are the same. When Flink or Spark uses the official connector to submit, the write request can also be submitted to the BE Service. ### ErrorURL -When import methods such as [Stream load](https://doris.apache.org/docs/data-operate/import/import-way/stream-load-manual) and [Routine load](https://doris.apache.org/docs/data-operate/import/import-way/routine-load-manual) +When import methods such as [Stream load](https://doris.apache.org/docs/dev/data-operate/import/import-way/stream-load-manual) and [Routine load](https://doris.apache.org/docs/dev/data-operate/import/import-way/routine-load-manual) These import methods will print `errorURL` or `tracking_url` in the return structure or log when encountering errors such as incorrect data format. You can locate the cause of the import error by visiting this link. However, this URL is only accessible within the internal environment of a specific BE node container in a Kubernetes deployed cluster. diff --git a/docs/en/docs/install/k8s-deploy/persistent-volume.md b/docs/en/docs/install/k8s-deploy/persistent-volume.md index 53b8b2c75f9..96b61af7be1 100644 --- a/docs/en/docs/install/k8s-deploy/persistent-volume.md +++ b/docs/en/docs/install/k8s-deploy/persistent-volume.md @@ -42,13 +42,9 @@ Recommended node directory type for persistent storage: Doris-Operator outputs logs to the console and the specified directory at the same time. If the user's Kubernetes system has complete log collection capabilities, log information at the Doris INFO level (default) can be collected through console output. However, it is still recommended to configure PVC to persist log files, because in addition to INFO level logs, there are also logs such as fe.out, be.out, audit.log and garbage collection logs, which facilitates quick problem location and audit log backtracking. -*** - ConfigMap is a resource object used to store configuration files in Kubernetes. It allows dynamically mounting configuration files and decouples configuration files from applications, making configuration management more flexible and maintainable. Like PVCs, ConfigMap can be referenced by Pods in order to use configuration data in the application. -**** - ## StorageClass @@ -165,7 +161,7 @@ data: enable_fqdn_mode = true ``` -Note that when using FE's ConfigMap, you must add `enable_fqdn_mode = true` to `fe.conf`. For specific reasons, please refer to [document here](https://doris.apache.org/docs/admin-manual/cluster-management/fqdn) +Note that when using FE's ConfigMap, you must add `enable_fqdn_mode = true` to `fe.conf`. For specific reasons, please refer to [document here](https://doris.apache.org/docs/dev/admin-manual/cluster-management/fqdn) BE's ConfigMap sample ```yaml @@ -256,7 +252,7 @@ spec: The `resolveKey` here is the name of the incoming configuration file (must be `fe.conf`, `be.conf` or `apache_hdfs_broker.conf`, the cn node is also `be.conf`) used to parse the incoming Doris cluster configuration file, doris-operator will parse the file to guide the customized deployment of doriscluster. ## Add special configuration files to the conf directory -This paragraph is for reference. Containerized deployment solutions that configure other files need to be placed in the conf directory of the Doris node. For example, the common HDFS/Hive configuration file mapping of [Data Lake Multi-catalog](https://doris.apache.org/docs/lakehouse/multi-catalog/hive). +This paragraph is for reference. Containerized deployment solutions that configure other files need to be placed in the conf directory of the Doris node. For example, the common HDFS/Hive configuration file mapping of [Data Lake Multi-catalog](https://doris.apache.org/docs/dev/lakehouse/multi-catalog/hive). Here we take BE's ConfigMap and the core-site.xml file that needs to be added as an example: ```yaml @@ -272,7 +268,7 @@ data: webserver_port = 8040 heartbeat_service_port = 9050 brpc_port = 8060 - core-site.xml: + core-site.xml: | <?xml version="1.0" encoding="UTF-8"?> <?xml-stylesheet type="text/xsl" href="configuration.xsl"?> <configuration> @@ -420,5 +416,5 @@ data: storage_root_path = /opt/apache-doris/be/storage,medium:ssd;/opt/apache-doris/be/storage1,medium:ssd ``` -When using multiple disks, the path in the corresponding value of `storage_root_path` in `ConfigMap` should correspond to each mounting path of `persistentVolume` in `doriscluster`. [`storage_root_path`](https://doris.apache.org/docs/admin-manual/config/be-config/?_highlight=storage_root_path#%E6%9C%8D%E5%8A%A1) For the corresponding writing rules, please refer to the document in the link. +When using multiple disks, the path in the corresponding value of `storage_root_path` in `ConfigMap` should correspond to each mounting path of `persistentVolume` in `doriscluster`. [`storage_root_path`](https://doris.apache.org/docs/dev/admin-manual/config/be-config/#storage_root_path) For the corresponding writing rules, please refer to the document in the link. When using cloud disks, the media is uniformly `SSD`. \ No newline at end of file diff --git a/docs/zh-CN/docs/install/k8s-deploy/network.md b/docs/zh-CN/docs/install/k8s-deploy/network.md index f70054707f0..70a8c10401e 100644 --- a/docs/zh-CN/docs/install/k8s-deploy/network.md +++ b/docs/zh-CN/docs/install/k8s-deploy/network.md @@ -253,12 +253,12 @@ doriscluster-sample-be-service NodePort 10.152.183.24 <none> 906 ## Doris 数据交互 ### Stream load -[Stream load](https://doris.apache.org/zh-CN/docs/data-operate/import/import-way/stream-load-manual) 是一个同步的导入方式，用户通过发送 HTTP 协议发送请求将本地文件或数据流导入到 Doris 中。 +[Stream load](https://doris.apache.org/zh-CN/docs/dev/data-operate/import/import-way/stream-load-manual) 是一个同步的导入方式，用户通过发送 HTTP 协议发送请求将本地文件或数据流导入到 Doris 中。 在常规部署中，用户通过 HTTP 协议提交导入命令。一般用户会将请求提交到 FE，则 FE 会通过 HTTP redirect 指令将请求转发给某一个 BE。但是，在基于 Kubernetes 部署的场景下，推荐用户 **直接提交导入命令 BE 的 Srevice** ，再由 Service 依据 Kubernetes 规则负载均衡到某一 BE 的 pod 上。 这两种操作效果的实际效果都是一样的，在 Flink 或 Spark 使用官方 connecter 提交的时候，也可以将写入请求提交给 BE Service。 ### ErrorURL 查看 -诸如 [Stream load](https://doris.apache.org/zh-CN/docs/data-operate/import/import-way/stream-load-manual) ，[Routine load](https://doris.apache.org/zh-CN/docs/data-operate/import/import-way/routine-load-manual) +诸如 [Stream load](https://doris.apache.org/zh-CN/docs/dev/data-operate/import/import-way/stream-load-manual) ，[Routine load](https://doris.apache.org/zh-CN/docs/dev/data-operate/import/import-way/routine-load-manual) 这些导入方式，在遇到像数据格式有误等错误的时候，会在返回结构体或者日志中打印 `errorURL` 或 `tracking_url`。 通过访问此链接可以定位导入错误原因。 但是此 URL 是仅在 Kubernetes 部署的集群中某一个特定的 BE 节点容器内部环境可访问。 diff --git a/docs/zh-CN/docs/install/k8s-deploy/persistent-volume.md b/docs/zh-CN/docs/install/k8s-deploy/persistent-volume.md index 5b6c882771b..c5285a39f1f 100644 --- a/docs/zh-CN/docs/install/k8s-deploy/persistent-volume.md +++ b/docs/zh-CN/docs/install/k8s-deploy/persistent-volume.md @@ -42,13 +42,10 @@ PV 提供多种存储类型，主要分为两大类：网络存储、本地存 Doris-Operator 同时将日志输出到 console 和 指定目录下。如果用户的 Kubernetes 系统有完整的日志收集能力，可通过 console 输出来收集 Doris INFO 级别（默认）的日志信息。 但是这里仍然推荐配置 PVC 来持久化日志文件，因为除了 INFO 级别日志还会有诸如 fe.out、be.out、audit.log 以及 垃圾回收日志，便于快速定位问题和审计日志回溯。 -*** ConfigMap 是 Kubernetes 中用于存储配置文件的资源对象，它允许动态挂载配置文件，并将配置文件与应用程序解耦，使得配置的管理更加灵活和可维护。 像 PVC 一样 ConfigMap 可以被 Pod 引用，以便在应用程序中使用配置数据。 -**** - ## StorageClass @@ -165,7 +162,7 @@ data: enable_fqdn_mode = true ``` -注意，使用 FE 的 ConfigMap ，必须为 `fe.conf` 添加 `enable_fqdn_mode = true`，具体原因可参考 [此处文档](https://doris.apache.org/zh-CN/docs/admin-manual/cluster-management/fqdn) +注意，使用 FE 的 ConfigMap ，必须为 `fe.conf` 添加 `enable_fqdn_mode = true`，具体原因可参考 [此处文档](https://doris.apache.org/zh-CN/docs/dev/admin-manual/cluster-management/fqdn) BE 的 ConfigMap 样例 ```yaml @@ -256,7 +253,7 @@ spec: 这里的 `resolveKey` 是传入配置文件名（必须是`fe.conf`，`be.conf` 或 `apache_hdfs_broker.conf`，cn 节点也是 `be.conf`） 用以解析传入的 Doris 集群配置的文件，doris-operator 会去解析该文件去指导 doriscluster 的定制化部署。 ## 为 conf 目录添加特殊配置文件 -本段落用来供参考 需要在 Doris 节点的 conf 目录放置配置其他文件的容器化部署方案。比如常见的 [数据湖联邦查询](https://doris.apache.org/zh-CN/docs/lakehouse/multi-catalog/hive) 的 hdfs 配置文件映射。 +本段落用来供参考 需要在 Doris 节点的 conf 目录放置配置其他文件的容器化部署方案。比如常见的 [数据湖联邦查询](https://doris.apache.org/zh-CN/docs/dev/lakehouse/multi-catalog/hive) 的 hdfs 配置文件映射。 这里以 BE 的 ConfigMap 和 需要添加的 core-site.xml 文件为例： ```yaml @@ -272,7 +269,7 @@ data: webserver_port = 8040 heartbeat_service_port = 9050 brpc_port = 8060 - core-site.xml: + core-site.xml: | <?xml version="1.0" encoding="UTF-8"?> <?xml-stylesheet type="text/xsl" href="configuration.xsl"?> <configuration> @@ -420,5 +417,5 @@ data: storage_root_path = /opt/apache-doris/be/storage,medium:ssd;/opt/apache-doris/be/storage1,medium:ssd ``` -在使用多盘时，`ConfigMap` 中 `storage_root_path` 对应值中的路径要与 `doriscluster` 中 `persistentVolume` 各个挂载路径对应。[`storage_root_path`](https://doris.apache.org/zh-CN/docs/admin-manual/config/be-config/?_highlight=storage_root_path#%E6%9C%8D%E5%8A%A1) 对应的书写规则请参考链接中文档。 +在使用多盘时，`ConfigMap` 中 `storage_root_path` 对应值中的路径要与 `doriscluster` 中 `persistentVolume` 各个挂载路径对应。[`storage_root_path`](https://doris.apache.org/zh-CN/docs/dev/admin-manual/config/be-config/#storage_root_path) 对应的书写规则请参考链接中文档。 在使用云盘的情形下，介质统一使用 `SSD`。 \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
