rocketmq README

The project's README from github.com/apache/rocketmq. As one markdown file: README.md.

Apache RocketMQ

Build Status CodeCov Maven Central Release License Average Time to Resolve An Issue Percentage of Issues Still Open Twitter Follow

Apache RocketMQ is a distributed messaging and streaming platform with low latency, high performance and reliability, trillion-level capacity and flexible scalability.

It offers a variety of features:

Quick Start

This paragraph guides you through steps of installing RocketMQ in different ways. For local development and testing, only one instance will be created for each component.

Run RocketMQ locally

RocketMQ runs on all major operating systems and requires only a Java JDK version 8 or higher to be installed. To check, run java -version:

$ java -version
java version "1.8.0_121"

For Windows users, click here to download the 5.5.1 RocketMQ binary release, unpack it to your local disk, such as D:\rocketmq. For macOS and Linux users, execute following commands:

# Download release from the Apache mirror
$ wget https://dist.apache.org/repos/dist/release/rocketmq/5.5.1/rocketmq-all-5.5.1-bin-release.zip

# Unpack the release
$ unzip rocketmq-all-5.5.1-bin-release.zip

Prepare a terminal and change to the extracted bin directory:

$ cd rocketmq-all-5.5.1-bin-release/bin

1) Start NameServer

NameServer will be listening at 0.0.0.0:9876, make sure that the port is not used by others on the local machine, and then do as follows.

For macOS and Linux users:

### start Name Server
$ nohup sh mqnamesrv &

### check whether Name Server is successfully started
$ tail -f ~/logs/rocketmqlogs/namesrv.log
The Name Server boot success...

For Windows users, you need to set environment variables first:

Then change directory to rocketmq, type and run:

$ mqnamesrv.cmd
The Name Server boot success...

2) Start Broker

For macOS and Linux users:

### start Broker
$ nohup sh mqbroker -n localhost:9876 &

### check whether Broker is successfully started, eg: Broker's IP is 192.168.1.2, Broker's name is broker-a
$ tail -f ~/logs/rocketmqlogs/broker.log
The broker[broker-a, 192.168.1.2:10911] boot success...

For Windows users:

$ mqbroker.cmd -n localhost:9876
The broker[broker-a, 192.168.1.2:10911] boot success...

Run RocketMQ in Docker

You can run RocketMQ on your own machine within Docker containers, host network will be used to expose listening port in the container.

1) Start NameServer

$ docker run -it --net=host apache/rocketmq ./mqnamesrv

2) Start Broker

$ docker run -it --net=host --mount type=bind,source=/tmp/store,target=/home/rocketmq/store apache/rocketmq ./mqbroker -n localhost:9876

Run RocketMQ in Kubernetes

You can also run a RocketMQ cluster within a Kubernetes cluster using RocketMQ Operator. Before your operations, make sure that kubectl and related kubeconfig file installed on your machine.

1) Install CRDs

### install CRDs
$ git clone https://github.com/apache/rocketmq-operator
$ cd rocketmq-operator && make deploy

### check whether CRDs are successfully installed
$ kubectl get crd | grep rocketmq.apache.org
brokers.rocketmq.apache.org                 2022-05-12T09:23:18Z
consoles.rocketmq.apache.org                2022-05-12T09:23:19Z
nameservices.rocketmq.apache.org            2022-05-12T09:23:18Z
topictransfers.rocketmq.apache.org          2022-05-12T09:23:19Z

### check whether operator is running
$ kubectl get pods | grep rocketmq-operator
rocketmq-operator-6f65c77c49-8hwmj   1/1     Running   0          93s

2) Create Cluster Instance

### create RocketMQ cluster resource
$ cd example && kubectl create -f rocketmq_v1alpha1_rocketmq_cluster.yaml

### check whether cluster resources are running
$ kubectl get sts
NAME                 READY   AGE
broker-0-master      1/1     107m
broker-0-replica-1   1/1     107m
name-service         1/1     107m

Apache RocketMQ Community

Learn it & Contact us

Contributing

We always welcome new contributions, whether for trivial cleanups, big new features or other material rewards, more details see here.

License

Apache License, Version 2.0 Copyright (C) Apache Software Foundation

Export Control Notice

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

The following provides more details on the included cryptographic software:

This software uses Apache Commons Crypto (https://commons.apache.org/proper/commons-crypto/) to support authentication, and encryption and decryption of data sent across the network between services.

rocketmq (apache/rocketmq)

Searching Database…

22.6K ·GitHub
Rocketmq
Что это?Apache RocketMQ — это открытая распределённая платформа для обмена сообщениями и потоковой передачи данных, на которой строят событийно-ориентированные приложения. У неё низкая задержка, ёмкость триллионного уровня и гибкая масштабируемость.
Это сервис, который я запускаю, или библиотека, которую я подключаю к своему коду?Это платформа, которую вы запускаете, а не библиотека: NameServer и брокеры (Broker) хранят и маршрутизируют сообщения, а ваши приложения общаются с ними через клиентские SDK по gRPC, MQTT, JMS или OpenMessaging.
Как мне запустить это у себя локально?Установите Java JDK 8 или новее, скачайте бинарный релиз 5.5.1 и распакуйте его, затем запустите NameServer (он слушает порт 9876), а после него — Broker. Также подходят Docker и Kubernetes через RocketMQ Operator.
Есть ли подводные камни при настройке?Их два: перед запуском NameServer порт 9876 должен быть свободен, а на Windows нужно задать переменную окружения ROCKETMQ_HOME, указывающую на распакованную папку, прежде чем что-либо запускать.
Оно правда бесплатное? Есть ли юридические нюансы?Бесплатно по лицензии Apache License 2.0, открытые коннекторы входят в комплект. Один нюанс: в дистрибутиве есть криптографическое ПО, поэтому некоторые страны ограничивают его импорт или реэкспорт.
Зачем запускать NameServer и Broker как отдельные компоненты?NameServer — это лёгкий реестр маршрутизации, в котором регистрируются брокеры и который опрашивают клиенты; Broker хранит и доставляет сообщения. В quick start запускаются оба, даже локально.
Что входит в экосистему RocketMQ вокруг ядра?Открытые бесплатные коннекторы для источников и приёмников данных, коннектор для Flink, вычислительный движок RocketMQ Streams, слой MQTT для устройств интернета вещей и мобильных приложений, EventBridge для событийно-ориентированных приложений и экспортёр метрик для Prometheus.
Насколько далеко оно масштабируется?В README заявляется ёмкость триллионного уровня в целом и накопление сообщений миллионного уровня в одной очереди — на гибкой распределённой архитектуре с горизонтальным масштабированием.
Могу ли я попробовать его без установки чего-либо?Да — для изолированного тестирования и облачных изолированных кластеров предоставляются образы Docker, так что NameServer и Broker запускаются как контейнеры прямо на вашей машине.
What are similar projects?pulsar, emqx, kafka, nats-server, redpanda, dapr, kafka-ui, rustfs
Which topics is it in?rocketmq, pubsub, message-queue, authorization, event-driven, big-data, messaging, cloud-native, high-performance, observability, authentication, distributed-systems
Creator
apache
Size
46.2 MB
Stars
22.6K
Updated
CommitOct 16Releaserocketmq-all-5.5.1Aug 20
Age
9y
Commits · 90 Days