在 Linux 主机上以集群方式部署

本文将介绍在公共云环境中快速部署启动一个包含 3 个 CONTROLLER 节点和 2 个 BROKER 节点的 AutoMQ 集群，并测试 AutoMQ 的基本功能。

AutoMQ 支持在私有云部署，可以选择自建与 AWS EBS 和 AWS S3 兼容的存储系统，如 Ceph、CubeFS 或 MinIO。

前置条件

准备 5 台主机用于部署 AutoMQ 集群。在公共云环境建议选择 2 核 16GB 内存的网络优化型 Linux amd64 主机，并确保系统盘存储空间不低于 10GB，数据卷磁盘空间不低于 10GB。测试环境可以适当降低配置。示例如下：

角色	IP	Node ID	系统卷	数据卷
CONTROLLER	192.168.0.1	0	EBS 20GB	EBS 20GB
CONTROLLER	192.168.0.2	1	EBS 20GB	EBS 20GB
CONTROLLER	192.168.0.3	2	EBS 20GB	EBS 20GB
BROKER	192.168.0.4	3	EBS 20GB	EBS 20GB
BROKER	192.168.0.5	4	EBS 20GB	EBS 20GB

建议在购买计算资源时指定与本示例相同的网段和 IP 地址，这样可以方便直接复制操作命令。

下载二进制安装包，用于安装 AutoMQ。参考软件制品▸。
创建两个自定义命名的对象存储桶，例如 automq-data 和 automq-ops。
创建一个 IAM 用户并为其生成 Access Key 和 Secret Key。然后，确保该 IAM 用户具有对之前创建的对象存储桶完整的读写权限。

建议查阅官方网站以获取更多详细信息。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:AbortMultipartUpload",
                "s3:DeleteObject"
            ],
            "Resource": [
                "arn:aws-cn:s3:::automq-data/*",
                "arn:aws-cn:s3:::automq-ops/*"
            ]
        }
    ]
}

{
  "title": "AutomqStorageRole",
  "description": "Custom Roles for AutoMQ Store Operations",
  "stage": "GA",
  "includedPermissions": [
    "storage.multipartUploads.create",
    "storage.objects.create",
    "storage.objects.delete",
    "storage.objects.get"
  ]
}

建议查阅官方网站以获取更多详细信息。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:AbortMultipartUpload",
                "s3:DeleteObject"
            ],
            "Resource": [
                "arn:aws-cn:s3:::automq-data",
                "arn:aws-cn:s3:::automq-ops"
            ]
        }
    ]
}

建议查阅官方网站以获取更多详细信息。

{
    "Version": "1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "oss:PutObject",
                "oss:AbortMultipartUpload",
                "oss:GetObject",
                "oss:DeleteObject"
            ],
            "Resource": [
                "acs:oss:*:*:automq-data",
                "acs:oss:*:*:automq-ops"
            ]
        }
    ]
}

建议查阅官方网站以获取更多详细信息。

{
    "statement": [
        {
            "action": [
                "cos:AbortMultipartUpload",
                "cos:GetObject",
                "cos:CompleteMultipartUpload",
                "cos:InitiateMultipartUpload",
                "cos:DeleteObject",
                "cos:PutObject",
                "cos:UploadPart"
            ],
            "effect": "allow",
            "resource": [
                "qcs::cos:ap-nanjing:uid/1258965391:automq-data-1258965391/*",
                "qcs::cos:ap-nanjing:uid/1258965391:automq-ops-1258965391/*"
            ]
        }
    ],
    "version": "2.0"
}

建议查阅官方网站以获取更多详细信息。

{
    "Version": "1.1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "obs:object:GetObject",
                "obs:object:AbortMultipartUpload",
                "obs:object:DeleteObject",
                "obs:object:PutObject"
            ],
            "Resource": [
                "OBS:*:*:object:automq-data/*",
                "OBS:*:*:object:automq-ops/*"
            ]
        }
    ]
}

建议查阅官方网站以获取更多详细信息。

{
    "accessControlList": [
        {
            "service": "bce:bos",
            "region": "*",
            "resource": [
                "*"
            ],
            "effect": "Allow",
            "permission": [
                "READ",
                "WRITE"
            ],
            "resource": ["automq-data/*"],
        }
    ]
}

安装并启动 AutoMQ 集群

第 1 步：生成 S3 URL

AutoMQ 提供了 automq-kafka-admin.sh 工具，用于快速启动 AutoMQ。只需提供包含所需 S3 接入点和身份认证信息的 S3 URL，即可一键启动 AutoMQ，无需手动生成集群 ID 或进行存储格式化等操作。

bin/automq-kafka-admin.sh generate-s3-url \
--s3-access-key=xxx  \
--s3-secret-key=yyy \
--s3-region=cn-northwest-1  \
--s3-endpoint=s3.cn-northwest-1.amazonaws.com.cn \
--s3-data-bucket=automq-data \
--s3-ops-bucket=automq-ops

在命令行中使用的 Endpoint 和 Region 等参数设置，请查阅各云服务商的配置说明。

输出结果

执行该命令后，将自动按以下阶段进行：

根据提供的 accessKey 和 secretKey 对 S3 基本功能进行探测，以验证 AutoMQ 和 S3 的兼容性。
根据身份信息，接入点信息生成 s3url。
根据 s3url 获取启动 AutoMQ 的命令示例。在命令中，将 --controller-list 和 --broker-list 替换为实际需要部署的 CONTROLLER 和 BROKER。

执行结果示例如下：

############  Ping s3 ########################

[ OK ] Write s3 object
[ OK ] Read s3 object
[ OK ] Delete s3 object
[ OK ] Write s3 object
[ OK ] Upload s3 multipart object
[ OK ] Read s3 multipart object
[ OK ] Delete s3 object
############  String of s3url ################

Your s3url is:

s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=xxx&s3-secret-key=yyy&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA


############  Usage of s3url  ################
To start AutoMQ, generate the start commandline using s3url.
bin/automq-kafka-admin.sh generate-start-command \
--s3-url="s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=XXX&s3-secret-key=YYY&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA" \
--controller-list="192.168.0.1:9093;192.168.0.2:9093;192.168.0.3:9093"  \
--broker-list="192.168.0.4:9092;192.168.0.5:9092"

TIPS: Please replace the controller-list and broker-list with your actual IP addresses.

第 2 步：生成启动命令列表

将上一步生成的命令中的 --controller-list 和 --broker-list 替换为你的主机信息，具体来说，将它们替换为环境准备中提到的 3 台 CONTROLLER 和 2 台 BROKER 的 IP 地址，并且使用默认的 9092 和 9093 端口。

bin/automq-kafka-admin.sh generate-start-command \
--s3-url="s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=XXX&s3-secret-key=YYY&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA" \
--controller-list="192.168.0.1:9093;192.168.0.2:9093;192.168.0.3:9093"  \
--broker-list="192.168.0.4:9092;192.168.0.5:9092"

参数说明

参数名	必选	说明
--s3-url	是	由 bin/automq-kafka-admin.sh generate-s3-url 命令行工具生成，包含身份认证、集群 ID 等信息
--controller-list	是	至少需要有一个地址，用作 CONTROLLER 主机的 IP、端口列表。格式为 IP1:PORT1；IP2:PORT2;IP3:PORT3
--broker-list	是	至少需要有一个地址，用作 BROKER 主机的 IP、端口列表。格式为 IP1:PORT1；IP2:PORT2;IP3:PORT3
--controller-only-mode	否	决定 CONTROLLER 节点是否只承担 CONTROLLER 角色。默认为 false，即部署的 CONTROLLER 节点同时也作为 BROKER 角色。

输出结果

执行命令后，会生成用于启动 AutoMQ 的命令。

############  Start Commandline ##############
To start an AutoMQ Kafka server, please navigate to the directory where your AutoMQ tgz file is located and run the following command.

Before running the command, make sure that Java 17 is installed on your host. You can verify the Java version by executing 'java -version'.

bin/kafka-server-start.sh --s3-url="s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=XXX&s3-secret-key=YYY&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA" --override process.roles=broker,controller --override node.id=0 --override controller.quorum.voters=0@192.168.0.1:9093,1@192.168.0.2:9093,2@192.168.0.3:9093 --override listeners=PLAINTEXT://192.168.0.1:9092,CONTROLLER://192.168.0.1:9093 --override advertised.listeners=PLAINTEXT://192.168.0.1:9092

bin/kafka-server-start.sh --s3-url="s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=XXX&s3-secret-key=YYY&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA" --override process.roles=broker,controller --override node.id=1 --override controller.quorum.voters=0@192.168.0.1:9093,1@192.168.0.2:9093,2@192.168.0.3:9093 --override listeners=PLAINTEXT://192.168.0.2:9092,CONTROLLER://192.168.0.2:9093 --override advertised.listeners=PLAINTEXT://192.168.0.2:9092

bin/kafka-server-start.sh --s3-url="s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=XXX&s3-secret-key=YYY&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA" --override process.roles=broker,controller --override node.id=2 --override controller.quorum.voters=0@192.168.0.1:9093,1@192.168.0.2:9093,2@192.168.0.3:9093 --override listeners=PLAINTEXT://192.168.0.3:9092,CONTROLLER://192.168.0.3:9093 --override advertised.listeners=PLAINTEXT://192.168.0.3:9092

bin/kafka-server-start.sh --s3-url="s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=XXX&s3-secret-key=YYY&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA" --override process.roles=broker --override node.id=3 --override controller.quorum.voters=0@192.168.0.1:9093,1@192.168.0.2:9093,2@192.168.0.3:9093 --override listeners=PLAINTEXT://192.168.0.4:9092 --override advertised.listeners=PLAINTEXT://192.168.0.4:9092

bin/kafka-server-start.sh --s3-url="s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=XXX&s3-secret-key=YYY&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA" --override process.roles=broker --override node.id=4 --override controller.quorum.voters=0@192.168.0.1:9093,1@192.168.0.2:9093,2@192.168.0.3:9093 --override listeners=PLAINTEXT://192.168.0.5:9092 --override advertised.listeners=PLAINTEXT://192.168.0.5:9092

TIPS: Start controllers first and then the brokers.

node.id 默认从 0 开始自动生成。

第 3 步：启动 AutoMQ

要启动集群，请在预先指定的 CONTROLLER 或 BROKER 主机上依次执行上一步命令中的命令列表。例如，在 192.168.0.1 上启动第一个 CONTROLLER 进程，执行生成的启动命令列表中的第一条命令。

bin/kafka-server-start.sh --s3-url="s3://s3.cn-northwest-1.amazonaws.com.cn?s3-access-key=XXX&s3-secret-key=YYY&s3-region=cn-northwest-1&s3-endpoint-protocol=https&s3-data-bucket=automq-data&s3-path-style=false&s3-ops-bucket=automq-ops&cluster-id=40ErA_nGQ_qNPDz0uodTEA" --override process.roles=broker,controller --override node.id=0 --override controller.quorum.voters=0@192.168.0.1:9093,1@192.168.0.2:9093,2@192.168.0.3:9093 --override listeners=PLAINTEXT://192.168.0.1:9092,CONTROLLER://192.168.0.1:9093 --override advertised.listeners=PLAINTEXT://192.168.0.1:9092

参数说明

使用启动命令时，未指定的参数将采用 Apache Kafka 的默认配置。对于 AutoMQ 新增的参数，将使用 AutoMQ 提供的默认值。要覆盖默认配置，可以在命令末尾添加额外的 --override key=value 参数来覆盖默认值。

参数名	必选	说明
s3-url	是	由 bin/automq-kafka-admin.sh generate-s3-url 命令行工具生成，包含身份认证、集群 ID 等信息
process.roles	是	可选项为 CONTROLLER 或 BROKER。如果一台主机同时为 CONTROLLER 和 BROKER，则配置值为 CONTROLLER，BROKER。
node.id	是	整数，用于唯一标识 Kafka 集群中的 BROKER 或 CONTROLLER，在集群内部必须保持唯一性。
controller.quorum.voters	是	参与 KRAFT 选举的主机信息，包含 nodeid、ip 和 port 信息，例如：0@192.168.0.1：9093，1@192.168.0.2：9093，2@192.168.0.3：9093
listeners	是	监听的 IP 和端口
advertised.listeners	是	BROKER 为 Client 提供的接入地址。
log.dirs	否	存放 KRAFT、BROKER 元数据的目录。
s3.wal.path	否	在生产环境中，建议将 AutoMQ WAL 数据存放在一个独立挂载的新数据卷裸设备上。这样可以获得更好的性能表现，因为 AutoMQ 支持将数据写入裸设备，从而降低延迟。请确保配置正确的路径以存储 WAL 数据。
autobalancer.controller.enable	否	默认值为 false，不启用流量重平衡。自动开启流量重平衡后，AutoMQ 的 auto balancer 组件会自动迁移分区，以确保整体流量是均衡的。

若需启用持续流量重平衡或运行示例：集群节点变化触发分区自平衡▸，建议在启动时为 Controller 明确指定参数 --override autobalancer.controller.enable=true。

后台运行

如果需要以后台模式运行，请在命令末尾添加以下代码：

command > /dev/null 2>&1 &

数据卷路径

使用 Linux 的 lsblk 命令可查看本地数据卷，未分区的块设备即为数据卷。在以下示例中，vdb 是未分区的裸块设备。

vda    253:0    0   20G  0 disk
├─vda1 253:1    0    2M  0 part
├─vda2 253:2    0  200M  0 part /boot/efi
└─vda3 253:3    0 19.8G  0 part /
vdb    253:16   0   20G  0 disk

默认情况下，AutoMQ 存储元数据和 WAL 数据的位置是在 /tmp 目录下。然而，值得注意的是，类似阿里云和腾讯云的 /tmp 目录通常是挂载在 tmpfs 上的，不适合用于生产环境。

为了更适合生产或正式测试环境，建议按照以下方式修改配置：将元数据目录 log.dirs 和 WAL 数据目录 s3.wal.path（写数据盘的裸设备）指定到其他位置。

bin/kafka-server-start.sh ...\
--override  s3.telemetry.metrics.exporter.type=prometheus \
--override  s3.metrics.exporter.prom.host=0.0.0.0 \
--override  s3.metrics.exporter.prom.port=9090 \
--override  log.dirs=/root/kraft-logs \
--override  s3.wal.path=/dev/vdb \
> /dev/null 2>&1 &

请将 s3.wal.path 更改为实际的本地裸设备名称。

运行示例程序

在启动 AutoMQ 集群后，可以运行以下示例程序来验证其功能。

停止并卸载 AutoMQ 集群

在完成测试后，可以参考以下步骤停止并卸载 AutoMQ 集群。

在每台节点上执行如下命令停止进程。

bin/kafka-server-stop.sh

你可以通过配置对象存储的生命周期规则来自动清空 s3-data-bucket 和 s3-ops-bucket 中的数据，然后再删除这些存储桶。
删除创建的计算实例及其对应的系统卷和数据卷。
删除测试用户及其关联的 AccessKey 和 SecretKey。

在 Linux 主机上以集群方式部署

前置条件​

安装并启动 AutoMQ 集群​

第 1 步：生成 S3 URL​

输出结果​

第 2 步：生成启动命令列表​

参数说明​

输出结果​

第 3 步：启动 AutoMQ​

参数说明​

后台运行​

数据卷路径​

运行示例程序​

停止并卸载 AutoMQ 集群​

相关内容​

前置条件

安装并启动 AutoMQ 集群

第 1 步：生成 S3 URL

输出结果

第 2 步：生成启动命令列表

参数说明

输出结果

第 3 步：启动 AutoMQ

参数说明

后台运行

数据卷路径

运行示例程序

停止并卸载 AutoMQ 集群

相关内容