chore: provide a more practical quick start for three nodes setup (#2469)

daniel-y · web-flow · commit 8a3d19df3098 · 2025-04-30T15:02:56.000+08:00
diff --git a/docker/README.md b/docker/README.md
@@ -268,11 +268,10 @@ docker-compose -f docker/docker-compose-cluster.yaml up -d
 ```
 
 This configuration:
-- Deploys a 3-controller + 3-broker cluster
+- Deploys a 3-server cluster
 - Includes MinIO for S3 storage
 - Uses the latest bucket URI pattern (s3.data.buckets, s3.ops.buckets, s3.wal.path)
-- Provides proper redundancy for both controller and broker services
-- Port forwarding is configured to allow access to all services from the host
+- All services run in a single Docker network
 
 Configuration Notes
 -------------------
@@ -283,7 +282,5 @@ Both configurations use the new bucket URI pattern as recommended in the AutoMQ
 - `s3.ops.buckets` for logs and metrics storage
 - `s3.wal.path` for S3 WAL
 
-The older `storage.mode=s3wal` parameter is deprecated and no longer used.
-
 For more details, see the [AutoMQ documentation](https://www.automq.com/docs/automq/getting-started/cluster-deployment-on-linux#step-2-edit-the-cluster-configuration-template).
 
diff --git a/docker/docker-compose-cluster.yaml b/docker/docker-compose-cluster.yaml
@@ -13,216 +13,136 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Three-node AutoMQ cluster setup with MinIO for production-like environments
+# Single-node AutoMQ setup with MinIO for quick starts
 version: "3.8"
 
+x-common-variables: &common-env
+  KAFKA_S3_ACCESS_KEY: minioadmin
+  KAFKA_S3_SECRET_KEY: minioadmin
+  KAFKA_HEAP_OPTS: -Xms1g -Xmx4g -XX:MetaspaceSize=96m -XX:MaxDirectMemorySize=1G
+  # Replace CLUSTER_ID with a unique base64 UUID using "bin/kafka-storage.sh random-uuid"
+  CLUSTER_ID: 5XF4fHIOTfSIqkmje2KFlg
+
 services:
   # MinIO service for S3 storage
   minio:
-    container_name: "${MINIO_DOCKER_NAME-minio}"
-    hostname: "${MINIO_DOCKER_NAME-minio}"
-    image: minio/minio:RELEASE.2023-09-04T19-57-37Z
+    container_name: "minio"
+    image: minio/minio
+    environment:
+      MINIO_ROOT_USER: minioadmin
+      MINIO_ROOT_PASSWORD: minioadmin
+      MINIO_DOMAIN: minio
     ports:
       - "9000:9000"  # MinIO API
       - "9001:9001"  # MinIO Console
-    environment:
-      - MINIO_ROOT_USER=minioadmin
-      - MINIO_ROOT_PASSWORD=minioadmin
-    command: server /data --console-address ":9001"
-    volumes:
-      - minio_data:/data
+    command: [ "server", "/data", "--console-address", ":9001" ]
     networks:
       automq_net:
-        ipv4_address: 10.6.0.2
     healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
+      test: [ "CMD", "curl", "-f", "http://minio:9000/minio/health/live" ]
       interval: 5s
       timeout: 5s
       retries: 3
 
   # Create needed buckets
   mc:
-    container_name: "${MC_DOCKER_NAME-mc}"
-    hostname: "${MC_DOCKER_NAME-mc}"
-    image: minio/mc:RELEASE.2023-09-07T22-48-55Z
+    container_name: "mc"
+    image: minio/mc
     depends_on:
       minio:
         condition: service_healthy
     entrypoint: >
       /bin/sh -c "
-      /usr/bin/mc config host add myminio http://minio:9000 minioadmin minioadmin;
-      /usr/bin/mc mb myminio/automq-data;
-      /usr/bin/mc policy set public myminio/automq-data;
-      exit 0;
+      until (/usr/bin/mc config host add minio http://minio:9000 minioadmin minioadmin) do echo '...waiting...' && sleep 1; done;
+      /usr/bin/mc rm -r --force minio/automq-data;
+      /usr/bin/mc rm -r --force minio/automq-ops;
+      /usr/bin/mc mb minio/automq-data;
+      /usr/bin/mc mb minio/automq-ops;
+      /usr/bin/mc policy set public minio/automq-data;
+      /usr/bin/mc policy set public minio/automq-ops;
+      tail -f /dev/null
       "
     networks:
       - automq_net
 
-  # Controller node 1 (first controller in the cluster)
-  controller1:
-    container_name: "${CONTROLLER1_DOCKER_NAME-controller1}"
-    hostname: "${CONTROLLER1_DOCKER_NAME-controller1}"
-    stop_grace_period: 2m
+  # Three nodes for AutoMQ cluster
+  server1:
+    container_name: "automq-server1"
     image: automqinc/automq:latest
-    ports:
-      - "9093:9093"  # Controller API
+    stop_grace_period: 1m
     environment:
-      - KAFKA_S3_ACCESS_KEY=minioadmin
-      - KAFKA_S3_SECRET_KEY=minioadmin
-      - KAFKA_HEAP_OPTS=-Xms1g -Xmx1g -XX:MetaspaceSize=96m -XX:MaxDirectMemorySize=1G
-      - KAFKA_CFG_LISTENERS=CONTROLLER://:9093
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT
+      <<: *common-env
     command:
       - bash
       - -c
       - |
-        /opt/kafka/scripts/start.sh up --process.roles controller --node.id 0 --controller.quorum.voters 0@controller1:9093,1@controller2:9093,2@controller3:9093 --s3.data.buckets 0@s3://automq-data?region=us-east-1 --s3.ops.buckets 1@s3://automq-data?region=us-east-1 --s3.wal.path 0@s3://automq-data?region=us-east-1 --s3.endpoint http://10.6.0.2:9000 --s3.path-style-access true
+        /opt/automq/kafka/bin/kafka-server-start.sh \
+        /opt/automq/kafka/config/kraft/server.properties \
+        --override cluster.id=$$CLUSTER_ID \
+        --override node.id=0 \
+        --override controller.quorum.voters=0@server1:9093,1@server2:9093,2@server3:9093 \
+        --override controller.quorum.bootstrap.servers=server1:9093,server2:9093,server3:9093 \
+        --override advertised.listeners=PLAINTEXT://server1:9092 \
+        --override s3.data.buckets='0@s3://automq-data?region=us-east-1&endpoint=http://minio:9000&pathStyle=true' \
+        --override s3.ops.buckets='1@s3://automq-ops?region=us-east-1&endpoint=http://minio:9000&pathStyle=true' \
+        --override s3.wal.path='0@s3://automq-data?region=us-east-1&endpoint=http://minio:9000&pathStyle=true'
     networks:
       automq_net:
-        ipv4_address: 10.6.0.3
     depends_on:
       - minio
       - mc
 
-  # Controller node 2
-  controller2:
-    container_name: "${CONTROLLER2_DOCKER_NAME-controller2}"
-    hostname: "${CONTROLLER2_DOCKER_NAME-controller2}"
-    stop_grace_period: 2m
-    image: automqinc/automq:latest
-    ports:
-      - "9094:9093"  # Controller API (mapped to different port on host)
-    environment:
-      - KAFKA_S3_ACCESS_KEY=minioadmin
-      - KAFKA_S3_SECRET_KEY=minioadmin
-      - KAFKA_HEAP_OPTS=-Xms1g -Xmx1g -XX:MetaspaceSize=96m -XX:MaxDirectMemorySize=1G
-      - KAFKA_CFG_LISTENERS=CONTROLLER://:9093
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT
-    command:
-      - bash
-      - -c
-      - |
-        /opt/kafka/scripts/start.sh up --process.roles controller --node.id 1 --controller.quorum.voters 0@controller1:9093,1@controller2:9093,2@controller3:9093 --s3.data.buckets 0@s3://automq-data?region=us-east-1 --s3.ops.buckets 1@s3://automq-data?region=us-east-1 --s3.wal.path 0@s3://automq-data?region=us-east-1 --s3.endpoint http://10.6.0.2:9000 --s3.path-style-access true
-    networks:
-      automq_net:
-        ipv4_address: 10.6.0.4
-    depends_on:
-      - controller1
-
-  # Controller node 3
-  controller3:
-    container_name: "${CONTROLLER3_DOCKER_NAME-controller3}"
-    hostname: "${CONTROLLER3_DOCKER_NAME-controller3}"
-    stop_grace_period: 2m
-    image: automqinc/automq:latest
-    ports:
-      - "9095:9093"  # Controller API (mapped to different port on host)
-    environment:
-      - KAFKA_S3_ACCESS_KEY=minioadmin
-      - KAFKA_S3_SECRET_KEY=minioadmin
-      - KAFKA_HEAP_OPTS=-Xms1g -Xmx1g -XX:MetaspaceSize=96m -XX:MaxDirectMemorySize=1G
-      - KAFKA_CFG_LISTENERS=CONTROLLER://:9093
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT
-    command:
-      - bash
-      - -c
-      - |
-        /opt/kafka/scripts/start.sh up --process.roles controller --node.id 2 --controller.quorum.voters 0@controller1:9093,1@controller2:9093,2@controller3:9093 --s3.data.buckets 0@s3://automq-data?region=us-east-1 --s3.ops.buckets 1@s3://automq-data?region=us-east-1 --s3.wal.path 0@s3://automq-data?region=us-east-1 --s3.endpoint http://10.6.0.2:9000 --s3.path-style-access true
-    networks:
-      automq_net:
-        ipv4_address: 10.6.0.5
-    depends_on:
-      - controller2
-
-  # Broker node 1
-  broker1:
-    container_name: "${BROKER1_DOCKER_NAME-broker1}"
-    hostname: "${BROKER1_DOCKER_NAME-broker1}"
-    stop_grace_period: 2m
-    image: automqinc/automq:latest
-    ports:
-      - "9092:9092"  # Kafka API
-    environment:
-      - KAFKA_S3_ACCESS_KEY=minioadmin
-      - KAFKA_S3_SECRET_KEY=minioadmin
-      - KAFKA_HEAP_OPTS=-Xms1g -Xmx1g -XX:MetaspaceSize=96m -XX:MaxDirectMemorySize=1G
-      - KAFKA_CFG_AUTOBALANCER_REPORTER_NETWORK_IN_CAPACITY=5120
-      - KAFKA_CFG_AUTOBALANCER_REPORTER_NETWORK_OUT_CAPACITY=5120
-      - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092
-      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9092
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=PLAINTEXT:PLAINTEXT
-    command:
-      - bash
-      - -c
-      - |
-        /opt/kafka/scripts/start.sh up --process.roles broker --node.id 3 --controller.quorum.voters 0@controller1:9093,1@controller2:9093,2@controller3:9093 --s3.data.buckets 0@s3://automq-data?region=us-east-1 --s3.ops.buckets 1@s3://automq-data?region=us-east-1 --s3.wal.path 0@s3://automq-data?region=us-east-1 --s3.endpoint http://10.6.0.2:9000 --s3.path-style-access true
-    networks:
-      automq_net:
-        ipv4_address: 10.6.0.6
-    depends_on:
-      - controller1
-      - controller2
-      - controller3
-
-  # Broker node 2
-  broker2:
-    container_name: "${BROKER2_DOCKER_NAME-broker2}"
-    hostname: "${BROKER2_DOCKER_NAME-broker2}"
-    stop_grace_period: 2m
+  server2:
+    container_name: "automq-server2"
     image: automqinc/automq:latest
-    ports:
-      - "9096:9092"  # Kafka API (mapped to different port on host)
+    stop_grace_period: 1m
     environment:
-      - KAFKA_S3_ACCESS_KEY=minioadmin
-      - KAFKA_S3_SECRET_KEY=minioadmin
-      - KAFKA_HEAP_OPTS=-Xms1g -Xmx1g -XX:MetaspaceSize=96m -XX:MaxDirectMemorySize=1G
-      - KAFKA_CFG_AUTOBALANCER_REPORTER_NETWORK_IN_CAPACITY=5120
-      - KAFKA_CFG_AUTOBALANCER_REPORTER_NETWORK_OUT_CAPACITY=5120
-      - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092
-      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9096
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=PLAINTEXT:PLAINTEXT
+      <<: *common-env
     command:
       - bash
       - -c
       - |
-        /opt/kafka/scripts/start.sh up --process.roles broker --node.id 4 --controller.quorum.voters 0@controller1:9093,1@controller2:9093,2@controller3:9093 --s3.data.buckets 0@s3://automq-data?region=us-east-1 --s3.ops.buckets 1@s3://automq-data?region=us-east-1 --s3.wal.path 0@s3://automq-data?region=us-east-1 --s3.endpoint http://10.6.0.2:9000 --s3.path-style-access true
+        /opt/automq/kafka/bin/kafka-server-start.sh \
+        /opt/automq/kafka/config/kraft/server.properties \
+        --override cluster.id=$$CLUSTER_ID \
+        --override node.id=1 \
+        --override controller.quorum.voters=0@server1:9093,1@server2:9093,2@server3:9093 \
+        --override controller.quorum.bootstrap.servers=server1:9093,server2:9093,server3:9093 \
+        --override advertised.listeners=PLAINTEXT://server2:9092 \
+        --override s3.data.buckets='0@s3://automq-data?region=us-east-1&endpoint=http://minio:9000&pathStyle=true' \
+        --override s3.ops.buckets='1@s3://automq-ops?region=us-east-1&endpoint=http://minio:9000&pathStyle=true' \
+        --override s3.wal.path='0@s3://automq-data?region=us-east-1&endpoint=http://minio:9000&pathStyle=true'
     networks:
       automq_net:
-        ipv4_address: 10.6.0.7
     depends_on:
-      - broker1
+      - minio
+      - mc
 
-  # Broker node 3
-  broker3:
-    container_name: "${BROKER3_DOCKER_NAME-broker3}"
-    hostname: "${BROKER3_DOCKER_NAME-broker3}"
-    stop_grace_period: 2m
+  server3:
+    container_name: "automq-server3"
     image: automqinc/automq:latest
-    ports:
-      - "9097:9092"  # Kafka API (mapped to different port on host)
+    stop_grace_period: 1m
     environment:
-      - KAFKA_S3_ACCESS_KEY=minioadmin
-      - KAFKA_S3_SECRET_KEY=minioadmin
-      - KAFKA_HEAP_OPTS=-Xms1g -Xmx1g -XX:MetaspaceSize=96m -XX:MaxDirectMemorySize=1G
-      - KAFKA_CFG_AUTOBALANCER_REPORTER_NETWORK_IN_CAPACITY=5120
-      - KAFKA_CFG_AUTOBALANCER_REPORTER_NETWORK_OUT_CAPACITY=5120
-      - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092
-      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9097
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=PLAINTEXT:PLAINTEXT
+      <<: *common-env
     command:
       - bash
       - -c
       - |
-        /opt/kafka/scripts/start.sh up --process.roles broker --node.id 5 --controller.quorum.voters 0@controller1:9093,1@controller2:9093,2@controller3:9093 --s3.data.buckets 0@s3://automq-data?region=us-east-1 --s3.ops.buckets 1@s3://automq-data?region=us-east-1 --s3.wal.path 0@s3://automq-data?region=us-east-1 --s3.endpoint http://10.6.0.2:9000 --s3.path-style-access true
+        /opt/automq/kafka/bin/kafka-server-start.sh \
+        /opt/automq/kafka/config/kraft/server.properties \
+        --override cluster.id=$$CLUSTER_ID \
+        --override node.id=2 \
+        --override controller.quorum.voters=0@server1:9093,1@server2:9093,2@server3:9093 \
+        --override controller.quorum.bootstrap.servers=server1:9093,server2:9093,server3:9093 \
+        --override advertised.listeners=PLAINTEXT://server3:9092 \
+        --override s3.data.buckets='0@s3://automq-data?region=us-east-1&endpoint=http://minio:9000&pathStyle=true' \
+        --override s3.ops.buckets='1@s3://automq-ops?region=us-east-1&endpoint=http://minio:9000&pathStyle=true' \
+        --override s3.wal.path='0@s3://automq-data?region=us-east-1&endpoint=http://minio:9000&pathStyle=true'
     networks:
       automq_net:
-        ipv4_address: 10.6.0.8
     depends_on:
-      - broker2
-
-volumes:
-  minio_data:
-    driver: local
+      - minio
+      - mc
 
 networks:
   automq_net:
@@ -232,4 +152,4 @@ networks:
       driver: default
       config:
         - subnet: "10.6.0.0/16"
-          gateway: "10.6.0.1"
+          gateway: "10.6.0.1"
