Skip to content

Commit 3f28021

Browse files
committed
Added Proper Documentation
1 parent ee6fc2d commit 3f28021

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

docker/README.md

+51
Original file line numberDiff line numberDiff line change
@@ -236,3 +236,54 @@ python generate_kafka_pr_template.py --image-type=jvm
236236
- image-type - This is the type of image that we intend to build. This will be dropdown menu type selection in the workflow. `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/display/KAFKA/KIP-975%3A+Docker+Image+for+Apache+Kafka).
237237
- **NOTE:** As of now [KIP-1028](https://cwiki.apache.org/confluence/display/KAFKA/KIP-1028%3A+Docker+Official+Image+for+Apache+Kafka) only aims to release JVM based Docker Official Images and not GraalVM based native Apache Kafka docker image.
238238

239+
AutoMQ Docker Compose Configurations
240+
====================================
241+
242+
This directory contains Docker Compose configurations for deploying AutoMQ in different scenarios.
243+
244+
Quick Start (Single Node)
245+
-------------------------
246+
247+
The main `docker-compose.yaml` in the root directory provides a simple single-node setup for quick evaluation and development:
248+
249+
```bash
250+
# From the root directory
251+
docker-compose up -d
252+
```
253+
254+
This configuration:
255+
- Deploys a single AutoMQ node that acts as both controller and broker
256+
- Includes MinIO for S3 storage
257+
- Uses the latest bucket URI pattern (s3.data.buckets, s3.ops.buckets, s3.wal.path)
258+
- All services run in a single Docker network
259+
260+
Production-like Cluster
261+
-----------------------
262+
263+
For a more production-like setup, use the cluster configuration:
264+
265+
```bash
266+
# From the root directory
267+
docker-compose -f docker/docker-compose-cluster.yaml up -d
268+
```
269+
270+
This configuration:
271+
- Deploys a 3-controller + 3-broker cluster
272+
- Includes MinIO for S3 storage
273+
- Uses the latest bucket URI pattern (s3.data.buckets, s3.ops.buckets, s3.wal.path)
274+
- Provides proper redundancy for both controller and broker services
275+
- Port forwarding is configured to allow access to all services from the host
276+
277+
Configuration Notes
278+
-------------------
279+
280+
Both configurations use the new bucket URI pattern as recommended in the AutoMQ documentation:
281+
282+
- `s3.data.buckets` for data storage
283+
- `s3.ops.buckets` for logs and metrics storage
284+
- `s3.wal.path` for S3 WAL
285+
286+
The older `storage.mode=s3wal` parameter is deprecated and no longer used.
287+
288+
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).
289+

0 commit comments

Comments
 (0)