chore: provide a more practical quick start for single node setup

Author: daniel-y

.editorconfig

@@ -16,6 +16,9 @@ trim_trailing_whitespace = false
 [*.yml]
 indent_size = 2
 
+[*.yaml]
+indent_size = 2
+
 [*.scala]
 indent_size = 2
 

README.md

@@ -39,12 +39,24 @@
 
 ## ⛄ Get started with AutoMQ
 
-### Deploy Locally on a Single Host
+> [!Tip]
+> Deploying a production-ready AutoMQ cluster is challenging. This Quick Start is only for evaluating AutoMQ features and is not suitable for production use. For production deployment best practices, please [contact](https://www.automq.com/contact) our community for support.
+
+The `docker/docker-compose.yaml` file provides a simple single-node setup for quick evaluation and development:
+```shell
+docker compose -f docker/docker-compose.yaml up -d
 ```
-curl https://download.automq.com/community_edition/standalone_deployment/install_run.sh | bash
+This setup features a single AutoMQ node serving as both controller and broker, alongside MinIO for S3 storage. All services operate within a Docker bridge network called `automq_net`, allowing you to start a Kafka producer in this network to test AutoMQ:
+```shell
+docker run --network automq_net automqinc/automq:latest /bin/bash -c \
+"/opt/automq/kafka/bin/kafka-producer-perf-test.sh --topic test-topic --num-records=1024000 --throughput 5120 --record-size 1024 \
+--producer-props bootstrap.servers=server1:9092 linger.ms=100 batch.size=524288 buffer.memory=134217728 max.request.size=67108864"
 ```
-
-The easiest way to run AutoMQ. You can experience features like [**Partition Reassignment in Seconds**](https://www.automq.com/docs/automq/getting-started/example-partition-reassignment-in-seconds) and [**Continuous Self-Balancing**](https://www.automq.com/docs/automq/getting-started/example-self-balancing-when-cluster-nodes-change) in your local machine.
+After testing, you can destroy the setup with:
+```shell
+docker compose -f docker/docker-compose.yaml down
+```
+The `docker/docker-compose-cluster.yaml` file offers a more complex setup with three AutoMQ nodes, ideal for testing AutoMQ's cluster features, and can be run in the same way.
 
 There are more deployment options available:
 - [Deploy on Linux with 5 Nodes](https://www.automq.com/docs/automq/getting-started/cluster-deployment-on-linux)

docker/docker-compose.yaml

@@ -19,80 +19,76 @@ version: "3.8"
 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
-    ports:
-      - "9000:9000"  # MinIO API
-      - "9001:9001"  # MinIO Console
+    container_name: "minio"
+    image: minio/minio
     environment:
       - MINIO_ROOT_USER=minioadmin
       - MINIO_ROOT_PASSWORD=minioadmin
-    command: server /data --console-address ":9001"
-    volumes:
-      - minio_data:/data
+      - MINIO_DOMAIN=minio
+    ports:
+      - "9000:9000"  # MinIO API
+      - "9001:9001"  # MinIO Console
+    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
 
   # Single node with combined controller and broker roles
-  automq:
-    container_name: "${AUTOMQ_DOCKER_NAME-automq}"
-    hostname: "${AUTOMQ_DOCKER_NAME-automq}"
-    stop_grace_period: 2m
-    image: automqinc/automq:1.3.0
-    ports:
-      - "9092:9092"  # Kafka API
-      - "9093:9093"  # Controller API
+  server1:
+    container_name: "automq-single-server"
+    image: automqinc/automq:latest
+    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_AUTOBALANCER_REPORTER_METRICS_REPORTING_INTERVAL_MS=5000
-      - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093
-      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://localhost:9092
-      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT
+      - 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=3D4fXN-yS1-vsQ8aJ_q4Mg
     command:
       - bash
       - -c
       - |
-        /opt/automq/scripts/start.sh up --process.roles controller,broker --node.id 0 --controller.quorum.voters 0@automq:9093 --s3.bucket automq-data --s3.endpoint http://10.6.0.2:9000 --s3.region us-east-1 --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 \
+        --override controller.quorum.bootstrap.servers=server1: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
 
-volumes:
-  minio_data:
-    driver: local
-
 networks:
   automq_net:
     name: automq_net