tencent cloud

All product documents
TDMQ for CKafka
DocumentationTDMQ for CKafkaSDK DocumentationSDK for PythonPublic Network Access Through SASL_SSL
Public Network Access Through SASL_SSL
Download PDF
Last updated: 2024-11-07 15:40:42
Public Network Access Through SASL_SSL
Last updated: 2024-11-07 15:40:42
Download PDF

Overview

This document describes how to access CKafka to send/receive messages with the SDK for Python through SASL_SSL over public network.

Prerequisites

Install Python
Install pip
Configure an ACL policy
Download demo
Download the SASL_SSL certificate

Directions

Step 1. Make preparations

1. Create an access point.
1.1 On the Instance List page in the CKafka console, click the target instance ID to enter the instance details page.
1.2 In Basic Info > Access Mode, click Add a routing policy. In the pop-up window, select Route Type: Public domain name access, Access Mode: SASL_SSL.

2. Create a role.
On the User Management tab page under ++ACL Policy Management++, create a role and set a password.

3. Create a topic.
Create a topic on the Topic Management tab page as instructed in Creating a topic.
4. Add the Python dependent library.
Run the following command to install the dependent library:
pip install kafka-python

Step 2. Produce messages

1. Modify the configuration parameters in the message production program producer.py.
producer = KafkaProducer(
 bootstrap_servers = ['xx.xx.xx.xx:port'],
 api_version = (1, 1),

 #
 # Public network access through SASL_SSL
 #
 security_protocol = "SASL_SSL",
 sasl_mechanism = "PLAIN",
 sasl_plain_username = "instanceId#username",
 sasl_plain_password = "password",
 ssl_cafile = "CARoot.pem",
 ssl_check_hostname = False,
)

message = "Hello World! Hello Ckafka!"
msg = json.dumps(message).encode()
producer.send('topic_name', value = msg)
print("produce message " + message + " success.")
producer.close()
Parameter
Description
bootstrap_servers
Accessed network, which can be copied from the Network column in the Access Mode section in Basic Info on the instance details page in the console.

sasl_plain_username
Username in the format of instance ID + # + username. The instance ID can be obtained in Basic Info on the instance details page in the CKafka console, and the username is set when the user is created in on the User Management tab page under ACL Policy Management.
sasl_plain_password
User password, which is set when the user is created on the User Management tab page under ACL Policy Management on the instance details page in the CKafka console.
topic_name
Topic name, which can be copied from the Topic Management page in the console.
img

CARoot.pem
Certificate path that is required when the access mode is SASL_SSL.
2. Compile and run producer.py.
3. View the execution result.

4. On the Topic Management tab page on the instance details page in the CKafka console, select the target topic, and click More > Message Query to view the message just sent.


Step 3. Consume messages

1. Modify the configuration parameters in the message consumption program consumer.py.
consumer = KafkaConsumer(
 'topic_name',
 group_id = "group_id",
 bootstrap_servers = ['xx.xx.xx.xx:port'],
 api_version = (1,1),

 #
 # Public network access through SASL_SSL
 #
 security_protocol = "SASL_SSL",
 sasl_mechanism = 'PLAIN',
 sasl_plain_username = "instanceId#username",
 sasl_plain_password = "password",
 ssl_cafile = "CARoot.pem",
 ssl_check_hostname = False,

)

for message in consumer:
 print ("Topic:[%s] Partition:[%d] Offset:[%d] Value:[%s]" %
 (message.topic, message.partition, message.offset, message.value))

Parameter
Description
bootstrap_servers
Accessed network, which can be copied from the Network column in the Access Mode section in Basic Info on the instance details page in the console.

group_id
Consumer group ID, which can be customized based on business requirements.
sasl_plain_username
Username in the format of instance ID + # + username. The instance ID can be obtained in Basic Info on the instance details page in the CKafka console, and the username is set when the user is created on the User Management tab page under ACL Policy Management.
sasl_plain_password
User password, which is set when the user is created on the User Management tab page under ACL Policy Management on the instance details page in the CKafka console.
topic_name
Topic name, which can be copied from the Topic Management page in the console.
img

CARoot.pem
Certificate path that is required when the access mode is SASL_SSL.
2. Compile and run consumer.py.
3. View the execution result.

4. On the Consumer Group tab page in the CKafka console, select the corresponding consumer group name, enter the topic name, and click View Details to view the consumption details.


Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon