update README.md

sir5kong · Jul 9, 2023 · 2a99724 · 2a99724
1 parent 1b5cf86
commit 2a99724
Show file tree

Hide file tree

Showing 2 changed files with 280 additions and 58 deletions.
diff --git a/README-zh.md b/README-zh.md
@@ -0,0 +1,186 @@
+# https://github.com/sir5kong/kafka-docker
+
+# 镜像版本
+
+-	[`v3.5.0`, `v3.5`, `latest`](https://github.com/sir5kong/kafka-docker/blob/main/Dockerfile)
+-	[`v3.4.1`, `v3.4`](https://github.com/sir5kong/kafka-docker/blob/main/Dockerfile)
+-	[`v3.3.2`, `v3.3`](https://github.com/sir5kong/kafka-docker/blob/main/Dockerfile)
+
+# 关于 Apache Kafka
+
+Apache Kafka 是一个开源分布式事件流平台，已被数千家公司用于高性能数据管道、流分析、数据集成和关键任务应用程序。
+
+- [wikipedia.org/wiki/Apache_Kafka](https://en.wikipedia.org/wiki/Apache_Kafka)
+
+> 超过 80% 的财富 100 强公司信任并使用 Kafka。
+
+# 为何选择这个镜像
+
+- 全面兼容 `KRaft`, 不依赖 ZooKeeper
+- 灵活使用环境变量进行配置覆盖
+- 上手简单
+- 提供 `helm chart`，你可以在 Kubernetes 快速部署高可用 Kafka 集群
+
+# 使用镜像
+
+[Docker Hub](https://hub.docker.com/r/sir5kong/kafka)
+
+## 启动 `kafka` 服务器
+
+最简单的方式启动 Kafka:
+
+``` shell
+docker run -d --name kafka-server --network host sir5kong/kafka:v3.5
+```
+
+### 持久化数据存储
+
+``` shell
+docker volume create kafka-data
+docker run -d --name kafka-server \
+  --network host \
+  -v kafka-data:/opt/kafka/data \
+  sir5kong/kafka:v3.5
+```
+
+> broker 默认端口 `9092`
+
+### 自定义端口号
+
+``` shell
+docker volume create kafka-data
+docker run -d --name kafka-server \
+  --network host \
+  -v kafka-data:/opt/kafka/data \
+  --env KAFKA_CONTROLLER_LISTENER_PORT=29091 \
+  --env KAFKA_BROKER_LISTENER_PORT=29092 \
+  sir5kong/kafka:v3.5
+```
+
+### 使用 Docker Compose
+
+``` yaml
+version: "3"
+
+volumes:
+  kafka-data: {}
+
+## bootstrap-server: ${KAFKA_HOST_IP_ADDR}:9092
+
+services:
+  kafka:
+    image: sir5kong/kafka:v3.5
+    restart: always
+    network_mode: host
+    volumes:
+      - kafka-data:/opt/kafka/data
+    environment:
+      - KAFKA_HEAP_OPTS=-Xmx512m -Xms512m
+      #- KAFKA_CONTROLLER_LISTENER_PORT=19091
+      #- KAFKA_BROKER_LISTENER_PORT=9092
+
+```
+
+## Environment Variables
+
+| 变量 | 默认值 | 描述 |
+|-----------|-------|------|
+| `KAFKA_CLUSTER_ID`           | 随机生成 | Cluster ID |
+| `KAFKA_BROKER_LISTENER_PORT` | `9092` | broker 端口号. 如果配置了 `KAFKA_CFG_LISTENERS` 则此项实效 |
+| `KAFKA_CONTROLLER_LISTENER_PORT` | `19091` | controller 端口号. 如果配置了 `KAFKA_CFG_LISTENERS` 则此项实效 |
+| `KAFKA_HEAP_OPTS` | `null` | Kafka Java Heap size. 例如: `-Xmx512m -Xms512m`|
+
+### Kafka Configurations
+
+所有以 `KAFKA_CFG_` 开头的环境变量都将映射到其相应的 Apache Kafka 配置项。
+
+例如 `KAFKA_CFG_LISTENERS` 对应配置参数 `listeners`，`KAFKA_CFG_ADVERTISED_LISTENERS` 对应配置参数 `advertised.listeners`
+
+Variable examples:
+
+| 变量 | 配置项 |
+|---------|--------|
+| `KAFKA_CFG_PROCESS_ROLES`     | `process.roles` |
+| `KAFKA_CFG_LISTENERS`         | `listeners` |
+| `KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP`     | `listener.security.protocol.map` |
+| `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` 已经被锁定，无法使用环境变量进行覆盖。
+
+## 使用 helm chart
+
+### Prerequisites
+
+- Kubernetes 1.18+
+- Helm 3.3+
+
+### 获取 helm 仓库
+
+``` shell
+helm repo add kafka-repo https://sir5kong.github.io/kafka-docker
+helm repo update kafka-repo
+```
+
+### 部署单节点 Kafka 集群
+
+- 下面这个案例关闭了持久化存储，仅演示部署效果
+
+``` shell
+helm upgrade --install kafka \
+  --namespace kafka-demo \
+  --create-namespace \
+  --set broker.combinedMode.enabled="true" \
+  --set broker.persistence.enabled="false" \
+  kafka-repo/kafka
+```
+
+### 将 broker 和 controller 独立部署
+
+``` shell
+helm upgrade --install kafka \
+  --namespace kafka-demo \
+  --create-namespace \
+  --set broker.persistence.size="20Gi" \
+  kafka-repo/kafka
+```
+
+> 默认已开启持久化存储。
+
+### 部署高可用 Kafka 集群
+
+``` shell
+helm upgrade --install kafka \
+  --namespace kafka-demo \
+  --create-namespace \
+  --set controller.replicaCount="3" \
+  --set broker.replicaCount="3" \
+  --set broker.heapOpts="-Xms4096m -Xmx4096m" \
+  --set broker.resources.requests.memory="8Gi" \
+  --set broker.resources.limits.memory="16Gi" \
+  kafka-repo/kafka
+```
+
+> 高可用集群更多配置项请参考 [examples/values-production.yml](https://github.com/sir5kong/kafka-docker/raw/main/examples/values-production.yml)
+
+### 使用 LoadBalancer
+
+启用集群外访问模式：
+
+``` shell
+helm upgrade --install kafka \
+  --namespace kafka-demo \
+  --create-namespace \
+  --set broker.external.enabled="true" \
+  --set broker.external.service.type="LoadBalancer" \
+  --set broker.external.domainSuffix="kafka.example.com" \
+  kafka-repo/kafka
+```
+
+上面部署完成后还需要继续添加域名解析。
+
+# Multi-language `README.md`
+
+- [English](README.md)
+- [简体中文](README_ZH.md)