Quick Start

# Preface

This document is the quick start guide for Kingdee Apusic Distributed Message Queue for Kafka (Apusic Distributed Message Queue, abbreviated as ADMQ for Kafka), providing product introduction, basic steps for installation and deployment, and verification methods.

# Target Audience

This document is intended for IT business leaders, R&D managers, software project managers, software architects, and operations engineers.

For more information about ADMQ for Kafka, please refer to the following ADMQ for Kafka product documentation set:

No. Document Description
1 Kingdee Apusic Distributed Message Queue for Kafka Quick Start Guide A brief introduction on how to quickly get started with ADMQ for Kafka.
2 Kingdee Apusic Distributed Message Queue for Kafka Installation Guide Detailed instructions on installing ADMQ for Kafka on various operating systems, as well as starting and stopping ADMQ for Kafka services.
3 Kingdee Apusic Distributed Message Queue for Kafka Message Engine User Guide Detailed instructions on using, configuring, and managing ADMQ for Kafka message engine features and supporting tools.
4 Kingdee Apusic Distributed Message Queue for Kafka Console User Guide Detailed instructions on using and operating ADMQ for Kafka console features.
5 Kingdee Apusic Distributed Message Queue for Kafka Developer Guide Detailed instructions on developing ADMQ for Kafka client applications in various programming languages.
6 Kingdee Apusic Distributed Message Queue for Kafka Migration Guide Detailed instructions on migrating from Kafka to ADMQ for Kafka.
7 Kingdee Apusic Distributed Message Queue for Kafka Operations Guide Detailed instructions on monitoring, operations, and security hardening for ADMQ for Kafka.
8 Kingdee Apusic Distributed Message Queue for Kafka Performance Optimization Guide Detailed instructions on performance tuning for ADMQ for Kafka.

# Technical Support

ADMQ for Kafka provides comprehensive technical support services. You can obtain technical support through the following channels:

  • Website: www.apusic.com
  • Phone: 400-855-5800
  • Email: support@apusic.com
  • Kingdee Cloud Community: https://vip.kingdee.com/?productId=73&productLineId=14&lang=zh-CN

When contacting technical support, please provide the following information:

  1. Your name

  2. Company information and contact details

  3. Operating system and its version

  4. Product version number

  5. Detailed information such as error logs and screenshots

# Deployment

# Prerequisites

# Environment Requirements

  • Operating System: CentOS 7+ / Ubuntu 18.04+, recommended 4 cores and 8GB RAM or higher
  • Network: Network connectivity between the console and Kafka nodes

# Obtaining the Installation Package

  • Obtain the management console installation package: ADMQ-manager-V2.0.6.20260601-x86_64.tar.gz (contact technical support to obtain)
  • Upload the installation package to the target server (e.g., /opt directory)

# Deploy the Management Console

# Extract the Installation Package

tar zxvf ADMQ-manager-V2.0.6.20260601-x86_64.tar.gz -C /opt/
cd /opt/admq-manager-V2.0.6
1
2

# Start the Console

bin/admq-service start
1

Verify Startup:

bin/admq-service status
1

Seeing ADMQ Manager is running indicates success.

# Access the Console

  • Browser access: https://<console_ip>:12306
  • Default credentials: admq / 11111111 (change password on first login)

# Initialize Default Configuration

Execute on the server:

bin/init all
1

# Deploy ADMQ for Kafka

# Upload License File

Navigate to Resource Management → License Management to upload the license file.

image-20260923094540475

# Upload Software Package

  1. Log in to the management console and navigate to the Resource Management menu.

  2. Upload:

    • Software package: admq-kafka-<version>.tar.gz (platform-provided or custom)

  3. Wait for the upload to complete and verification to succeed.

    image-20260923094612829

# Add Server

In Resource Management → Server Management, add a server.

image-20260923094646521

After adding, the agent program will be automatically deployed on the server.

Once successful, the added record will be displayed in the server list:

The system periodically collects server CPU and memory status and retrieves the license authorization code. If applying for an official license, the authorization code information must be provided.

# Quick Deployment

  1. Navigate to Cluster Management → Cluster List.

  2. Click the Quick Deployment button.

  3. Select the middleware type: ADMQ Kafka.

  4. Select the cluster mode:

    • Standalone Mode: Single node
    • Cluster Mode: Multiple nodes, shared metadata

  5. Click Start Deployment. The backend will automatically begin the deployment task.

# Post-Deployment Status

  • The cluster list will display the newly connected cluster with a status of "Normal".

image-20260923094836835

# Verification

In the cluster list, click Enter Business Functions on the right to navigate to the resource management page.

# Create a Topic

On the Resource Management → Topic page, create a topic: test

image-20260923094905628

# Send a Test Message

In Resource Management → Topic, select test and click Send Message

image-20260923094935210

# Common Issues and Troubleshooting

Issue Possible Cause Solution
Connection test failed Network unreachable or port not open Check firewall and security groups to ensure ports 15672/5672 are accessible
Port conflict when starting console Port 12306 is occupied Modify server.port in config/application.properties and restart the service
编辑页面 (opens new window)
#快速使用手册

← Console User Manual→