update mkdocs

itboon · Oct 20, 2024 · 0d1d3f8 · 0d1d3f8
1 parent db67377
commit 0d1d3f8
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 107 deletions.
diff --git a/docs/docker.md b/docs/docker.md
diff --git a/docs/env.md b/docs/env.md
@@ -8,7 +8,7 @@
 | `KAFKA_BROKER_LISTENER_PORT` | `9092` | broker 端口号，如果配置了 `KAFKA_CFG_LISTENERS` 则此项失效 |
 | `KAFKA_CONTROLLER_LISTENER_PORT` | `19091` | controller 端口号，如果配置了 `KAFKA_CFG_LISTENERS` 则此项失效 |
 | `KAFKA_BROKER_EXTERNAL_HOST` | null | 对外暴露的主机名，可以是域名或IP地址，如果配置了 `KAFKA_CFG_ADVERTISED_LISTENERS` 则此项失效 |
-| `KAFKA_BROKER_EXTERNAL_PORT` | `29092` | 对外暴露的端口号，不能跟内部端口重复，如果配置了 `KAFKA_CFG_ADVERTISED_LISTENERS` 则此项失效 |
+| `KAFKA_BROKER_EXTERNAL_PORT` | null | 对外暴露的端口号，不能跟内部端口重复，如果配置了 `KAFKA_CFG_ADVERTISED_LISTENERS` 则此项失效 |
 | `KAFKA_HEAP_OPTS` | `null` | Kafka Java Heap size. 例如: `-Xmx512m -Xms512m`|
 
 ## Kafka Configurations
@@ -27,5 +27,3 @@ Variable examples:
 | `KAFKA_CFG_ADVERTISED_LISTENERS`               | `advertised.listeners` |
 | `KAFKA_CFG_CONTROLLER_QUORUM_VOTERS`           | `controller.quorum.voters` |
 | `KAFKA_CFG_LOG_RETENTION_HOURS`                | `log.retention.hours` |
-
-> `log.dir` 和 `log.dirs` 已经被锁定，无法使用环境变量进行覆盖。
diff --git a/docs/helm.md b/docs/helm.md
@@ -35,19 +35,21 @@ helm upgrade --install kafka \
   kafka-repo/kafka
 ```
 
-### 将 broker 和 controller 分开部署
+### 独立部署 controller 模块
+
+生产环境推荐独立部署 controller 模块， 方便 broker 横向扩缩容。
 
 ``` shell
 helm upgrade --install kafka \
   --namespace kafka-demo \
   --create-namespace \
-  --set broker.combinedMode.enabled="false" \
+  --set controller.enabled="true" \
   --set controller.replicaCount="1" \
   --set broker.replicaCount="1" \
   kafka-repo/kafka
 ```
 
-> `broker.combinedMode.enabled` 混部模式，即进程同时具有 broker + controller 角色，单节点服务器启动一个 Pod 即可。`kafka-repo/kafka` 默认开启混部，`kafka-repo/kafka-ha` 默认关闭混部。
+> `kafka-repo/kafka` 默认关闭 controller 独立部署，`kafka-repo/kafka-ha` 默认开启。
 
 ### 部署高可用集群
 
@@ -98,4 +100,16 @@ broker:
 
 ## 集群外访问
 
-请参考 <https://github.com/itboon/kafka-helm/blob/main/docs/external.md>
+```yaml
+## NodePort example
+broker:
+  external:
+    enabled: true
+    service:
+      type: "NodePort"
+      annotations: {}
+    autoDiscovery:
+      enabled: true
+```
+
+更多集群外案例请参考 <https://github.com/itboon/kafka-helm/blob/main/docs/external.md>
diff --git a/docs/index.md b/docs/index.md
@@ -2,14 +2,3 @@
 
 - [GitHub](https://github.com/itboon/kafka-helm)
 - [Docker Hub](https://hub.docker.com/r/kafkace/kafka)
-
-## 关于 Apache Kafka
-
-[Apache Kafka](https://kafka.apache.org/) 是一个开源分布式事件流平台，已被数千家公司用于高性能数据管道、流分析、数据集成和关键任务应用程序。
-
-## 为何选择这个镜像
-
-- 全面兼容 `KRaft`, 不依赖 ZooKeeper
-- 灵活使用环境变量进行配置覆盖
-- 上手简单
-- 提供 `helm chart`，你可以在 Kubernetes 快速部署高可用 Kafka 集群
diff --git a/docs/network.md b/docs/network.md