doc-exports/docs/dms_rocketmq/umn/hrm-qs-001.html

Getting Started with RocketMQ to Produce and Consume Messages

This document takes the example of creating a RocketMQ instance with SSL enabled and accessing it on a client in the same VPC as the instance over a private network for message production and consumption to get you quickly started with Distributed Message Service (DMS) for RocketMQ.

Procedure

Figure 1 Procedure for using DMS for RocketMQ

1. Step 1: Preparations

   A RocketMQ instance runs in a VPC. Before creating a RocketMQ instance, ensure that a VPC is available.

2. Step 2: Create a RocketMQ Instance

   Enable SSL, disable ACL, and configure the created VPC and subnet, and security group.

3. Step 3: Create a Topic

   After an instance is created, create a topic for sending and receiving messages.

4. Step 4: Connect to a RocketMQ Instance to Produce and Consume Messages

   On the client, connect to the instance and use commands to produce and consume messages.

Step 1: Preparations

1. Grant RocketMQ instance permissions.

   The RocketMQ administrator permission DMS FullAccess is required. For details, see Creating an IAM User and Granting DMS for RocketMQ Permissions.

2. Create a VPC and subnet.
   

   The VPC must be created in the same region as the RocketMQ instance.

   A RocketMQ instance runs in a Virtual Private Cloud (VPC). Before creating an instance, ensure that a VPC is available. For details about how to create a VPC and a subnet, see Creating a VPC.

3. Create a security group.

   See Creating a Security Group.

   To connect to RocketMQ instances, add the security group rules described in Table 1.

   Table 1 Security group rules

   Direction	Protocol	Port	Source	Description
   Inbound	TCP	8100	IP address or IP address range of the RocketMQ client	The port is used for private network access to instances using TCP.
   Inbound	TCP	8080		The port is used for private network access to instances using gRPC.
   Inbound	TCP	10100		The port is used for private access to service nodes using TCP.

   

   After a security group is created, its default inbound rule allows communication among ECSs within the security group and its default outbound rule allows all outbound traffic. In this case, you can access a RocketMQ instance within a VPC, and do not need to add rules according to Table 1.

4. Create an elastic cloud server (ECS) and configure environment variables.

   The following takes a Linux ECS as an example. For more information about how to install JDK and configure the environment variables for a Windows ECS, please search the Internet.

   1. Log in to the console, click in the upper left corner, click Elastic Cloud Server under Computing, and then create an ECS.

      For details, see Creating an ECS. If you already have an available ECS, skip this step.

   2. Log in to an ECS as user root.
   3. Install the JDK and configure the environment variables JAVA_HOME and PATH.
      1. Download the JDK.
         

         Use Oracle JDK instead of default ECS JDK (for example, OpenJDK), because it may not be suitable for the sample project. Obtain Oracle JDK 1.8.111 or later from Oracle's official website.

      2. Run the following command to decompress the JDK package.

         tar -zxvf jdk-8u321-linux-x64.tar.gz

         Change jdk-8u321-linux-x64.tar.gz to your JDK version.

      3. Run the following command to edit the environment variable file .bash_profile:

         vim ~/.bash_profile

      4. Press i and add the following content.

         export JAVA_HOME=/opt/java/jdk1.8.0_321
         export PATH=$JAVA_HOME/bin:$PATH

         Change /opt/java/jdk1.8.0_321 to the path where you install JDK.

      5. Press Esc to exit the editing mode. Enter the following command and press Enter to save and exit the environment variable file:

         :wq

      6. Run the following command to make the environment variables take effect:

         source .bash_profile

   4. Run the following command to check whether the JDK is successfully installed.

      java -version

      If the following information is displayed, the JDK is installed successfully:

      java version "1.8.0_321"

   5. Run the following command to download the rocketmq-tutorial sample software package.

      Before downloading the sample software package, ensure that the client server can access the Internet.

      wget https://dms-demo.obs.eu-de.otc.t-systems.com/rocketmq-tutorial.zip

   6. Run the following command to decompress rocketmq-tutorial.

      unzip rocketmq-tutorial.zip

Step 2: Create a RocketMQ Instance

Before using RocketMQ for message production and consumption, create a RocketMQ instance. The VM resource in the instance store topics.

1. Log in to the DMS for RocketMQ console and click Create RocketMQ Instance in the upper right.
2. Set the instance information. For details, see Table 2.

   Table 2 Setting instance information

   Parameter	Description
   Region	For lower network latency and faster access to your resources, select the nearest region. Select eu-de.
   Project	Projects isolate compute, storage, and network resources across geographical regions. For each region, a preset project is available. Select eu-de (default).
   AZ	Select one as required. You are advised to specify multiple AZs for disaster recovery.
   Instance Name	Enter the instance name, for example, rocketmq-test.
   Enterprise Project	An enterprise project manages project resources in groups. Enterprise projects are logically isolated. Select "default". This parameter is for enterprise users.
   Version	Select an instance version. Select 5.x. Fixed once the RocketMQ instance is created. Use the same version as your client.
   Instance Type	Select an instance type. Select Basic here.
   Architecture	Select an instance architecture. Select Cluster here.
   Flavor	Select an instance flavor. Select rocketmq.b2.large.4 here.
   Storage Space	Specify the disk type and storage space for storing RocketMQ data. Select Ultra-high I/O and enter 300.
   VPC	Select a VPC and a subnet. Here, select the ones created in Step 1: Preparations.
   Security Group	Select the security group. Here, select the one created in Step 1: Preparations.
   SSL	Ciphertext access with high security, but lower performance. Select SSL.
   ACL	Enabling ACL can manage permissions for message production and consumption. Do not enable it here.
   Advanced settings
   Public Access	EIPs are required to enable public access. Do not enable it here.
   Tags	Identifiers of the RocketMQ instance. Skip it here.
   Description	Additional information about the instance. Skip it.

3. Click Create Now.
4. Confirm the instance information and submit the request.
5. Return to the instance list and check whether the RocketMQ instance has been created.

   It takes 3 to 15 minutes to create an instance. During this period, the instance status is Creating.

   • If the instance is created successfully, its status changes to Running.
   • delete it. Then create a new one. If the instance creation fails again, contact .

6. After the instance is created, click its name to go to the instance overview page.
7. Record the instance connection addresses from the Connection area for later use.
   Figure 2 Recording instance connection addresses
   

Step 3: Create a Topic

A topic is the basic unit for sending and receiving messages. After creating a RocketMQ instance, you must manually create topics before creating and retrieving messages.

1. Click a RocketMQ instance to go to the instance overview page.
2. In the navigation pane, choose Instance > Topics.
3. Click Create Topic.
4. Configure the topic name and other parameters by referring to Table 3.

   Table 3 Topic parameters

   Parameter	Description
   Topic Name	Enter a topic name. Enter Topic01 here.
   Message Type	Select the message type. Select Normal here.
   Description	Additional information about the topic. Skip it.

5. Click OK.

Step 4: Connect to a RocketMQ Instance to Produce and Consume Messages

1. Go to the rocketmq-tutorial/bin directory on the ECS.

   cd rocketmq-tutorial/bin

2. Produce normal messages by the following commands.
   The following is a command example:

   JAVA_OPT=-Dtls.enable=true sh mqadmin sendMessage -n "10.xxx.xxx.89:8100;10.xxx.xxx.144:8100" -t Topic01 -p "hello rocketmq"

   • 10.xxx.xxx.89:8100;10.xxx.xxx.144:8100: the connection address of the RocketMQ instance, that is, the connection address in 7.
   • Topic01: name of the topic created in 4 for the RocketMQ instance.
   • hello rocketmq: the produced message content, can be customized.

   

3. Consume normal messages by the following commands.
   The following is a command example:

   JAVA_OPT=-Dtls.enable=true sh mqadmin consumeMessage -n "10.xxx.xxx.89:8100;10.xxx.xxx.144:8100" -t Topic01

   

   The content of BODY is the consumed message content.

   To stop consuming messages, press Ctrl+C to exit.

Related Information

• Learn more about RocketMQ Concepts.
• In RocketMQ instance creation, SSL can be disabled if ciphertext is not needed in access between the consumer client and the producer client. In this case, to access the RocketMQ instance, see Accessing RocketMQ on a Client (Without SSL).
• If you need multiple users and grant different topic and consumer group permissions for them, enable ACL and configure ACL users so that permissions are isolated among users. For details, see Enabling RocketMQ ACL and Configuring RocketMQ ACL Users.
• To enable public access to RocketMQ instances, see Configuring Public Access.

Parent topic: Getting Started

<script language="JavaScript"> </script>