diff --git a/docs/dms/umn/ALL_META.TXT.json b/docs/dms/umn/ALL_META.TXT.json new file mode 100644 index 000000000..a3f5366b2 --- /dev/null +++ b/docs/dms/umn/ALL_META.TXT.json @@ -0,0 +1,1282 @@ +[ + { + "uri":"kafka-ug-0723001.html", + "product_code":"dms", + "code":"1", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Service Overview", + "title":"Service Overview", + "githuburl":"" + }, + { + "uri":"kafka-pd-190605001.html", + "product_code":"dms", + "code":"2", + "des":"Apache Kafka is distributed message middleware that features high throughput, data persistence, horizontal scalability, and stream data processing. It adopts the publish-", + "doc_type":"usermanual", + "kw":"What Is DMS?,Service Overview,User Guide", + "title":"What Is DMS?", + "githuburl":"" + }, + { + "uri":"kafka-advantage.html", + "product_code":"dms", + "code":"3", + "des":"DMS provides easy-to-use message queuing based on Apache Kafka. Services can be quickly migrated to the cloud without any change, reducing maintenance and usage costs.Rap", + "doc_type":"usermanual", + "kw":"Product Advantages,Service Overview,User Guide", + "title":"Product Advantages", + "githuburl":"" + }, + { + "uri":"kafka-scenarios.html", + "product_code":"dms", + "code":"4", + "des":"Kafka is popular message-oriented middleware that features highly reliable, asynchronous message delivery. It is widely used for transmitting data between different syste", + "doc_type":"usermanual", + "kw":"Application Scenarios,Service Overview,User Guide", + "title":"Application Scenarios", + "githuburl":"" + }, + { + "uri":"Kafka-specification.html", + "product_code":"dms", + "code":"5", + "des":"Kafka instances are compatible with open-source Kafka 1.1.0, 2.3.0, and 2.7. The instance specifications are classified based on bandwidth, namely, 100 MB/s, 300 MB/s, 60", + "doc_type":"usermanual", + "kw":"Specifications,Service Overview,User Guide", + "title":"Specifications", + "githuburl":"" + }, + { + "uri":"kafka-pd-200720001.html", + "product_code":"dms", + "code":"6", + "des":"DMS is compatible with open-source Kafka and has customized and enhanced Kafka features. In addition to the advantages of open-source Kafka, DMS for Kafka provides more r", + "doc_type":"usermanual", + "kw":"Comparing DMS for Kafka and Open-Source Kafka,Service Overview,User Guide", + "title":"Comparing DMS for Kafka and Open-Source Kafka", + "githuburl":"" + }, + { + "uri":"kafka-pd-190605003.html", + "product_code":"dms", + "code":"7", + "des":"This section describes the notes and constraints on DMS.", + "doc_type":"usermanual", + "kw":"Notes and Constraints,Service Overview,User Guide", + "title":"Notes and Constraints", + "githuburl":"" + }, + { + "uri":"kafka-pd-190605002.html", + "product_code":"dms", + "code":"8", + "des":"Cloud Trace Service (CTS)CTS generates traces to provide you with a history of operations performed on cloud service resources. The traces include operation requests sent", + "doc_type":"usermanual", + "kw":"Related Services,Service Overview,User Guide", + "title":"Related Services", + "githuburl":"" + }, + { + "uri":"glossary-kafka.html", + "product_code":"dms", + "code":"9", + "des":"DMS for Kafka of the cloud service platform uses Kafka as the message engine. This chapter presents explanations of basic concepts of Kafka.A topic is a category for mess", + "doc_type":"usermanual", + "kw":"Basic Concepts,Service Overview,User Guide", + "title":"Basic Concepts", + "githuburl":"" + }, + { + "uri":"dms-ug-001.html", + "product_code":"dms", + "code":"10", + "des":"This section provides recommendations on configuring common parameters for Kafka producers and consumers.", + "doc_type":"usermanual", + "kw":"Best Practices,Service Overview,User Guide", + "title":"Best Practices", + "githuburl":"" + }, + { + "uri":"dms-ug-190128001.html", + "product_code":"dms", + "code":"11", + "des":"By default, there are two types of user permissions: user management and resource management.User management refers to the management of users, user groups, and user grou", + "doc_type":"usermanual", + "kw":"Permissions,Service Overview,User Guide", + "title":"Permissions", + "githuburl":"" + }, + { + "uri":"kafka-ug-180604012.html", + "product_code":"dms", + "code":"12", + "des":"Before creating a Kafka instance, ensure the availability of resources, including a virtual private cloud (VPC), subnet, security group, and security group rules. Each Ka", + "doc_type":"usermanual", + "kw":"Preparing Required Resources,User Guide", + "title":"Preparing Required Resources", + "githuburl":"" + }, + { + "uri":"dms-ug-180604013.html", + "product_code":"dms", + "code":"13", + "des":"Kafka instances are physically isolated and exclusively occupied by each tenant. You can customize the computing capabilities and storage space of an instance based on se", + "doc_type":"usermanual", + "kw":"Creating an Instance,User Guide", + "title":"Creating an Instance", + "githuburl":"" + }, + { + "uri":"kafka-ug190605003.html", + "product_code":"dms", + "code":"14", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Accessing a Kafka Instance", + "title":"Accessing a Kafka Instance", + "githuburl":"" + }, + { + "uri":"kafka-ug-180604020.html", + "product_code":"dms", + "code":"15", + "des":"This section describes how to use an open-source Kafka client to access a Kafka instance if SASL access is not enabled for the instance. There are two scenarios. For cros", + "doc_type":"usermanual", + "kw":"Accessing a Kafka Instance Without SASL,Accessing a Kafka Instance,User Guide", + "title":"Accessing a Kafka Instance Without SASL", + "githuburl":"" + }, + { + "uri":"kafka-ug-180801001.html", + "product_code":"dms", + "code":"16", + "des":"If you enable SASL_SSL when creating an instance, data will be encrypted before transmission for enhanced security.For security purposes, TLS_ECDHE_RSA_WITH_AES_128_GCM_S", + "doc_type":"usermanual", + "kw":"Accessing a Kafka Instance with SASL,Accessing a Kafka Instance,User Guide", + "title":"Accessing a Kafka Instance with SASL", + "githuburl":"" + }, + { + "uri":"kafka-ug-0001.html", + "product_code":"dms", + "code":"17", + "des":"VPCs are logically isolated from each other. If a Kafka instance and a Kafka client are in different VPCs within a region, they cannot communicate with each other. In thi", + "doc_type":"usermanual", + "kw":"Cross-VPC Access to a Kafka Instance,Accessing a Kafka Instance,User Guide", + "title":"Cross-VPC Access to a Kafka Instance", + "githuburl":"" + }, + { + "uri":"kafka-dnat.html", + "product_code":"dms", + "code":"18", + "des":"You can use destination NAT (DNAT) to access a Kafka instance so that the instance can provide services on the public network through port mapping.You have created EIPs. ", + "doc_type":"usermanual", + "kw":"Using DNAT to Access a Kafka Instance,Accessing a Kafka Instance,User Guide", + "title":"Using DNAT to Access a Kafka Instance", + "githuburl":"" + }, + { + "uri":"kafka-ug-180604011.html", + "product_code":"dms", + "code":"19", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Managing Instances", + "title":"Managing Instances", + "githuburl":"" + }, + { + "uri":"kafka-ug-180604014.html", + "product_code":"dms", + "code":"20", + "des":"View detailed information about a Kafka instance on the DMS console, for example, the IP addresses and port numbers for accessing the instance.Select the region where you", + "doc_type":"usermanual", + "kw":"Viewing an Instance,Managing Instances,User Guide", + "title":"Viewing an Instance", + "githuburl":"" + }, + { + "uri":"kafka-ug-180604015.html", + "product_code":"dms", + "code":"21", + "des":"Restart one or more Kafka instances at a time on the DMS console.When a Kafka instance is being restarted, message retrieval and creation requests of clients will be reje", + "doc_type":"usermanual", + "kw":"Restarting an Instance,Managing Instances,User Guide", + "title":"Restarting an Instance", + "githuburl":"" + }, + { + "uri":"kafka-ug-180604016.html", + "product_code":"dms", + "code":"22", + "des":"On the DMS console, you can delete one or more Kafka instances that have been created or failed to be created.Deleting a Kafka instance will delete the data in the instan", + "doc_type":"usermanual", + "kw":"Deleting an Instance,Managing Instances,User Guide", + "title":"Deleting an Instance", + "githuburl":"" + }, + { + "uri":"kafka-ug-180604017.html", + "product_code":"dms", + "code":"23", + "des":"After creating a Kafka instance, you can modify some parameters of the instance based on service requirements, including the instance name, description, security group, a", + "doc_type":"usermanual", + "kw":"Modifying the Information About an Instance,Managing Instances,User Guide", + "title":"Modifying the Information About an Instance", + "githuburl":"" + }, + { + "uri":"kafka-ug-0319001.html", + "product_code":"dms", + "code":"24", + "des":"To access a Kafka instance over a public network, enable public access and configure EIPs for the instance.If you no longer need public access to the instance, you can di", + "doc_type":"usermanual", + "kw":"Configuring Public Access,Managing Instances,User Guide", + "title":"Configuring Public Access", + "githuburl":"" + }, + { + "uri":"kafka-ug-180718001.html", + "product_code":"dms", + "code":"25", + "des":"You can reset the SASL_SSL password for accessing a Kafka instance by resetting Kafka password if you forget it.You can reset the Kafka password only if Kafka SASL_SSL ha", + "doc_type":"usermanual", + "kw":"Resetting Kafka Password,Managing Instances,User Guide", + "title":"Resetting Kafka Password", + "githuburl":"" + }, + { + "uri":"TagManagement.html", + "product_code":"dms", + "code":"26", + "des":"Tags facilitate Kafka instance identification and management.You can add tags to a Kafka instance when creating the instance or add tags on the Tags tab page of the creat", + "doc_type":"usermanual", + "kw":"Managing Instance Tags,Managing Instances,User Guide", + "title":"Managing Instance Tags", + "githuburl":"" + }, + { + "uri":"kafka-ug-200119002.html", + "product_code":"dms", + "code":"27", + "des":"After you initiate certain instance operations such as configuring public access and modifying the capacity threshold policy, a background task will start for each operat", + "doc_type":"usermanual", + "kw":"Viewing Background Tasks,Managing Instances,User Guide", + "title":"Viewing Background Tasks", + "githuburl":"" + }, + { + "uri":"kafka-ug-0004.html", + "product_code":"dms", + "code":"28", + "des":"On the Kafka console, you can view the disk usage of each broker.Select the region where your Kafka instance is located.You can query topics that use the most disk space ", + "doc_type":"usermanual", + "kw":"Viewing Disk Usage,Managing Instances,User Guide", + "title":"Viewing Disk Usage", + "githuburl":"" + }, + { + "uri":"kafka-ug-0720001.html", + "product_code":"dms", + "code":"29", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Managing Topics", + "title":"Managing Topics", + "githuburl":"" + }, + { + "uri":"dms-ug-180604018.html", + "product_code":"dms", + "code":"30", + "des":"A topic is a stream of messages. If automatic topic creation is not enabled during Kafka instance creation, you need to manually create topics for creating and retrieving", + "doc_type":"usermanual", + "kw":"Creating a Topic,Managing Topics,User Guide", + "title":"Creating a Topic", + "githuburl":"" + }, + { + "uri":"kafka-ug-180604019.html", + "product_code":"dms", + "code":"31", + "des":"Delete a topic using either of the following methods:By using the consoleBy using Kafka CLIA Kafka instance has been created, and a topic has been created in this instanc", + "doc_type":"usermanual", + "kw":"Deleting a Topic,Managing Topics,User Guide", + "title":"Deleting a Topic", + "githuburl":"" + }, + { + "uri":"kafka-ug-200506001.html", + "product_code":"dms", + "code":"32", + "des":"Aging time is a period that messages in the topic are retained for. Consumers must retrieve messages before this period ends. Otherwise, the messages will be deleted and ", + "doc_type":"usermanual", + "kw":"Modifying Topic Aging Time,Managing Topics,User Guide", + "title":"Modifying Topic Aging Time", + "githuburl":"" + }, + { + "uri":"kafka-ug-0006.html", + "product_code":"dms", + "code":"33", + "des":"After creating a topic, you can increase the number of partitions based on service requirements.Changing the number of partitions does not affect services.Methods for cha", + "doc_type":"usermanual", + "kw":"Changing Partition Quantity,Managing Topics,User Guide", + "title":"Changing Partition Quantity", + "githuburl":"" + }, + { + "uri":"kafka_ug_0022.html", + "product_code":"dms", + "code":"34", + "des":"Synchronous replication: A message is returned to the client only after the message creation request has been received and the message has been acknowledged by all replic", + "doc_type":"usermanual", + "kw":"Modifying Synchronous Replication and Flushing Settings,Managing Topics,User Guide", + "title":"Modifying Synchronous Replication and Flushing Settings", + "githuburl":"" + }, + { + "uri":"kafka_ug_0024.html", + "product_code":"dms", + "code":"35", + "des":"On the console, view sample code for creating and retrieving messages in Java, Go, and Python.Select the region where your Kafka instance is located.View sample code for ", + "doc_type":"usermanual", + "kw":"Viewing Sample Code,Managing Topics,User Guide", + "title":"Viewing Sample Code", + "githuburl":"" + }, + { + "uri":"kafka_ug_0027.html", + "product_code":"dms", + "code":"36", + "des":"Export topics on the console. Batch export is supported.A topic has been created.Select the region where your Kafka instance is located.The topic list contains the follow", + "doc_type":"usermanual", + "kw":"Exporting Topics,Managing Topics,User Guide", + "title":"Exporting Topics", + "githuburl":"" + }, + { + "uri":"kafka-ug-0720002.html", + "product_code":"dms", + "code":"37", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Managing Messages", + "title":"Managing Messages", + "githuburl":"" + }, + { + "uri":"kafka-ug-190904001.html", + "product_code":"dms", + "code":"38", + "des":"You can view the offset of different partitions, the message size, creation time, and body of messages in topics.Select the region where your Kafka instance is located.If", + "doc_type":"usermanual", + "kw":"Querying Messages,Managing Messages,User Guide", + "title":"Querying Messages", + "githuburl":"" + }, + { + "uri":"kafka-ug-0009.html", + "product_code":"dms", + "code":"39", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Managing Users", + "title":"Managing Users", + "githuburl":"" + }, + { + "uri":"kafka-ug-0003.html", + "product_code":"dms", + "code":"40", + "des":"DMS supports ACL permission management for topics. You can differentiate the operations that different users are allowed to perform on a topic by granting the users diffe", + "doc_type":"usermanual", + "kw":"Creating a SASL_SSL User,Managing Users,User Guide", + "title":"Creating a SASL_SSL User", + "githuburl":"" + }, + { + "uri":"kafka-ug-0002.html", + "product_code":"dms", + "code":"41", + "des":"DMS supports ACL permission management for topics. You can differentiate the operations that different users are allowed to perform on a topic by granting the users diffe", + "doc_type":"usermanual", + "kw":"Granting Permissions to a SASL_SSL User,Managing Users,User Guide", + "title":"Granting Permissions to a SASL_SSL User", + "githuburl":"" + }, + { + "uri":"kafka_ug_0025.html", + "product_code":"dms", + "code":"42", + "des":"If you forget the password of a SASL_SSL user created on the Users tab page, you can reset the password and use the new password to connect to the Kafka instance.If you f", + "doc_type":"usermanual", + "kw":"Resetting the SASL_SSL Password,Managing Users,User Guide", + "title":"Resetting the SASL_SSL Password", + "githuburl":"" + }, + { + "uri":"kafka_ug_0026.html", + "product_code":"dms", + "code":"43", + "des":"This section describes how to delete a SASL_SSL user.Select the region where your Kafka instance is located.On the Users tab page, click Delete in the row that contains t", + "doc_type":"usermanual", + "kw":"Deleting a SASL_SSL User,Managing Users,User Guide", + "title":"Deleting a SASL_SSL User", + "githuburl":"" + }, + { + "uri":"kafka-ug-0011.html", + "product_code":"dms", + "code":"44", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Managing Consumer Groups", + "title":"Managing Consumer Groups", + "githuburl":"" + }, + { + "uri":"kafka_ug_0021.html", + "product_code":"dms", + "code":"45", + "des":"View the consumer group list, consumer list, and consumer offsets.The consumer list can be viewed only when consumers in a consumer group are connected to the Kafka insta", + "doc_type":"usermanual", + "kw":"Querying Consumer Group Details,Managing Consumer Groups,User Guide", + "title":"Querying Consumer Group Details", + "githuburl":"" + }, + { + "uri":"kafka-ug-0012.html", + "product_code":"dms", + "code":"46", + "des":"You can delete a consumer group using either of the following methods:Method 1: Delete a consumer group on the console.Method 2: Use Kafka CLI to delete a consumer group.", + "doc_type":"usermanual", + "kw":"Deleting a Consumer Group,Managing Consumer Groups,User Guide", + "title":"Deleting a Consumer Group", + "githuburl":"" + }, + { + "uri":"kafka-ug-0014.html", + "product_code":"dms", + "code":"47", + "des":"Resetting the consumer offset is to change the retrieval position of a consumer.Messages may be retrieved more than once after the offset is reset. Exercise caution when ", + "doc_type":"usermanual", + "kw":"Resetting the Consumer Offset,Managing Consumer Groups,User Guide", + "title":"Resetting the Consumer Offset", + "githuburl":"" + }, + { + "uri":"kafka-ug-0015.html", + "product_code":"dms", + "code":"48", + "des":"View consumer connection addresses on the DMS console.The connection address of a consumer can be viewed only when the consumer is connected to a Kafka instance.Select th", + "doc_type":"usermanual", + "kw":"Viewing Consumer Connection Addresses,Managing Consumer Groups,User Guide", + "title":"Viewing Consumer Connection Addresses", + "githuburl":"" + }, + { + "uri":"kafka-ug-0007.html", + "product_code":"dms", + "code":"49", + "des":"Your Kafka instances, topics, and consumers come with default configuration parameter settings. You can modify common parameters on the DMS console. For details about par", + "doc_type":"usermanual", + "kw":"Modifying Kafka Parameters,User Guide", + "title":"Modifying Kafka Parameters", + "githuburl":"" + }, + { + "uri":"kafka-ug-180413001.html", + "product_code":"dms", + "code":"50", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Monitoring", + "title":"Monitoring", + "githuburl":"" + }, + { + "uri":"kafka-ug-190605001.html", + "product_code":"dms", + "code":"51", + "des":"Cloud Eye monitors Kafka instance metrics in real time. You can view these metrics on the Cloud Eye console.At least one Kafka instance has been created. The instance has", + "doc_type":"usermanual", + "kw":"Viewing Metrics,Monitoring,User Guide", + "title":"Viewing Metrics", + "githuburl":"" + }, + { + "uri":"dms-ug-180413002.html", + "product_code":"dms", + "code":"52", + "des":"This section describes DMS metrics reported to Cloud Eye as well as their namespace and dimensions. You can use the Cloud Eye console to query the Kafka metrics and alarm", + "doc_type":"usermanual", + "kw":"Kafka Metrics,Monitoring,User Guide", + "title":"Kafka Metrics", + "githuburl":"" + }, + { + "uri":"kafka-ug-180418001.html", + "product_code":"dms", + "code":"53", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Auditing", + "title":"Auditing", + "githuburl":"" + }, + { + "uri":"kafka-ug-180418002.html", + "product_code":"dms", + "code":"54", + "des":"With Cloud Trace Service (CTS), you can record operations associated with DMS for later query, audit, and backtrack operations.", + "doc_type":"usermanual", + "kw":"Operations Logged by CTS,Auditing,User Guide", + "title":"Operations Logged by CTS", + "githuburl":"" + }, + { + "uri":"kafka-ug-180418003.html", + "product_code":"dms", + "code":"55", + "des":"This section describes how to view operation records of the last 7 days on the CTS console.Select the region where your Kafka instance is located.Trace Source: Select DMS", + "doc_type":"usermanual", + "kw":"Viewing Audit Logs,Auditing,User Guide", + "title":"Viewing Audit Logs", + "githuburl":"" + }, + { + "uri":"kafka-ug-0723004.html", + "product_code":"dms", + "code":"56", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"FAQs", + "title":"FAQs", + "githuburl":"" + }, + { + "uri":"kafka-faq-191030002.html", + "product_code":"dms", + "code":"57", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Instances", + "title":"Instances", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426002.html", + "product_code":"dms", + "code":"58", + "des":"To improve the reliability of a Kafka instance, you are advised to select three AZs or more when creating the instance. You cannot select two AZs.Each Kafka instance cont", + "doc_type":"usermanual", + "kw":"Why Can't I Select Two AZs?,Instances,User Guide", + "title":"Why Can't I Select Two AZs?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426003.html", + "product_code":"dms", + "code":"59", + "des":"This may be because you do not have the Server Administrator and VPC Administrator permissions. For details about how to add permissions to a user group, see \"User and Us", + "doc_type":"usermanual", + "kw":"Why Can't I View the Subnet and Security Group Information When Creating a DMS Instance?,Instances,U", + "title":"Why Can't I View the Subnet and Security Group Information When Creating a DMS Instance?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426005.html", + "product_code":"dms", + "code":"60", + "des":"The storage space is the space for storing messages (including messages in replicas), logs and metadata. When specifying storage space, specify the disk type and disk siz", + "doc_type":"usermanual", + "kw":"How Do I Select Storage Space for a Kafka Instance?,Instances,User Guide", + "title":"How Do I Select Storage Space for a Kafka Instance?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426006.html", + "product_code":"dms", + "code":"61", + "des":"High I/O: The average latency is 6 to 10 ms, and the maximum bandwidth is 120 MB/s (read + write).Ultra-high I/O: The average latency is 1 to 3 ms, and the maximum bandwi", + "doc_type":"usermanual", + "kw":"How Do I Choose Between High I/O and Ultra-high I/O?,Instances,User Guide", + "title":"How Do I Choose Between High I/O and Ultra-high I/O?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426007.html", + "product_code":"dms", + "code":"62", + "des":"The following policies are supported:Stop productionWhen the memory usage reaches the disk capacity threshold (95%), new messages will no longer be created, but existing ", + "doc_type":"usermanual", + "kw":"Which Capacity Threshold Policy Should I Use?,Instances,User Guide", + "title":"Which Capacity Threshold Policy Should I Use?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426008.html", + "product_code":"dms", + "code":"63", + "des":"Kafka v1.1.0, v2.3.0, and v2.7.", + "doc_type":"usermanual", + "kw":"Which Kafka Versions Are Supported?,Instances,User Guide", + "title":"Which Kafka Versions Are Supported?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426009.html", + "product_code":"dms", + "code":"64", + "des":"Kafka instances are managed using ZooKeeper. Opening ZooKeeper may cause misoperations and service losses. ZooKeeper is used only within Kafka clusters and does not provi", + "doc_type":"usermanual", + "kw":"What Is the ZooKeeper Address of a Kafka Instance?,Instances,User Guide", + "title":"What Is the ZooKeeper Address of a Kafka Instance?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426010.html", + "product_code":"dms", + "code":"65", + "des":"Yes. A Kafka instance is a cluster that consists of three or more brokers.", + "doc_type":"usermanual", + "kw":"Are Kafka Instances in Cluster Mode?,Instances,User Guide", + "title":"Are Kafka Instances in Cluster Mode?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426011.html", + "product_code":"dms", + "code":"66", + "des":"No. You must access a Kafka instance through one of the following ports:Accessing a Kafka instance without SASL:The port varies with the access mode:Intra-VPC access: por", + "doc_type":"usermanual", + "kw":"Can I Modify the Connection Address for Accessing a Kafka Instance?,Instances,User Guide", + "title":"Can I Modify the Connection Address for Accessing a Kafka Instance?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426012.html", + "product_code":"dms", + "code":"67", + "des":"The certificates are valid for more than 15 years. You do not need to worry about certificate expiration. The certificates are used for one-way authentication when enabli", + "doc_type":"usermanual", + "kw":"How Long Are Kafka SSL Certificates Valid for?,Instances,User Guide", + "title":"How Long Are Kafka SSL Certificates Valid for?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426013.html", + "product_code":"dms", + "code":"68", + "des":"Unfortunately, you cannot synchronize two Kafka instances in real time. To migrate services from one instance to another, create messages to both instances. After all mes", + "doc_type":"usermanual", + "kw":"How Do I Synchronize Data from One Kafka Instance to Another?,Instances,User Guide", + "title":"How Do I Synchronize Data from One Kafka Instance to Another?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426014.html", + "product_code":"dms", + "code":"69", + "des":"The SASL_SSL setting cannot be changed once the instance has been created. Be careful when configuring this setting during instance creation. If you need to change the se", + "doc_type":"usermanual", + "kw":"How Do I Change the SASL_SSL Setting of a Kafka Instance?,Instances,User Guide", + "title":"How Do I Change the SASL_SSL Setting of a Kafka Instance?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0015.html", + "product_code":"dms", + "code":"70", + "des":"Kafka brokers and ZooKeeper are deployed on the same VM.", + "doc_type":"usermanual", + "kw":"Are Kafka Brokers and ZooKeeper Deployed on the Same VM or on Different VMs?,Instances,User Guide", + "title":"Are Kafka Brokers and ZooKeeper Deployed on the Same VM or on Different VMs?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0020.html", + "product_code":"dms", + "code":"71", + "des":"For security purposes, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 is supported.", + "doc_type":"usermanual", + "kw":"Which Cipher Suites Are Supported by Kafka?,Instances,User Guide", + "title":"Which Cipher Suites Are Supported by Kafka?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0023.html", + "product_code":"dms", + "code":"72", + "des":"No. The AZ configuration cannot be changed once the instance is created. To use multiple AZs, create another instance.", + "doc_type":"usermanual", + "kw":"Can I Change an Instance from Single-AZ Deployment to Multi-AZ Deployment?,Instances,User Guide", + "title":"Can I Change an Instance from Single-AZ Deployment to Multi-AZ Deployment?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0025.html", + "product_code":"dms", + "code":"73", + "des":"DMS for Kafka supports cross-AZ disaster recovery. If you select multiple AZs when creating an instance, cross-AZ disaster recovery will be available.You can view the AZs", + "doc_type":"usermanual", + "kw":"Does DMS for Kafka Support Cross-AZ Disaster Recovery? Where Can I View the AZs Configured for an Ex", + "title":"Does DMS for Kafka Support Cross-AZ Disaster Recovery? Where Can I View the AZs Configured for an Existing Instance?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0030.html", + "product_code":"dms", + "code":"74", + "des":"Yes.", + "doc_type":"usermanual", + "kw":"Do Kafka Instances Support Disk Encryption?,Instances,User Guide", + "title":"Do Kafka Instances Support Disk Encryption?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0036.html", + "product_code":"dms", + "code":"75", + "des":"No. Once an instance is created, its VPC and subnet cannot be changed.", + "doc_type":"usermanual", + "kw":"Can I Change the VPC and Subnet After a Kafka Instance Is Created?,Instances,User Guide", + "title":"Can I Change the VPC and Subnet After a Kafka Instance Is Created?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0037.html", + "product_code":"dms", + "code":"76", + "des":"You can find Kafka Streams use cases on the official Kafka website.", + "doc_type":"usermanual", + "kw":"Where Can I Find Kafka Streams Use Cases?,Instances,User Guide", + "title":"Where Can I Find Kafka Streams Use Cases?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0040.html", + "product_code":"dms", + "code":"77", + "des":"No. Kafka instances cannot be upgraded once they are created. To use a higher Kafka version, create another Kafka instance.", + "doc_type":"usermanual", + "kw":"Can I Upgrade Kafka Instances?,Instances,User Guide", + "title":"Can I Upgrade Kafka Instances?", + "githuburl":"" + }, + { + "uri":"kafka_faq_0046.html", + "product_code":"dms", + "code":"78", + "des":"On the DMS console, click the name of the target Kafka instance. Disable Public Access in the Connection section on the Basic Information tab page, and then enable it aga", + "doc_type":"usermanual", + "kw":"How Do I Bind an EIP Again?,Instances,User Guide", + "title":"How Do I Bind an EIP Again?", + "githuburl":"" + }, + { + "uri":"kafka-faq-191030001.html", + "product_code":"dms", + "code":"79", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Connections", + "title":"Connections", + "githuburl":"" + }, + { + "uri":"kafka-faq-0604001.html", + "product_code":"dms", + "code":"80", + "des":"This section describes how to troubleshoot Kafka connection problems.If the connection to a Kafka instance is abnormal, perform the following operations to troubleshoot t", + "doc_type":"usermanual", + "kw":"Troubleshooting Kafka Connection Exceptions,Connections,User Guide", + "title":"Troubleshooting Kafka Connection Exceptions", + "githuburl":"" + }, + { + "uri":"kafka-faq-180604024.html", + "product_code":"dms", + "code":"81", + "des":"Kafka instances can be accessed within a VPC, across VPCs, through DNAT, or over public networks. Before accessing a Kafka instance, configure a security group.If they us", + "doc_type":"usermanual", + "kw":"How Do I Select and Configure a Security Group?,Connections,User Guide", + "title":"How Do I Select and Configure a Security Group?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426015.html", + "product_code":"dms", + "code":"82", + "des":"Yes. For details, see the instance access instructions.", + "doc_type":"usermanual", + "kw":"Can I Access a Kafka Instance Over a Public Network?,Connections,User Guide", + "title":"Can I Access a Kafka Instance Over a Public Network?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426016.html", + "product_code":"dms", + "code":"83", + "des":"The number of connection addresses of a Kafka instance is the same as the number of brokers of the instance.", + "doc_type":"usermanual", + "kw":"How Many Connection Addresses Does a Kafka Instance Have by Default?,Connections,User Guide", + "title":"How Many Connection Addresses Does a Kafka Instance Have by Default?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426017.html", + "product_code":"dms", + "code":"84", + "des":"Yes. You can access a Kafka instance across regions over a public network or by using direct connections.", + "doc_type":"usermanual", + "kw":"Do Kafka Instances Support Cross-Region Access?,Connections,User Guide", + "title":"Do Kafka Instances Support Cross-Region Access?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426019.html", + "product_code":"dms", + "code":"85", + "des":"Yes. You can use one of the following methods to access a Kafka instance across VPCs:Establish a VPC peering connection to allow two VPCs to communicate with each other. ", + "doc_type":"usermanual", + "kw":"Do Kafka Instances Support Cross-VPC Access?,Connections,User Guide", + "title":"Do Kafka Instances Support Cross-VPC Access?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426020.html", + "product_code":"dms", + "code":"86", + "des":"Yes.If the client and the instance are in the same VPC, cross-subnet access is supported.", + "doc_type":"usermanual", + "kw":"Do Kafka Instances Support Cross-Subnet Access?,Connections,User Guide", + "title":"Do Kafka Instances Support Cross-Subnet Access?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426023.html", + "product_code":"dms", + "code":"87", + "des":"No, Kerberos authentication is not supported. Kafka supports client authentication with SASL and API calling authentication using tokens and AK/SK.To access an instance i", + "doc_type":"usermanual", + "kw":"Does DMS for Kafka Support Authentication with Kerberos?,Connections,User Guide", + "title":"Does DMS for Kafka Support Authentication with Kerberos?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200708002.html", + "product_code":"dms", + "code":"88", + "des":"Yes. No password is required for accessing a Kafka instance with SASL disabled. For details, see Accessing a Kafka Instance Without SASL.", + "doc_type":"usermanual", + "kw":"Does DMS for Kafka Support Password-Free Access?,Connections,User Guide", + "title":"Does DMS for Kafka Support Password-Free Access?", + "githuburl":"" + }, + { + "uri":"kafka-connect-other.html", + "product_code":"dms", + "code":"89", + "des":"Kafka instances are fully compatible with open-source clients. You can obtain clients in other programming languages and access your instance as instructed by the officia", + "doc_type":"usermanual", + "kw":"Obtaining Kafka Clients,Connections,User Guide", + "title":"Obtaining Kafka Clients", + "githuburl":"" + }, + { + "uri":"kafka-faq-0001.html", + "product_code":"dms", + "code":"90", + "des":"Click the name of your Kafka instance. In the Connection section on the Basic Information tab page, view Instance Address (Public Network).For details about how to connec", + "doc_type":"usermanual", + "kw":"How Do I Obtain the Public Access Address After Public Access Is Enabled?,Connections,User Guide", + "title":"How Do I Obtain the Public Access Address After Public Access Is Enabled?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0026.html", + "product_code":"dms", + "code":"91", + "des":"No.", + "doc_type":"usermanual", + "kw":"Does DMS for Kafka Support Authentication on Clients by the Server?,Connections,User Guide", + "title":"Does DMS for Kafka Support Authentication on Clients by the Server?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0027.html", + "product_code":"dms", + "code":"92", + "des":"No. You can only use JKS certificates for connecting to instances in Java.", + "doc_type":"usermanual", + "kw":"Can I Use PEM SSL Truststore When Connecting to a Kafka Instance with SASL_SSL Enabled?,Connections,", + "title":"Can I Use PEM SSL Truststore When Connecting to a Kafka Instance with SASL_SSL Enabled?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0028.html", + "product_code":"dms", + "code":"93", + "des":"JKS certificates are used for connecting to instances in Java and CRT certificates are used for connecting to instances in Python.", + "doc_type":"usermanual", + "kw":"What Are the Differences Between JKS and CRT Certificates?,Connections,User Guide", + "title":"What Are the Differences Between JKS and CRT Certificates?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0029.html", + "product_code":"dms", + "code":"94", + "des":"TLS 1.2.", + "doc_type":"usermanual", + "kw":"Which TLS Version Does DMS for Kafka Support?,Connections,User Guide", + "title":"Which TLS Version Does DMS for Kafka Support?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0033.html", + "product_code":"dms", + "code":"95", + "des":"Yes. The maximum allowed number of client connections varies by instance specifications.If the bandwidth is 100 MB/s, a maximum of 3000 client connections are allowed.If ", + "doc_type":"usermanual", + "kw":"Is There a Limit on the Number of Client Connections to a Kafka Instance?,Connections,User Guide", + "title":"Is There a Limit on the Number of Client Connections to a Kafka Instance?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0034.html", + "product_code":"dms", + "code":"96", + "des":"Each Kafka broker allows a maximum of 1000 connections from each IP address by default. Excess connections will be rejected. You can change the limit by referring to Modi", + "doc_type":"usermanual", + "kw":"How Many Connections Are Allowed from Each IP Address?,Connections,User Guide", + "title":"How Many Connections Are Allowed from Each IP Address?", + "githuburl":"" + }, + { + "uri":"kafka-faq-191030003.html", + "product_code":"dms", + "code":"97", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Topics and Partitions", + "title":"Topics and Partitions", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426024.html", + "product_code":"dms", + "code":"98", + "des":"The number of topics is related to the total number of topic partitions and the number of partitions in each topic. There is an upper limit on the aggregate number of par", + "doc_type":"usermanual", + "kw":"Is There a Limit on the Number of Topics in a Kafka Instance?,Topics and Partitions,User Guide", + "title":"Is There a Limit on the Number of Topics in a Kafka Instance?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426025.html", + "product_code":"dms", + "code":"99", + "des":"Kafka manages messages by partition. If there are too many partitions, message creation, storage, and retrieval will be fragmented, affecting the performance and stabilit", + "doc_type":"usermanual", + "kw":"Why Is Partition Quantity Limited?,Topics and Partitions,User Guide", + "title":"Why Is Partition Quantity Limited?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426101.html", + "product_code":"dms", + "code":"100", + "des":"No. If you want to use fewer partitions, delete the corresponding topic, create another one, and specify the desired number of partitions.", + "doc_type":"usermanual", + "kw":"Can I Change the Partition Quantity?,Topics and Partitions,User Guide", + "title":"Can I Change the Partition Quantity?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426026.html", + "product_code":"dms", + "code":"101", + "des":"Possible cause: The aggregate number of partitions of created topics has reached the upper limit. The maximum number of partitions varies with instance specifications. Fo", + "doc_type":"usermanual", + "kw":"Why Do I Fail to Create Topics?,Topics and Partitions,User Guide", + "title":"Why Do I Fail to Create Topics?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426027.html", + "product_code":"dms", + "code":"102", + "des":"Automatic topic creation is supported, but batch topic import is not supported. You can only export topics in batches.Enable automatic topic creation using one of the fol", + "doc_type":"usermanual", + "kw":"Do Kafka Instances Support Batch Importing Topics or Automatic Topic Creation?,Topics and Partitions", + "title":"Do Kafka Instances Support Batch Importing Topics or Automatic Topic Creation?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426028.html", + "product_code":"dms", + "code":"103", + "des":"This may be because automatic topic creation has been enabled and a consumer is connecting to the topic. If no existing topics are available for message creation, new top", + "doc_type":"usermanual", + "kw":"Why Do Deleted Topics Still Exist?,Topics and Partitions,User Guide", + "title":"Why Do Deleted Topics Still Exist?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426030.html", + "product_code":"dms", + "code":"104", + "des":"Yes. Use either of the following methods to check the disk space used by a topic:Click next to the Kafka instance name to go to the Cloud Eye console. On the Queues tab ", + "doc_type":"usermanual", + "kw":"Can I View the Disk Space Used by a Topic?,Topics and Partitions,User Guide", + "title":"Can I View the Disk Space Used by a Topic?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426032.html", + "product_code":"dms", + "code":"105", + "des":"If you have enabled SASL_SSL for your Kafka instance, you can configure ACL permissions for your topics. On the Topics tab page of the Kafka console, click Grant User Per", + "doc_type":"usermanual", + "kw":"Can I Add ACL Permissions for Topics?,Topics and Partitions,User Guide", + "title":"Can I Add ACL Permissions for Topics?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0003.html", + "product_code":"dms", + "code":"106", + "des":"Messages are not deleted immediately after being retrieved. They are deleted only when the aging time expires.You can shorten the aging time.", + "doc_type":"usermanual", + "kw":"What Should I Do If Kafka Storage Space Is Used Up Because Retrieved Messages Are Not Deleted?,Topic", + "title":"What Should I Do If Kafka Storage Space Is Used Up Because Retrieved Messages Are Not Deleted?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0010.html", + "product_code":"dms", + "code":"107", + "des":"Yes. A Kafka instance will be restarted if you enable or disable automatic topic creation for it.", + "doc_type":"usermanual", + "kw":"Will a Kafka Instance Be Restarted After Its Automatic Topic Creation Setting Is Modified?,Topics an", + "title":"Will a Kafka Instance Be Restarted After Its Automatic Topic Creation Setting Is Modified?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0014.html", + "product_code":"dms", + "code":"108", + "des":"On the Kafka console, click the name of your instance.In the Instance Information section of the Basic Information tab page, click next to Automatic Topic Creation to di", + "doc_type":"usermanual", + "kw":"How Do I Disable Automatic Topic Creation?,Topics and Partitions,User Guide", + "title":"How Do I Disable Automatic Topic Creation?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0031.html", + "product_code":"dms", + "code":"109", + "des":"Yes, just simply unsubscribe from it on the Kafka client.", + "doc_type":"usermanual", + "kw":"Can I Delete Unnecessary Topics in a Consumer Group?,Topics and Partitions,User Guide", + "title":"Can I Delete Unnecessary Topics in a Consumer Group?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0038.html", + "product_code":"dms", + "code":"110", + "des":"Symptom: Different consumers in a consumer group have different topic permissions. When a consumer attempts to retrieve messages from a topic, the error message \"Not auth", + "doc_type":"usermanual", + "kw":"What Can I Do If a Consumer Fails to Retrieve Messages from a Topic Due to Insufficient Permissions?", + "title":"What Can I Do If a Consumer Fails to Retrieve Messages from a Topic Due to Insufficient Permissions?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200423001.html", + "product_code":"dms", + "code":"111", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Consumer Groups", + "title":"Consumer Groups", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426033.html", + "product_code":"dms", + "code":"112", + "des":"No. They are generated automatically when you use the instance.For details about creating and retrieving messages after connecting to a Kafka instance, see Accessing a Ka", + "doc_type":"usermanual", + "kw":"Do I Need to Create Consumer Groups, Producers, and Consumers for Kafka Instances?,Consumer Groups,U", + "title":"Do I Need to Create Consumer Groups, Producers, and Consumers for Kafka Instances?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0032.html", + "product_code":"dms", + "code":"113", + "des":"No. You can directly delete the consumer group.", + "doc_type":"usermanual", + "kw":"Do I Need to Unsubscribe from a Topic Before Deleting a Consumer Group?,Consumer Groups,User Guide", + "title":"Do I Need to Unsubscribe from a Topic Before Deleting a Consumer Group?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0043.html", + "product_code":"dms", + "code":"114", + "des":"Yes.Kafka uses the offsets.retention.minutes parameter to control how long to keep offsets for a consumer group. If offsets are not committed within this period, they wil", + "doc_type":"usermanual", + "kw":"Will a Consumer Group Without Active Consumers Be Automatically Deleted in 14 Days?,Consumer Groups,", + "title":"Will a Consumer Group Without Active Consumers Be Automatically Deleted in 14 Days?", + "githuburl":"" + }, + { + "uri":"kafka-faq-190416001.html", + "product_code":"dms", + "code":"115", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Messages", + "title":"Messages", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426035.html", + "product_code":"dms", + "code":"116", + "des":"10 MB.", + "doc_type":"usermanual", + "kw":"What Is the Maximum Size of a Message that Can be Created?,Messages,User Guide", + "title":"What Is the Maximum Size of a Message that Can be Created?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426036.html", + "product_code":"dms", + "code":"117", + "des":"Rebalancing is a process where partitions of topics are re-allocated for a consumer group.In normal cases, rebalancing occurs inevitably when a consumer is added to or re", + "doc_type":"usermanual", + "kw":"Why Does Message Poll Often Fail During Rebalancing?,Messages,User Guide", + "title":"Why Does Message Poll Often Fail During Rebalancing?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426037.html", + "product_code":"dms", + "code":"118", + "des":"Possible cause 1: The message has been aged.Solution: Change the aging time.Solution: Change the aging time.Possible cause 2: The createTime timestamp of the message is i", + "doc_type":"usermanual", + "kw":"Why Can't I Query Messages on the Console?,Messages,User Guide", + "title":"Why Can't I Query Messages on the Console?", + "githuburl":"" + }, + { + "uri":"kafka-faq-200708001.html", + "product_code":"dms", + "code":"119", + "des":"If the aging time has been set for a topic, the value of the log.retention.hours parameter does not take effect for the topic. The value of the log.retention.hours parame", + "doc_type":"usermanual", + "kw":"Why Do Messages Still Exist After the Retention Period Elapses?,Messages,User Guide", + "title":"Why Do Messages Still Exist After the Retention Period Elapses?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0018.html", + "product_code":"dms", + "code":"120", + "des":"No.", + "doc_type":"usermanual", + "kw":"Do Kafka Instances Support Delayed Message Delivery?,Messages,User Guide", + "title":"Do Kafka Instances Support Delayed Message Delivery?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0041.html", + "product_code":"dms", + "code":"121", + "des":"View the number of accumulated messages using any of the following methods:On the Consumer Groups page of an instance, click the name of the consumer group whose accumula", + "doc_type":"usermanual", + "kw":"How Do I View the Number of Accumulated Messages?,Messages,User Guide", + "title":"How Do I View the Number of Accumulated Messages?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0045.html", + "product_code":"dms", + "code":"122", + "des":"The message creation time is specified by CreateTime when a producer creates messages. If this parameter is not set during message creation, the message creation time is ", + "doc_type":"usermanual", + "kw":"Why Is the Message Creation Time Displayed as Year 1970?,Messages,User Guide", + "title":"Why Is the Message Creation Time Displayed as Year 1970?", + "githuburl":"" + }, + { + "uri":"kafka-faq-191030004.html", + "product_code":"dms", + "code":"123", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Monitoring & Alarm", + "title":"Monitoring & Alarm", + "githuburl":"" + }, + { + "uri":"kafka-faq-200426041.html", + "product_code":"dms", + "code":"124", + "des":"The possible causes are as follows:The topic name starts with a special character, such as an underscore (_) or a number sign (#).The consumer group name starts with a sp", + "doc_type":"usermanual", + "kw":"Why Can't I View the Monitoring Data?,Monitoring & Alarm,User Guide", + "title":"Why Can't I View the Monitoring Data?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0007.html", + "product_code":"dms", + "code":"125", + "des":"Symptom: The monitoring data shows that there are 810 million accumulated messages. However, the Kafka console shows that there are 100 million messages in all six topics", + "doc_type":"usermanual", + "kw":"Why Is the Monitored Number of Accumulated Messages Inconsistent with the Message Quantity Displayed", + "title":"Why Is the Monitored Number of Accumulated Messages Inconsistent with the Message Quantity Displayed on the Kafka Console?", + "githuburl":"" + }, + { + "uri":"kafka-faq-0022.html", + "product_code":"dms", + "code":"126", + "des":"The monitoring data is reported every minute. The reported data will be displayed on the monitoring page after being sorted. This process takes less than 20 minutes. Afte", + "doc_type":"usermanual", + "kw":"Why Is a Consumer Group Still on the Monitoring Page After Being Deleted?,Monitoring & Alarm,User Gu", + "title":"Why Is a Consumer Group Still on the Monitoring Page After Being Deleted?", + "githuburl":"" + }, + { + "uri":"kafka-ug-00001.html", + "product_code":"dms", + "code":"127", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Change History,User Guide", + "title":"Change History", + "githuburl":"" + }, + { + "uri":"dms-ug-0312114.html", + "product_code":"dms", + "code":"128", + "des":"See Glossary.", + "doc_type":"usermanual", + "kw":"Glossary,User Guide", + "title":"Glossary", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/dms/umn/CLASS.TXT.json b/docs/dms/umn/CLASS.TXT.json new file mode 100644 index 000000000..bf94028ef --- /dev/null +++ b/docs/dms/umn/CLASS.TXT.json @@ -0,0 +1,1154 @@ +[ + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Service Overview", + "uri":"kafka-ug-0723001.html", + "doc_type":"usermanual", + "p_code":"", + "code":"1" + }, + { + "desc":"Apache Kafka is distributed message middleware that features high throughput, data persistence, horizontal scalability, and stream data processing. It adopts the publish-", + "product_code":"dms", + "title":"What Is DMS?", + "uri":"kafka-pd-190605001.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"2" + }, + { + "desc":"DMS provides easy-to-use message queuing based on Apache Kafka. Services can be quickly migrated to the cloud without any change, reducing maintenance and usage costs.Rap", + "product_code":"dms", + "title":"Product Advantages", + "uri":"kafka-advantage.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"3" + }, + { + "desc":"Kafka is popular message-oriented middleware that features highly reliable, asynchronous message delivery. It is widely used for transmitting data between different syste", + "product_code":"dms", + "title":"Application Scenarios", + "uri":"kafka-scenarios.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"4" + }, + { + "desc":"Kafka instances are compatible with open-source Kafka 1.1.0, 2.3.0, and 2.7. The instance specifications are classified based on bandwidth, namely, 100 MB/s, 300 MB/s, 60", + "product_code":"dms", + "title":"Specifications", + "uri":"Kafka-specification.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"5" + }, + { + "desc":"DMS is compatible with open-source Kafka and has customized and enhanced Kafka features. In addition to the advantages of open-source Kafka, DMS for Kafka provides more r", + "product_code":"dms", + "title":"Comparing DMS for Kafka and Open-Source Kafka", + "uri":"kafka-pd-200720001.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"6" + }, + { + "desc":"This section describes the notes and constraints on DMS.", + "product_code":"dms", + "title":"Notes and Constraints", + "uri":"kafka-pd-190605003.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"7" + }, + { + "desc":"Cloud Trace Service (CTS)CTS generates traces to provide you with a history of operations performed on cloud service resources. The traces include operation requests sent", + "product_code":"dms", + "title":"Related Services", + "uri":"kafka-pd-190605002.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"8" + }, + { + "desc":"DMS for Kafka of the cloud service platform uses Kafka as the message engine. This chapter presents explanations of basic concepts of Kafka.A topic is a category for mess", + "product_code":"dms", + "title":"Basic Concepts", + "uri":"glossary-kafka.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"9" + }, + { + "desc":"This section provides recommendations on configuring common parameters for Kafka producers and consumers.", + "product_code":"dms", + "title":"Best Practices", + "uri":"dms-ug-001.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"10" + }, + { + "desc":"By default, there are two types of user permissions: user management and resource management.User management refers to the management of users, user groups, and user grou", + "product_code":"dms", + "title":"Permissions", + "uri":"dms-ug-190128001.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"11" + }, + { + "desc":"Before creating a Kafka instance, ensure the availability of resources, including a virtual private cloud (VPC), subnet, security group, and security group rules. Each Ka", + "product_code":"dms", + "title":"Preparing Required Resources", + "uri":"kafka-ug-180604012.html", + "doc_type":"usermanual", + "p_code":"", + "code":"12" + }, + { + "desc":"Kafka instances are physically isolated and exclusively occupied by each tenant. You can customize the computing capabilities and storage space of an instance based on se", + "product_code":"dms", + "title":"Creating an Instance", + "uri":"dms-ug-180604013.html", + "doc_type":"usermanual", + "p_code":"", + "code":"13" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Accessing a Kafka Instance", + "uri":"kafka-ug190605003.html", + "doc_type":"usermanual", + "p_code":"", + "code":"14" + }, + { + "desc":"This section describes how to use an open-source Kafka client to access a Kafka instance if SASL access is not enabled for the instance. There are two scenarios. For cros", + "product_code":"dms", + "title":"Accessing a Kafka Instance Without SASL", + "uri":"kafka-ug-180604020.html", + "doc_type":"usermanual", + "p_code":"14", + "code":"15" + }, + { + "desc":"If you enable SASL_SSL when creating an instance, data will be encrypted before transmission for enhanced security.For security purposes, TLS_ECDHE_RSA_WITH_AES_128_GCM_S", + "product_code":"dms", + "title":"Accessing a Kafka Instance with SASL", + "uri":"kafka-ug-180801001.html", + "doc_type":"usermanual", + "p_code":"14", + "code":"16" + }, + { + "desc":"VPCs are logically isolated from each other. If a Kafka instance and a Kafka client are in different VPCs within a region, they cannot communicate with each other. In thi", + "product_code":"dms", + "title":"Cross-VPC Access to a Kafka Instance", + "uri":"kafka-ug-0001.html", + "doc_type":"usermanual", + "p_code":"14", + "code":"17" + }, + { + "desc":"You can use destination NAT (DNAT) to access a Kafka instance so that the instance can provide services on the public network through port mapping.You have created EIPs. ", + "product_code":"dms", + "title":"Using DNAT to Access a Kafka Instance", + "uri":"kafka-dnat.html", + "doc_type":"usermanual", + "p_code":"14", + "code":"18" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Managing Instances", + "uri":"kafka-ug-180604011.html", + "doc_type":"usermanual", + "p_code":"", + "code":"19" + }, + { + "desc":"View detailed information about a Kafka instance on the DMS console, for example, the IP addresses and port numbers for accessing the instance.Select the region where you", + "product_code":"dms", + "title":"Viewing an Instance", + "uri":"kafka-ug-180604014.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"20" + }, + { + "desc":"Restart one or more Kafka instances at a time on the DMS console.When a Kafka instance is being restarted, message retrieval and creation requests of clients will be reje", + "product_code":"dms", + "title":"Restarting an Instance", + "uri":"kafka-ug-180604015.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"21" + }, + { + "desc":"On the DMS console, you can delete one or more Kafka instances that have been created or failed to be created.Deleting a Kafka instance will delete the data in the instan", + "product_code":"dms", + "title":"Deleting an Instance", + "uri":"kafka-ug-180604016.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"22" + }, + { + "desc":"After creating a Kafka instance, you can modify some parameters of the instance based on service requirements, including the instance name, description, security group, a", + "product_code":"dms", + "title":"Modifying the Information About an Instance", + "uri":"kafka-ug-180604017.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"23" + }, + { + "desc":"To access a Kafka instance over a public network, enable public access and configure EIPs for the instance.If you no longer need public access to the instance, you can di", + "product_code":"dms", + "title":"Configuring Public Access", + "uri":"kafka-ug-0319001.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"24" + }, + { + "desc":"You can reset the SASL_SSL password for accessing a Kafka instance by resetting Kafka password if you forget it.You can reset the Kafka password only if Kafka SASL_SSL ha", + "product_code":"dms", + "title":"Resetting Kafka Password", + "uri":"kafka-ug-180718001.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"25" + }, + { + "desc":"Tags facilitate Kafka instance identification and management.You can add tags to a Kafka instance when creating the instance or add tags on the Tags tab page of the creat", + "product_code":"dms", + "title":"Managing Instance Tags", + "uri":"TagManagement.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"26" + }, + { + "desc":"After you initiate certain instance operations such as configuring public access and modifying the capacity threshold policy, a background task will start for each operat", + "product_code":"dms", + "title":"Viewing Background Tasks", + "uri":"kafka-ug-200119002.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"27" + }, + { + "desc":"On the Kafka console, you can view the disk usage of each broker.Select the region where your Kafka instance is located.You can query topics that use the most disk space ", + "product_code":"dms", + "title":"Viewing Disk Usage", + "uri":"kafka-ug-0004.html", + "doc_type":"usermanual", + "p_code":"19", + "code":"28" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Managing Topics", + "uri":"kafka-ug-0720001.html", + "doc_type":"usermanual", + "p_code":"", + "code":"29" + }, + { + "desc":"A topic is a stream of messages. If automatic topic creation is not enabled during Kafka instance creation, you need to manually create topics for creating and retrieving", + "product_code":"dms", + "title":"Creating a Topic", + "uri":"dms-ug-180604018.html", + "doc_type":"usermanual", + "p_code":"29", + "code":"30" + }, + { + "desc":"Delete a topic using either of the following methods:By using the consoleBy using Kafka CLIA Kafka instance has been created, and a topic has been created in this instanc", + "product_code":"dms", + "title":"Deleting a Topic", + "uri":"kafka-ug-180604019.html", + "doc_type":"usermanual", + "p_code":"29", + "code":"31" + }, + { + "desc":"Aging time is a period that messages in the topic are retained for. Consumers must retrieve messages before this period ends. Otherwise, the messages will be deleted and ", + "product_code":"dms", + "title":"Modifying Topic Aging Time", + "uri":"kafka-ug-200506001.html", + "doc_type":"usermanual", + "p_code":"29", + "code":"32" + }, + { + "desc":"After creating a topic, you can increase the number of partitions based on service requirements.Changing the number of partitions does not affect services.Methods for cha", + "product_code":"dms", + "title":"Changing Partition Quantity", + "uri":"kafka-ug-0006.html", + "doc_type":"usermanual", + "p_code":"29", + "code":"33" + }, + { + "desc":"Synchronous replication: A message is returned to the client only after the message creation request has been received and the message has been acknowledged by all replic", + "product_code":"dms", + "title":"Modifying Synchronous Replication and Flushing Settings", + "uri":"kafka_ug_0022.html", + "doc_type":"usermanual", + "p_code":"29", + "code":"34" + }, + { + "desc":"On the console, view sample code for creating and retrieving messages in Java, Go, and Python.Select the region where your Kafka instance is located.View sample code for ", + "product_code":"dms", + "title":"Viewing Sample Code", + "uri":"kafka_ug_0024.html", + "doc_type":"usermanual", + "p_code":"29", + "code":"35" + }, + { + "desc":"Export topics on the console. Batch export is supported.A topic has been created.Select the region where your Kafka instance is located.The topic list contains the follow", + "product_code":"dms", + "title":"Exporting Topics", + "uri":"kafka_ug_0027.html", + "doc_type":"usermanual", + "p_code":"29", + "code":"36" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Managing Messages", + "uri":"kafka-ug-0720002.html", + "doc_type":"usermanual", + "p_code":"", + "code":"37" + }, + { + "desc":"You can view the offset of different partitions, the message size, creation time, and body of messages in topics.Select the region where your Kafka instance is located.If", + "product_code":"dms", + "title":"Querying Messages", + "uri":"kafka-ug-190904001.html", + "doc_type":"usermanual", + "p_code":"37", + "code":"38" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Managing Users", + "uri":"kafka-ug-0009.html", + "doc_type":"usermanual", + "p_code":"", + "code":"39" + }, + { + "desc":"DMS supports ACL permission management for topics. You can differentiate the operations that different users are allowed to perform on a topic by granting the users diffe", + "product_code":"dms", + "title":"Creating a SASL_SSL User", + "uri":"kafka-ug-0003.html", + "doc_type":"usermanual", + "p_code":"39", + "code":"40" + }, + { + "desc":"DMS supports ACL permission management for topics. You can differentiate the operations that different users are allowed to perform on a topic by granting the users diffe", + "product_code":"dms", + "title":"Granting Permissions to a SASL_SSL User", + "uri":"kafka-ug-0002.html", + "doc_type":"usermanual", + "p_code":"39", + "code":"41" + }, + { + "desc":"If you forget the password of a SASL_SSL user created on the Users tab page, you can reset the password and use the new password to connect to the Kafka instance.If you f", + "product_code":"dms", + "title":"Resetting the SASL_SSL Password", + "uri":"kafka_ug_0025.html", + "doc_type":"usermanual", + "p_code":"39", + "code":"42" + }, + { + "desc":"This section describes how to delete a SASL_SSL user.Select the region where your Kafka instance is located.On the Users tab page, click Delete in the row that contains t", + "product_code":"dms", + "title":"Deleting a SASL_SSL User", + "uri":"kafka_ug_0026.html", + "doc_type":"usermanual", + "p_code":"39", + "code":"43" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Managing Consumer Groups", + "uri":"kafka-ug-0011.html", + "doc_type":"usermanual", + "p_code":"", + "code":"44" + }, + { + "desc":"View the consumer group list, consumer list, and consumer offsets.The consumer list can be viewed only when consumers in a consumer group are connected to the Kafka insta", + "product_code":"dms", + "title":"Querying Consumer Group Details", + "uri":"kafka_ug_0021.html", + "doc_type":"usermanual", + "p_code":"44", + "code":"45" + }, + { + "desc":"You can delete a consumer group using either of the following methods:Method 1: Delete a consumer group on the console.Method 2: Use Kafka CLI to delete a consumer group.", + "product_code":"dms", + "title":"Deleting a Consumer Group", + "uri":"kafka-ug-0012.html", + "doc_type":"usermanual", + "p_code":"44", + "code":"46" + }, + { + "desc":"Resetting the consumer offset is to change the retrieval position of a consumer.Messages may be retrieved more than once after the offset is reset. Exercise caution when ", + "product_code":"dms", + "title":"Resetting the Consumer Offset", + "uri":"kafka-ug-0014.html", + "doc_type":"usermanual", + "p_code":"44", + "code":"47" + }, + { + "desc":"View consumer connection addresses on the DMS console.The connection address of a consumer can be viewed only when the consumer is connected to a Kafka instance.Select th", + "product_code":"dms", + "title":"Viewing Consumer Connection Addresses", + "uri":"kafka-ug-0015.html", + "doc_type":"usermanual", + "p_code":"44", + "code":"48" + }, + { + "desc":"Your Kafka instances, topics, and consumers come with default configuration parameter settings. You can modify common parameters on the DMS console. For details about par", + "product_code":"dms", + "title":"Modifying Kafka Parameters", + "uri":"kafka-ug-0007.html", + "doc_type":"usermanual", + "p_code":"", + "code":"49" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Monitoring", + "uri":"kafka-ug-180413001.html", + "doc_type":"usermanual", + "p_code":"", + "code":"50" + }, + { + "desc":"Cloud Eye monitors Kafka instance metrics in real time. You can view these metrics on the Cloud Eye console.At least one Kafka instance has been created. The instance has", + "product_code":"dms", + "title":"Viewing Metrics", + "uri":"kafka-ug-190605001.html", + "doc_type":"usermanual", + "p_code":"50", + "code":"51" + }, + { + "desc":"This section describes DMS metrics reported to Cloud Eye as well as their namespace and dimensions. You can use the Cloud Eye console to query the Kafka metrics and alarm", + "product_code":"dms", + "title":"Kafka Metrics", + "uri":"dms-ug-180413002.html", + "doc_type":"usermanual", + "p_code":"50", + "code":"52" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Auditing", + "uri":"kafka-ug-180418001.html", + "doc_type":"usermanual", + "p_code":"", + "code":"53" + }, + { + "desc":"With Cloud Trace Service (CTS), you can record operations associated with DMS for later query, audit, and backtrack operations.", + "product_code":"dms", + "title":"Operations Logged by CTS", + "uri":"kafka-ug-180418002.html", + "doc_type":"usermanual", + "p_code":"53", + "code":"54" + }, + { + "desc":"This section describes how to view operation records of the last 7 days on the CTS console.Select the region where your Kafka instance is located.Trace Source: Select DMS", + "product_code":"dms", + "title":"Viewing Audit Logs", + "uri":"kafka-ug-180418003.html", + "doc_type":"usermanual", + "p_code":"53", + "code":"55" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"FAQs", + "uri":"kafka-ug-0723004.html", + "doc_type":"usermanual", + "p_code":"", + "code":"56" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Instances", + "uri":"kafka-faq-191030002.html", + "doc_type":"usermanual", + "p_code":"56", + "code":"57" + }, + { + "desc":"To improve the reliability of a Kafka instance, you are advised to select three AZs or more when creating the instance. You cannot select two AZs.Each Kafka instance cont", + "product_code":"dms", + "title":"Why Can't I Select Two AZs?", + "uri":"kafka-faq-200426002.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"58" + }, + { + "desc":"This may be because you do not have the Server Administrator and VPC Administrator permissions. For details about how to add permissions to a user group, see \"User and Us", + "product_code":"dms", + "title":"Why Can't I View the Subnet and Security Group Information When Creating a DMS Instance?", + "uri":"kafka-faq-200426003.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"59" + }, + { + "desc":"The storage space is the space for storing messages (including messages in replicas), logs and metadata. When specifying storage space, specify the disk type and disk siz", + "product_code":"dms", + "title":"How Do I Select Storage Space for a Kafka Instance?", + "uri":"kafka-faq-200426005.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"60" + }, + { + "desc":"High I/O: The average latency is 6 to 10 ms, and the maximum bandwidth is 120 MB/s (read + write).Ultra-high I/O: The average latency is 1 to 3 ms, and the maximum bandwi", + "product_code":"dms", + "title":"How Do I Choose Between High I/O and Ultra-high I/O?", + "uri":"kafka-faq-200426006.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"61" + }, + { + "desc":"The following policies are supported:Stop productionWhen the memory usage reaches the disk capacity threshold (95%), new messages will no longer be created, but existing ", + "product_code":"dms", + "title":"Which Capacity Threshold Policy Should I Use?", + "uri":"kafka-faq-200426007.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"62" + }, + { + "desc":"Kafka v1.1.0, v2.3.0, and v2.7.", + "product_code":"dms", + "title":"Which Kafka Versions Are Supported?", + "uri":"kafka-faq-200426008.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"63" + }, + { + "desc":"Kafka instances are managed using ZooKeeper. Opening ZooKeeper may cause misoperations and service losses. ZooKeeper is used only within Kafka clusters and does not provi", + "product_code":"dms", + "title":"What Is the ZooKeeper Address of a Kafka Instance?", + "uri":"kafka-faq-200426009.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"64" + }, + { + "desc":"Yes. A Kafka instance is a cluster that consists of three or more brokers.", + "product_code":"dms", + "title":"Are Kafka Instances in Cluster Mode?", + "uri":"kafka-faq-200426010.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"65" + }, + { + "desc":"No. You must access a Kafka instance through one of the following ports:Accessing a Kafka instance without SASL:The port varies with the access mode:Intra-VPC access: por", + "product_code":"dms", + "title":"Can I Modify the Connection Address for Accessing a Kafka Instance?", + "uri":"kafka-faq-200426011.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"66" + }, + { + "desc":"The certificates are valid for more than 15 years. You do not need to worry about certificate expiration. The certificates are used for one-way authentication when enabli", + "product_code":"dms", + "title":"How Long Are Kafka SSL Certificates Valid for?", + "uri":"kafka-faq-200426012.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"67" + }, + { + "desc":"Unfortunately, you cannot synchronize two Kafka instances in real time. To migrate services from one instance to another, create messages to both instances. After all mes", + "product_code":"dms", + "title":"How Do I Synchronize Data from One Kafka Instance to Another?", + "uri":"kafka-faq-200426013.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"68" + }, + { + "desc":"The SASL_SSL setting cannot be changed once the instance has been created. Be careful when configuring this setting during instance creation. If you need to change the se", + "product_code":"dms", + "title":"How Do I Change the SASL_SSL Setting of a Kafka Instance?", + "uri":"kafka-faq-200426014.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"69" + }, + { + "desc":"Kafka brokers and ZooKeeper are deployed on the same VM.", + "product_code":"dms", + "title":"Are Kafka Brokers and ZooKeeper Deployed on the Same VM or on Different VMs?", + "uri":"kafka-faq-0015.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"70" + }, + { + "desc":"For security purposes, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 is supported.", + "product_code":"dms", + "title":"Which Cipher Suites Are Supported by Kafka?", + "uri":"kafka-faq-0020.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"71" + }, + { + "desc":"No. The AZ configuration cannot be changed once the instance is created. To use multiple AZs, create another instance.", + "product_code":"dms", + "title":"Can I Change an Instance from Single-AZ Deployment to Multi-AZ Deployment?", + "uri":"kafka-faq-0023.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"72" + }, + { + "desc":"DMS for Kafka supports cross-AZ disaster recovery. If you select multiple AZs when creating an instance, cross-AZ disaster recovery will be available.You can view the AZs", + "product_code":"dms", + "title":"Does DMS for Kafka Support Cross-AZ Disaster Recovery? Where Can I View the AZs Configured for an Existing Instance?", + "uri":"kafka-faq-0025.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"73" + }, + { + "desc":"Yes.", + "product_code":"dms", + "title":"Do Kafka Instances Support Disk Encryption?", + "uri":"kafka-faq-0030.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"74" + }, + { + "desc":"No. Once an instance is created, its VPC and subnet cannot be changed.", + "product_code":"dms", + "title":"Can I Change the VPC and Subnet After a Kafka Instance Is Created?", + "uri":"kafka-faq-0036.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"75" + }, + { + "desc":"You can find Kafka Streams use cases on the official Kafka website.", + "product_code":"dms", + "title":"Where Can I Find Kafka Streams Use Cases?", + "uri":"kafka-faq-0037.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"76" + }, + { + "desc":"No. Kafka instances cannot be upgraded once they are created. To use a higher Kafka version, create another Kafka instance.", + "product_code":"dms", + "title":"Can I Upgrade Kafka Instances?", + "uri":"kafka-faq-0040.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"77" + }, + { + "desc":"On the DMS console, click the name of the target Kafka instance. Disable Public Access in the Connection section on the Basic Information tab page, and then enable it aga", + "product_code":"dms", + "title":"How Do I Bind an EIP Again?", + "uri":"kafka_faq_0046.html", + "doc_type":"usermanual", + "p_code":"57", + "code":"78" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Connections", + "uri":"kafka-faq-191030001.html", + "doc_type":"usermanual", + "p_code":"56", + "code":"79" + }, + { + "desc":"This section describes how to troubleshoot Kafka connection problems.If the connection to a Kafka instance is abnormal, perform the following operations to troubleshoot t", + "product_code":"dms", + "title":"Troubleshooting Kafka Connection Exceptions", + "uri":"kafka-faq-0604001.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"80" + }, + { + "desc":"Kafka instances can be accessed within a VPC, across VPCs, through DNAT, or over public networks. Before accessing a Kafka instance, configure a security group.If they us", + "product_code":"dms", + "title":"How Do I Select and Configure a Security Group?", + "uri":"kafka-faq-180604024.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"81" + }, + { + "desc":"Yes. For details, see the instance access instructions.", + "product_code":"dms", + "title":"Can I Access a Kafka Instance Over a Public Network?", + "uri":"kafka-faq-200426015.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"82" + }, + { + "desc":"The number of connection addresses of a Kafka instance is the same as the number of brokers of the instance.", + "product_code":"dms", + "title":"How Many Connection Addresses Does a Kafka Instance Have by Default?", + "uri":"kafka-faq-200426016.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"83" + }, + { + "desc":"Yes. You can access a Kafka instance across regions over a public network or by using direct connections.", + "product_code":"dms", + "title":"Do Kafka Instances Support Cross-Region Access?", + "uri":"kafka-faq-200426017.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"84" + }, + { + "desc":"Yes. You can use one of the following methods to access a Kafka instance across VPCs:Establish a VPC peering connection to allow two VPCs to communicate with each other. ", + "product_code":"dms", + "title":"Do Kafka Instances Support Cross-VPC Access?", + "uri":"kafka-faq-200426019.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"85" + }, + { + "desc":"Yes.If the client and the instance are in the same VPC, cross-subnet access is supported.", + "product_code":"dms", + "title":"Do Kafka Instances Support Cross-Subnet Access?", + "uri":"kafka-faq-200426020.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"86" + }, + { + "desc":"No, Kerberos authentication is not supported. Kafka supports client authentication with SASL and API calling authentication using tokens and AK/SK.To access an instance i", + "product_code":"dms", + "title":"Does DMS for Kafka Support Authentication with Kerberos?", + "uri":"kafka-faq-200426023.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"87" + }, + { + "desc":"Yes. No password is required for accessing a Kafka instance with SASL disabled. For details, see Accessing a Kafka Instance Without SASL.", + "product_code":"dms", + "title":"Does DMS for Kafka Support Password-Free Access?", + "uri":"kafka-faq-200708002.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"88" + }, + { + "desc":"Kafka instances are fully compatible with open-source clients. You can obtain clients in other programming languages and access your instance as instructed by the officia", + "product_code":"dms", + "title":"Obtaining Kafka Clients", + "uri":"kafka-connect-other.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"89" + }, + { + "desc":"Click the name of your Kafka instance. In the Connection section on the Basic Information tab page, view Instance Address (Public Network).For details about how to connec", + "product_code":"dms", + "title":"How Do I Obtain the Public Access Address After Public Access Is Enabled?", + "uri":"kafka-faq-0001.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"90" + }, + { + "desc":"No.", + "product_code":"dms", + "title":"Does DMS for Kafka Support Authentication on Clients by the Server?", + "uri":"kafka-faq-0026.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"91" + }, + { + "desc":"No. You can only use JKS certificates for connecting to instances in Java.", + "product_code":"dms", + "title":"Can I Use PEM SSL Truststore When Connecting to a Kafka Instance with SASL_SSL Enabled?", + "uri":"kafka-faq-0027.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"92" + }, + { + "desc":"JKS certificates are used for connecting to instances in Java and CRT certificates are used for connecting to instances in Python.", + "product_code":"dms", + "title":"What Are the Differences Between JKS and CRT Certificates?", + "uri":"kafka-faq-0028.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"93" + }, + { + "desc":"TLS 1.2.", + "product_code":"dms", + "title":"Which TLS Version Does DMS for Kafka Support?", + "uri":"kafka-faq-0029.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"94" + }, + { + "desc":"Yes. The maximum allowed number of client connections varies by instance specifications.If the bandwidth is 100 MB/s, a maximum of 3000 client connections are allowed.If ", + "product_code":"dms", + "title":"Is There a Limit on the Number of Client Connections to a Kafka Instance?", + "uri":"kafka-faq-0033.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"95" + }, + { + "desc":"Each Kafka broker allows a maximum of 1000 connections from each IP address by default. Excess connections will be rejected. You can change the limit by referring to Modi", + "product_code":"dms", + "title":"How Many Connections Are Allowed from Each IP Address?", + "uri":"kafka-faq-0034.html", + "doc_type":"usermanual", + "p_code":"79", + "code":"96" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Topics and Partitions", + "uri":"kafka-faq-191030003.html", + "doc_type":"usermanual", + "p_code":"56", + "code":"97" + }, + { + "desc":"The number of topics is related to the total number of topic partitions and the number of partitions in each topic. There is an upper limit on the aggregate number of par", + "product_code":"dms", + "title":"Is There a Limit on the Number of Topics in a Kafka Instance?", + "uri":"kafka-faq-200426024.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"98" + }, + { + "desc":"Kafka manages messages by partition. If there are too many partitions, message creation, storage, and retrieval will be fragmented, affecting the performance and stabilit", + "product_code":"dms", + "title":"Why Is Partition Quantity Limited?", + "uri":"kafka-faq-200426025.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"99" + }, + { + "desc":"No. If you want to use fewer partitions, delete the corresponding topic, create another one, and specify the desired number of partitions.", + "product_code":"dms", + "title":"Can I Change the Partition Quantity?", + "uri":"kafka-faq-200426101.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"100" + }, + { + "desc":"Possible cause: The aggregate number of partitions of created topics has reached the upper limit. The maximum number of partitions varies with instance specifications. Fo", + "product_code":"dms", + "title":"Why Do I Fail to Create Topics?", + "uri":"kafka-faq-200426026.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"101" + }, + { + "desc":"Automatic topic creation is supported, but batch topic import is not supported. You can only export topics in batches.Enable automatic topic creation using one of the fol", + "product_code":"dms", + "title":"Do Kafka Instances Support Batch Importing Topics or Automatic Topic Creation?", + "uri":"kafka-faq-200426027.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"102" + }, + { + "desc":"This may be because automatic topic creation has been enabled and a consumer is connecting to the topic. If no existing topics are available for message creation, new top", + "product_code":"dms", + "title":"Why Do Deleted Topics Still Exist?", + "uri":"kafka-faq-200426028.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"103" + }, + { + "desc":"Yes. Use either of the following methods to check the disk space used by a topic:Click next to the Kafka instance name to go to the Cloud Eye console. On the Queues tab ", + "product_code":"dms", + "title":"Can I View the Disk Space Used by a Topic?", + "uri":"kafka-faq-200426030.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"104" + }, + { + "desc":"If you have enabled SASL_SSL for your Kafka instance, you can configure ACL permissions for your topics. On the Topics tab page of the Kafka console, click Grant User Per", + "product_code":"dms", + "title":"Can I Add ACL Permissions for Topics?", + "uri":"kafka-faq-200426032.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"105" + }, + { + "desc":"Messages are not deleted immediately after being retrieved. They are deleted only when the aging time expires.You can shorten the aging time.", + "product_code":"dms", + "title":"What Should I Do If Kafka Storage Space Is Used Up Because Retrieved Messages Are Not Deleted?", + "uri":"kafka-faq-0003.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"106" + }, + { + "desc":"Yes. A Kafka instance will be restarted if you enable or disable automatic topic creation for it.", + "product_code":"dms", + "title":"Will a Kafka Instance Be Restarted After Its Automatic Topic Creation Setting Is Modified?", + "uri":"kafka-faq-0010.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"107" + }, + { + "desc":"On the Kafka console, click the name of your instance.In the Instance Information section of the Basic Information tab page, click next to Automatic Topic Creation to di", + "product_code":"dms", + "title":"How Do I Disable Automatic Topic Creation?", + "uri":"kafka-faq-0014.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"108" + }, + { + "desc":"Yes, just simply unsubscribe from it on the Kafka client.", + "product_code":"dms", + "title":"Can I Delete Unnecessary Topics in a Consumer Group?", + "uri":"kafka-faq-0031.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"109" + }, + { + "desc":"Symptom: Different consumers in a consumer group have different topic permissions. When a consumer attempts to retrieve messages from a topic, the error message \"Not auth", + "product_code":"dms", + "title":"What Can I Do If a Consumer Fails to Retrieve Messages from a Topic Due to Insufficient Permissions?", + "uri":"kafka-faq-0038.html", + "doc_type":"usermanual", + "p_code":"97", + "code":"110" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Consumer Groups", + "uri":"kafka-faq-200423001.html", + "doc_type":"usermanual", + "p_code":"56", + "code":"111" + }, + { + "desc":"No. They are generated automatically when you use the instance.For details about creating and retrieving messages after connecting to a Kafka instance, see Accessing a Ka", + "product_code":"dms", + "title":"Do I Need to Create Consumer Groups, Producers, and Consumers for Kafka Instances?", + "uri":"kafka-faq-200426033.html", + "doc_type":"usermanual", + "p_code":"111", + "code":"112" + }, + { + "desc":"No. You can directly delete the consumer group.", + "product_code":"dms", + "title":"Do I Need to Unsubscribe from a Topic Before Deleting a Consumer Group?", + "uri":"kafka-faq-0032.html", + "doc_type":"usermanual", + "p_code":"111", + "code":"113" + }, + { + "desc":"Yes.Kafka uses the offsets.retention.minutes parameter to control how long to keep offsets for a consumer group. If offsets are not committed within this period, they wil", + "product_code":"dms", + "title":"Will a Consumer Group Without Active Consumers Be Automatically Deleted in 14 Days?", + "uri":"kafka-faq-0043.html", + "doc_type":"usermanual", + "p_code":"111", + "code":"114" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Messages", + "uri":"kafka-faq-190416001.html", + "doc_type":"usermanual", + "p_code":"56", + "code":"115" + }, + { + "desc":"10 MB.", + "product_code":"dms", + "title":"What Is the Maximum Size of a Message that Can be Created?", + "uri":"kafka-faq-200426035.html", + "doc_type":"usermanual", + "p_code":"115", + "code":"116" + }, + { + "desc":"Rebalancing is a process where partitions of topics are re-allocated for a consumer group.In normal cases, rebalancing occurs inevitably when a consumer is added to or re", + "product_code":"dms", + "title":"Why Does Message Poll Often Fail During Rebalancing?", + "uri":"kafka-faq-200426036.html", + "doc_type":"usermanual", + "p_code":"115", + "code":"117" + }, + { + "desc":"Possible cause 1: The message has been aged.Solution: Change the aging time.Solution: Change the aging time.Possible cause 2: The createTime timestamp of the message is i", + "product_code":"dms", + "title":"Why Can't I Query Messages on the Console?", + "uri":"kafka-faq-200426037.html", + "doc_type":"usermanual", + "p_code":"115", + "code":"118" + }, + { + "desc":"If the aging time has been set for a topic, the value of the log.retention.hours parameter does not take effect for the topic. The value of the log.retention.hours parame", + "product_code":"dms", + "title":"Why Do Messages Still Exist After the Retention Period Elapses?", + "uri":"kafka-faq-200708001.html", + "doc_type":"usermanual", + "p_code":"115", + "code":"119" + }, + { + "desc":"No.", + "product_code":"dms", + "title":"Do Kafka Instances Support Delayed Message Delivery?", + "uri":"kafka-faq-0018.html", + "doc_type":"usermanual", + "p_code":"115", + "code":"120" + }, + { + "desc":"View the number of accumulated messages using any of the following methods:On the Consumer Groups page of an instance, click the name of the consumer group whose accumula", + "product_code":"dms", + "title":"How Do I View the Number of Accumulated Messages?", + "uri":"kafka-faq-0041.html", + "doc_type":"usermanual", + "p_code":"115", + "code":"121" + }, + { + "desc":"The message creation time is specified by CreateTime when a producer creates messages. If this parameter is not set during message creation, the message creation time is ", + "product_code":"dms", + "title":"Why Is the Message Creation Time Displayed as Year 1970?", + "uri":"kafka-faq-0045.html", + "doc_type":"usermanual", + "p_code":"115", + "code":"122" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Monitoring & Alarm", + "uri":"kafka-faq-191030004.html", + "doc_type":"usermanual", + "p_code":"56", + "code":"123" + }, + { + "desc":"The possible causes are as follows:The topic name starts with a special character, such as an underscore (_) or a number sign (#).The consumer group name starts with a sp", + "product_code":"dms", + "title":"Why Can't I View the Monitoring Data?", + "uri":"kafka-faq-200426041.html", + "doc_type":"usermanual", + "p_code":"123", + "code":"124" + }, + { + "desc":"Symptom: The monitoring data shows that there are 810 million accumulated messages. However, the Kafka console shows that there are 100 million messages in all six topics", + "product_code":"dms", + "title":"Why Is the Monitored Number of Accumulated Messages Inconsistent with the Message Quantity Displayed on the Kafka Console?", + "uri":"kafka-faq-0007.html", + "doc_type":"usermanual", + "p_code":"123", + "code":"125" + }, + { + "desc":"The monitoring data is reported every minute. The reported data will be displayed on the monitoring page after being sorted. This process takes less than 20 minutes. Afte", + "product_code":"dms", + "title":"Why Is a Consumer Group Still on the Monitoring Page After Being Deleted?", + "uri":"kafka-faq-0022.html", + "doc_type":"usermanual", + "p_code":"123", + "code":"126" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dms", + "title":"Change History", + "uri":"kafka-ug-00001.html", + "doc_type":"usermanual", + "p_code":"", + "code":"127" + }, + { + "desc":"See Glossary.", + "product_code":"dms", + "title":"Glossary", + "uri":"dms-ug-0312114.html", + "doc_type":"usermanual", + "p_code":"", + "code":"128" + } +] \ No newline at end of file diff --git a/docs/dms/umn/Kafka-specification.html b/docs/dms/umn/Kafka-specification.html new file mode 100644 index 000000000..2338555bd --- /dev/null +++ b/docs/dms/umn/Kafka-specification.html @@ -0,0 +1,107 @@ + + +

Specifications

+

Kafka Instance Specifications

Kafka instances are compatible with open-source Kafka 1.1.0, 2.3.0, and 2.7. The instance specifications are classified based on bandwidth, namely, 100 MB/s, 300 MB/s, 600 MB/s, and 1200 MB/s.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 TPS and the maximum number of partitions supported by different instance specifications and I/O types

Bandwidth

+

I/O Type

+

TPS (High-Throughput)

+

TPS (Synchronous Replication)

+

Maximum Partitions

+

100 MB/s

+

High I/O

+

100,000

+

60,000

+

300

+

Ultra-high I/O

+

100,000

+

80,000

+

300

+

300 MB/s

+

High I/O

+

300,000

+

150,000

+

900

+

Ultra-high I/O

+

300,000

+

200,000

+

900

+

600 MB/s

+

Ultra-high I/O

+

600,000

+

300,000

+

1800

+

1200 MB/s

+

Ultra-high I/O

+

1,200,000

+

400,000

+

1800

+
+
+

For Kafka instances, the number of transactions per second (TPS) is the maximum number of messages that can be written per second. The preceding TPS is calculated with each message being 1 KB.

+
+
+

Bandwidth Selection

The bandwidth of a Kafka instance refers to the maximum read or write bandwidth. You are advised to select a bandwidth 30% higher than what is required.

+ +
+

Storage Space Selection

Kafka instances support storage with 1 to 3 replicas. The storage space is consumed by all replicas. When creating an instance, specify its storage space based on the expected service message size and the number of replicas.

+

For example, if the estimated message size is 100 GB, the disk capacity must be at least: 100 GB x Number of replicas + 100 GB (reserved space).

+
+

Topic Quantity

There are limits on the topic quantity and the aggregate number of partitions in the topics. When the partition quantity limit is reached, you can no longer create topics.

+

The number of topics is related to the maximum number of partitions allowed and the specified number of partitions in each topic (see Table 1).

+

The maximum number of partitions for a 100 MB/s instance is 300.

+ +
+
+
+ +
+ diff --git a/docs/dms/umn/PARAMETERS.txt b/docs/dms/umn/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/dms/umn/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/dms/umn/TagManagement.html b/docs/dms/umn/TagManagement.html new file mode 100644 index 000000000..47a5b302a --- /dev/null +++ b/docs/dms/umn/TagManagement.html @@ -0,0 +1,44 @@ + + +

Managing Instance Tags

+

Tags facilitate Kafka instance identification and management.

+

You can add tags to a Kafka instance when creating the instance or add tags on the Tags tab page of the created instance. Up to 20 tags can be added to an instance. Tags can be modified and deleted.

+

A tag consists of a tag key and a tag value. Table 1 lists the tag key and value requirements.

+ +
+ + + + + + + + + + +
Table 1 Tag key and value requirements

Parameter

+

Requirements

+

Tag key

+
  • Cannot be left blank.
  • Must be unique for the same instance.
  • Can contain a maximum of 36 characters.
  • Cannot contain the following characters: =*<>\,|/
  • Cannot start or end with a space.
+

Tag value

+
  • Cannot be left blank.
  • Can contain a maximum of 43 characters.
  • Cannot contain the following characters: =*<>\,|/
  • Cannot start or end with a space.
+
+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the name of an instance.
  5. Click the Tags tab.

    View the tags of the instance.

    +

  6. Perform the following operations as required:

    • Add a tag
      1. Click Add/Edit Tag.
      2. Enter a tag key and a tag value, and click Add.

        If you have predefined tags, select a predefined pair of tag key and value, and click Add.

        +
      3. Click OK.
      +
    • Modify a tag
      1. Click Add/Edit Tag.
      2. Click next to the tag to be edited, enter the original tag key and the new tag value, and click Add.
      3. Click OK.
      +
    • Delete a tag

      Delete a tag using either of the following methods:

      +
      • In the row containing the tag to be deleted, click Delete. In the Delete Tag dialog box, click Yes.
      • Click Add/Edit Tag. In the Add/Edit Tag dialog box, click next to the tag to be deleted and click OK.
      +
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/dms-ug-001.html b/docs/dms/umn/dms-ug-001.html new file mode 100644 index 000000000..22ea10e1a --- /dev/null +++ b/docs/dms/umn/dms-ug-001.html @@ -0,0 +1,137 @@ + + +

Best Practices

+

This section provides recommendations on configuring common parameters for Kafka producers and consumers.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Producer parameters

Parameter

+

Default Value

+

Recommended Value

+

Description

+

acks

+

1

+

all or –1 (if high reliability mode is selected)

+

1 (if high throughput mode is selected)

+

Number of acknowledgments the producer requires the server to return before considering a request complete. This controls the durability of records that are sent. Options:

+

0: The producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record, and the retries configuration will not take effect (as the client generally does not know of any failures). The offset given back for each record will always be set to –1.

+

1: The leader will write the record to its local log but will respond without waiting until receiving full acknowledgement from all followers. If the leader fails immediately after acknowledging the record but before the followers have replicated it, the record will be lost.

+

all or –1: The leader will wait for the full set of replicas to acknowledge the record. This is the strongest available guarantee because the record will not be lost even if there is just one replica that works. min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.

+

retries

+

0

+

Set as required.

+

Number of times that the client resends a message. Setting this parameter to a value greater than zero will cause the client to resend any record that failed to be sent.

+

Note that this retry is no different than if the client resends the record upon receiving the error. Allowing retries will potentially change the ordering of records because if two batches are sent to the same partition, and the first fails and is retried but the second succeeds, then the records in the second batch may appear first.

+

You are advised to configure producers so that they can be able to retry in case of network disconnections. Set retries to 3 and the retry interval retry.backoff.ms to 1000.

+

request.timeout.ms

+

30000

+

Set as required.

+

Maximum amount of time (in ms) the client will wait for the response of a request. If the response is not received before the timeout elapses, the client will throw a timeout exception.

+

Setting this parameter to a large value, for example, 127000 (127s), can prevent records from failing to be sent in high-concurrency scenarios.

+

block.on.buffer.full

+

TRUE

+

TRUE

+

Setting this parameter to TRUE indicates that when buffer memory is exhausted, the producer must stop receiving new message records or throw an exception.

+

By default, this parameter is set to TRUE. However, in some cases, non-blocking usage is desired and it is better to throw an exception immediately. Setting this parameter to FALSE will cause the producer to instead throw "BufferExhaustedException" when buffer memory is exhausted.

+

batch.size

+

16384

+

262144

+

Default maximum number of bytes of messages that can be processed at a time. The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This improves performance of both the client and the server. No attempt will be made to batch records larger than this size.

+

Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent.

+

A smaller batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely). A larger batch size may use more memory as a buffer of the specified batch size will always be allocated in anticipation of additional records.

+

buffer.memory

+

33554432

+

67108864

+

Total bytes of memory the producer can use to buffer records waiting to be sent to the server. If data is generated faster than it is sent to the broker, the producer blocks or throw a "block.on.buffer.full" exception.

+

This setting should correspond roughly to the total memory the producer will use, but is not a rigid bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Consumer parameters

Parameter

+

Default Value

+

Recommended Value

+

Description

+

auto.commit.enable

+

TRUE

+

FALSE

+

If this parameter is set to TRUE, the offset of messages already fetched by the consumer will be periodically committed to ZooKeeper. This committed offset will be used when the process fails as the position from which the new consumer will begin.

+

Constraints: If this parameter is set to FALSE, to avoid message loss, an offset must be committed to ZooKeeper after the messages are successfully consumed.

+

auto.offset.reset

+

latest

+

earliest

+

Indicates what to do when there is no initial offset in ZooKeeper or if the current offset has been deleted. Options:

+

earliest: Automatically reset to the smallest offset.

+

latest: Automatically reset to the largest offset.

+

none: The system throws an exception to the consumer if no offset is available.

+

anything else: The system throws an exception to the consumer.

+

connections.max.idle.ms

+

600000

+

30000

+

Timeout interval (in ms) for an idle connection. The server closes the idle connection after this period of time ends. Setting this parameter to 30000 can reduce the server response failures when the network condition is poor.

+
+
+

+
+
+ +
+ diff --git a/docs/dms/umn/dms-ug-0312114.html b/docs/dms/umn/dms-ug-0312114.html new file mode 100644 index 000000000..0fd511c51 --- /dev/null +++ b/docs/dms/umn/dms-ug-0312114.html @@ -0,0 +1,7 @@ + + +

Glossary

+

See Glossary.

+
+
+ diff --git a/docs/dms/umn/dms-ug-180413002.html b/docs/dms/umn/dms-ug-180413002.html new file mode 100644 index 000000000..8617a7d6f --- /dev/null +++ b/docs/dms/umn/dms-ug-180413002.html @@ -0,0 +1,656 @@ + + +

Kafka Metrics

+

Introduction

This section describes DMS metrics reported to Cloud Eye as well as their namespace and dimensions. You can use the Cloud Eye console to query the Kafka metrics and alarms.

+
+

Namespace

SYS.DMS

+
+

Instance Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Instance metrics

Metric ID

+

Metric Name

+

Description

+

Value Range

+

Monitored Object

+

Monitoring Period (Raw Data)

+

current_partitions

+

Partitions

+

Number of used partitions in the instance

+

Unit: count

+

0~1800

+

Kafka instance

+

1 minute

+

current_topics

+

Topics

+

Number of created topics in the instance

+

Unit: count

+

0–600

+

Kafka instance

+

1 minute

+

group_msgs

+

Accumulated Messages

+

Total number of accumulated messages in all consumer groups of the instance

+

Unit: count

+

0–1,000,000,000

+

Kafka instance

+

1 minute

+
+
+
+

Broker Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Broker metrics

Metric ID

+

Metric Name

+

Description

+

Value Range

+

Monitored Object

+

Monitoring Period (Raw Data)

+

broker_data_size

+

Message Size

+

Total size of messages in the broker

+

Unit: byte, KB, MB, GB, TB or PB

+

0–5,000,000,000,000

+

Kafka instance broker

+

1 minute

+

broker_messages_in_rate

+

Message Creation Rate

+

Number of messages created per second

+

Unit: count/s

+

0–500,000

+

Kafka instance broker

+

1 minute

+

broker_bytes_out_rate

+

Message Retrieval

+

Number of bytes retrieved per second

+

Unit: byte/s, KB/s, MB/s, or GB/s

+

0–500,000,000

+

Kafka instance broker

+

1 minute

+

broker_bytes_in_rate

+

Message Creation

+

Number of bytes created per second

+

Unit: byte/s, KB/s, MB/s, or GB/s

+

0–500,000,000

+

Kafka instance broker

+

1 minute

+

broker_public_bytes_in_rate

+

Public Inbound Traffic

+

Inbound traffic over public networks per second

+

Unit: byte/s, KB/s, MB/s, or GB/s

+
NOTE:

You can view this metric on the EIP console if public access has been enabled and EIPs have been assigned to the instance.

+
+

0–500,000,000

+

Kafka instance broker

+

1 minute

+

broker_public_bytes_out_rate

+

Public Outbound Traffic

+

Outbound traffic over public networks per second

+

Unit: byte/s, KB/s, MB/s, or GB/s

+
NOTE:

You can view this metric on the EIP console if public access has been enabled and EIPs have been assigned to the instance.

+
+

0–500,000,000

+

Kafka instance broker

+

1 minute

+

broker_fetch_mean

+

Average Message Retrieval Processing Duration

+

Average time that the broker spends processing message retrieval requests

+

Unit: ms

+

0–10,000

+

Kafka instance broker

+

1 minute

+

broker_produce_mean

+

Average Message Creation Processing Duration

+

Average time that the broker spends processing message creation requests

+

Unit: ms

+

0–10,000

+

Kafka instance broker

+

1 minute

+

broker_cpu_core_load

+

Average Load per CPU Core

+

Average load of each CPU core of the Kafka VM

+

Unit: %

+

0–20

+

Kafka instance broker

+

1 minute

+

broker_disk_usage

+

Disk Capacity Usage

+

Disk usage of the Kafka VM

+

Unit: %

+

0–100

+

Kafka instance broker

+

1 minute

+

broker_memory_usage

+

Memory Usage

+

Memory usage of the Kafka VM

+

Unit: %

+

0–100

+

Kafka instance broker

+

1 minute

+

broker_heap_usage

+

JVM Heap Memory Usage of Kafka

+

Heap memory usage of the Kafka JVM

+

Unit: %

+

0–100

+

Kafka instance broker

+

1 minute

+

broker_alive

+

Broker Alive

+

Whether the Kafka broker is alive

+

1: alive

+

0: not alive

+

Kafka instance broker

+

1 minute

+

broker_connections

+

Connections

+

Total number of TCP connections on the Kafka broker

+

Unit: count

+

> 0

+

Kafka instance broker

+

1 minute

+

broker_cpu_usage

+

CPU Usage

+

CPU usage of the Kafka VM

+

Unit: %

+

0–100

+

Kafka instance broker

+

1 minute

+

broker_disk_read_await

+

Average Disk Read Time

+

Average time for each disk I/O read in the monitoring period

+

Unit: ms

+

> 0

+

Kafka instance broker

+

1 minute

+

broker_disk_write_await

+

Average Disk Write Time

+

Average time for each disk I/O write in the monitoring period

+

Unit: ms

+

> 0

+

Kafka instance broker

+

1 minute

+

broker_total_bytes_in_rate

+

Inbound Traffic

+

Inbound traffic per second

+

Unit: byte/s

+

> 0

+

Kafka instance broker

+

1 minute

+

broker_total_bytes_out_rate

+

Outbound Traffic

+

Outbound traffic per second

+

Unit: byte/s

+

> 0

+

Kafka instance broker

+

1 minute

+
+
+
+

Topic Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Topic metrics

Metric ID

+

Metric Name

+

Description

+

Value Range

+

Monitored Object

+

Monitoring Period (Raw Data)

+

topic_bytes_in_rate

+

Message Creation

+

Number of bytes created per second

+

Unit: byte/s, KB/s, MB/s, or GB/s

+
NOTE:

This metric is available only when Scope is set to Basic monitoring on the Queues tab page.

+
+

0–500,000,000

+

Topic in a Kafka instance

+

1 minute

+

topic_bytes_out_rate

+

Message Retrieval

+

Number of bytes retrieved per second

+

Unit: byte/s, KB/s, MB/s, or GB/s

+
NOTE:

This metric is available only when Scope is set to Basic monitoring on the Queues tab page.

+
+

0–500,000,000

+

Topic in a Kafka instance

+

1 minute

+

topic_data_size

+

Message Size

+

Total size of messages in the queue

+

Unit: byte, KB, MB, GB, TB or PB

+
NOTE:

This metric is available only when Scope is set to Basic monitoring on the Queues tab page.

+
+

0–5,000,000,000,000

+

Topic in a Kafka instance

+

1 minute

+

topic_messages

+

Total Messages

+

Total number of messages in the queue

+

Unit: count

+
NOTE:

This metric is available only when Scope is set to Basic monitoring on the Queues tab page.

+
+

≥ 0

+

Topic in a Kafka instance

+

1 minute

+

topic_messages_in_rate

+

Message Creation Rate

+

Number of messages created per second

+

Unit: count/s

+
NOTE:

This metric is available only when Scope is set to Basic monitoring on the Queues tab page.

+
+

0–500,000

+

Topic in a Kafka instance

+

1 minute

+

partition_messages

+

Partition Messages

+

Total number of messages in the partition

+

Unit: count

+
NOTE:

This metric is available only when Scope is set to Partition monitoring on the Queues tab page.

+
+

≥ 0

+

Topic in a Kafka instance

+

1 minute

+

produced_messages

+

Created Messages

+

Number of messages that have been created

+

Unit: count

+
NOTE:

This metric is available only when Scope is set to Partition monitoring on the Queues tab page.

+
+

≥ 0

+

Topic in a Kafka instance

+

1 minute

+
+
+
+

Consumer Group Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Consumer group metrics

Metric ID

+

Metric Name

+

Description

+

Value Range

+

Monitored Object

+

Monitoring Period (Raw Data)

+

messages_consumed

+

Retrieved Messages

+

Number of messages that have been retrieved in the consumer group

+

Unit: count

+
NOTE:

This metric is available only when Queue is set to a specified topic name and Monitoring Type is set to Partition monitoring on the By Consumer Group tab page.

+
+

≥ 0

+

Consumer group of a Kafka instance

+

1 minute

+

messages_remained

+

Available Messages

+

Number of messages that can be retrieved in the consumer group

+

Unit: count

+
NOTE:

This metric is available only when Queue is set to a specified topic name and Monitoring Type is set to Partition monitoring on the By Consumer Group tab page.

+
+

≥ 0

+

Consumer group of a Kafka instance

+

1 minute

+

topic_messages_remained

+

Topic Available Messages

+

Number of remaining messages that can be retrieved from the specified topic in the consumer group

+

Unit: Count

+
NOTE:

This metric is available only when Queue is set to a specified topic name and Monitoring Type is set to Basic monitoring on the By Consumer Group tab page.

+
+

0 to 263–1

+

Consumer group of a Kafka instance

+

1 minute

+

topic_messages_consumed

+

Topic Retrieved Messages

+

Number of messages that have been retrieved from the specified topic in the consumer group

+

Unit: Count

+
NOTE:

This metric is available only when Queue is set to a specified topic name and Monitoring Type is set to Basic monitoring on the By Consumer Group tab page.

+
+

0 to 263–1

+

Consumer group of a Kafka instance

+

1 minute

+

consumer_messages_remained

+

Consumer Available Messages

+

Number of remaining messages that can be retrieved in the consumer group

+

Unit: Count

+
NOTE:

This metric is available only when Queue is set to All queues on the By Consumer Group tab page.

+
+

0 to 263–1

+

Consumer group of a Kafka instance

+

1 minute

+

consumer_messages_consumed

+

Consumer Retrieved Messages

+

Number of messages that have been retrieved in the consumer group

+

Unit: Count

+
NOTE:

This metric is available only when Queue is set to All queues on the By Consumer Group tab page.

+
+

0 to 263–1

+

Consumer group of a Kafka instance

+

1 minute

+
+
+
+

Dimension

+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Key

+

Value

+

kafka_instance_id

+

Kafka instance

+

kafka_broker

+

Kafka instance broker

+

kafka_topics

+

Topic in a Kafka instance

+

kafka_partitions

+

Partition in a Kafka instance

+

kafka_groups-partitions

+

Partition consumer group in a Kafka instance

+

kafka_groups_topics

+

Topic consumer group in a Kafka instance

+

kafka_groups

+

Consumer group of a Kafka instance

+
+
+
+
+
+ +
+ diff --git a/docs/dms/umn/dms-ug-180604013.html b/docs/dms/umn/dms-ug-180604013.html new file mode 100644 index 000000000..9a572d7b9 --- /dev/null +++ b/docs/dms/umn/dms-ug-180604013.html @@ -0,0 +1,45 @@ + + +

Creating an Instance

+

Scenario

Kafka instances are physically isolated and exclusively occupied by each tenant. You can customize the computing capabilities and storage space of an instance based on service requirements.

+
+

Before You Start

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the same region as your application service.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click Create Instance in the upper right corner of the page.

    By default, you can create a maximum of 100 Kafka instances for each project. To create more instances, contact customer service to increase your quota.

    +

  5. Specify Region, Project, and AZ.
  6. Enter an instance name.
  7. Configure the following instance parameters:

    1. Version: Kafka v1.1.0, v2.3.0, and v2.7 are supported. v2.7 is recommended. The version cannot be changed once the instance is created.
    2. CPU Architecture: The x86 architecture is supported.
    3. Flavor: Select a bandwidth based on the estimated service traffic.

      You can view the broker quantity and flavor, the maximum number of partitions allowed, and number of consumer groups recommended for each bandwidth option.

      +

      The Maximum Partitions parameter indicates the maximum number of partitions that can be created for a Kafka instance. If the total number of partitions of all topics exceeds this threshold, topic creation will fail.

      +
    4. Storage Space: Disk type and total disk space for storing the instance data. The disk type cannot be changed once the instance is created.

      The storage space is the total space to be consumed by all replicas. Specify the storage space based on the expected service message size and the number of replicas. For example, if the required disk size to store the data for the retention period is 100 GB, the disk capacity must be at least: 100 GB x Number of replicas + 100 GB (reserved space).

      +

      Disks are formatted when an instance is created. As a result, the actual available disk space is 93% to 95% of the total disk space.

      +
      • 100 MB/s bandwidth: The value range of Storage Space is 600–90,000 GB.
      • 300 MB/s bandwidth: The value range of Storage Space is 1200–90,000 GB.
      • 600 MB/s bandwidth: The value range of Storage Space is 2400–90,000 GB.
      • 1200 MB/s bandwidth: The value range of Storage Space is 4800–90,000 GB.
      +
      • High I/O + 100 MB/s bandwidth: If the average message size is 1 KB, the transactions per second (TPS) can reach 100,000 in high throughput scenarios and 60,000 in synchronous replication scenarios.
      • High I/O + 300 MB/s bandwidth: If the average message size is 1 KB, the TPS can reach 300,000 in high throughput scenarios and 150,000 in synchronous replication scenarios.
      • Ultra-high I/O + 100 MB/s bandwidth: If the average message size is 1 KB, the TPS can reach 100,000 in high throughput scenarios and 80,000 in synchronous replication scenarios.
      • Ultra-high I/O + 300 MB/s bandwidth: If the average message size is 1 KB, the TPS can reach 300,000 in high throughput scenarios and 200,000 in synchronous replication scenarios.
      • Ultra-high I/O + 600 MB/s bandwidth: If the average message size is 1 KB, the TPS can reach 600,000 in high throughput scenarios and 300,000 in synchronous replication scenarios.
      • Ultra-high I/O + 1200 MB/s bandwidth: If the average message size is 1 KB, the TPS can reach 1,200,000 in high throughput scenarios and 400,000 in synchronous replication scenarios.
      +
      +
    5. Disk Encryption: Specify whether to enable disk encryption. Enabling disk encryption improves data security. Disk encryption depends on Key Management Service (KMS). If you enable disk encryption, select a KMS key. This parameter cannot be modified once the instance is created.
    6. Capacity Threshold Policy: policy used when the disk usage reaches the threshold. The capacity threshold is 95%.
      • Automatically delete: Messages can be created and retrieved, but 10% of the earliest messages will be deleted to ensure sufficient disk space. This policy is suitable for scenarios where no service interruption can be tolerated. Data may be lost.
      • Stop production: New messages cannot be created, but existing messages can still be retrieved. This policy is suitable for scenarios where no data loss can be tolerated.
      +
    +

  8. Configure the instance network parameters.

    • Select a VPC and a subnet.

      A VPC provides an isolated virtual network for your Kafka instances. You can configure and manage the network as required.

      +

      After the Kafka instance is created, its VPC and subnet cannot be changed.

      +
      +
    • Select a security group.

      A security group is a set of rules for accessing a Kafka instance. You can click Manage Security Group to view or create security groups on the network console.

      +
    +

  9. Click Advanced Settings to configure more parameters.

    1. Configure public access.

      Public access is disabled by default. You can enable or disable it as required.

      +

      After public access is enabled, configure an IPv4 EIP for each broker.

      +
    2. Configure Kafka SASL_SSL.

      This parameter indicates whether to enable SSL authentication when a client connects to the instance. If you enable Kafka SASL_SSL, data will be encrypted before transmission to enhance security.

      +

      Kafka SASL_SSL is disabled by default. You can enable or disable it as required. This setting cannot be changed after the instance is created. If you want to use a different setting, you must create a new instance.

      +

      If you enable Kafka SASL_SSL, you must also set the username and password for accessing the instance.

      +
    3. Configure Automatic Topic Creation.

      This setting is disabled by default. You can enable or disable it as required.

      +

      If automatic topic creation is enabled, the system automatically creates a topic when a message is created in or retrieved from a topic that does not exist. This topic has the following default settings: 3 partitions, 3 replicas, aging time 72 hours, and synchronous replication and flushing disabled.

      +

      After you change the value of the log.retention.hours, default.replication.factor, or num.partitions parameter, automatically created topics later use the new value. For example, if num.partitions is set to 5, an automatically created topic will have the following settings: 5 partitions, 3 replicas, aging time 72 hours, and synchronous replication and flushing disabled.

      +
    4. Specify Tags.

      Tags are used to identify cloud resources. When you have many cloud resources of the same type, you can use tags to classify them by dimension (for example, use, owner, or environment).

      +
      • If you have predefined tags, select a predefined pair of tag key and value. Click View predefined tags. On the Tag Management Service (TMS) console, view predefined tags or create tags.
      • You can also create new tags by specifying Tag key and Tag value.
      +

      Up to 20 tags can be added to each Kafka instance. For details about the requirements on tags, see Managing Instance Tags.

      +
    5. Enter a description of the instance.
    +

  10. Click Create.
  11. Confirm the instance information, and click Submit.
  12. Return to the instance list and check whether the Kafka 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.
    • If the instance fails to be created, view Instance Creation Failures. Delete the instance by referring to Deleting an Instance and create another instance. If the instance creation fails again, contact customer service.

      Instances that fail to be created do not occupy other resources.

      +
      +
    +

+
+
+
+ diff --git a/docs/dms/umn/dms-ug-180604018.html b/docs/dms/umn/dms-ug-180604018.html new file mode 100644 index 000000000..2d8d79321 --- /dev/null +++ b/docs/dms/umn/dms-ug-180604018.html @@ -0,0 +1,85 @@ + + +

Creating a Topic

+

A topic is a stream of messages. If automatic topic creation is not enabled during Kafka instance creation, you need to manually create topics for creating and retrieving messages. If automatic topic creation has been enabled for the instance, this operation is optional.

+

If automatic topic creation is enabled, the system automatically creates a topic when a message is created in or retrieved from a topic that does not exist. This topic has the following default settings: 3 partitions, 3 replicas, aging time 72 hours, and synchronous replication and flushing disabled. After you change the value of the log.retention.hours, default.replication.factor, or num.partitions parameter, automatically created topics later use the new value. For example, if num.partitions is set to 5, an automatically created topic will have the following settings: 5 partitions, 3 replicas, aging time 72 hours, and synchronous replication and flushing disabled.

+

There is a limit on the total number of partitions in topics. When the partition quantity limit is reached, you can no longer create topics. The total number of partitions varies with instance specifications. For details, see Specifications.

+

Methods that can be used to manually create a topic:

+ +

If an instance node is faulty, an internal service error may be reported when you query messages in a topic with only one replica. Therefore, you are not advised to use a topic with only one replica.

+
+

Method 1: Creating a Topic on the Console

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Click the Topics tab, and click Create Topic.

    The Create Topic dialog box is displayed.

    +

  6. Specify the topic parameters listed in the following table.

    +

    + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Topic parameters

    Parameter

    +

    Description

    +

    Topic Name

    +

    When creating a topic, you can modify the automatically generated topic name.

    +

    Once the topic is created, you cannot modify its name.

    +

    Partitions

    +

    A larger number of partitions for a topic indicates more messages retrieved concurrently.

    +

    If this parameter is set to 1, messages will be retrieved in the FIFO order.

    +

    Value range: 1 to 100

    +

    Default value: 3

    +

    Replicas

    +

    A higher number of replicas delivers higher reliability. Data is automatically backed up on each replica. When one Kafka broker becomes faulty, data is still available on other brokers.

    +

    If this parameter is set to 1, only one set of data is available.

    +

    Value range: 1 to 3

    +

    Default value: 3

    +
    NOTE:

    If an instance node is faulty, an internal service error may be reported when you query messages in a topic with only one replica. Therefore, you are not advised to use a topic with only one replica.

    +
    +

    Aging Time (h)

    +

    The period that messages are retained for. Consumers must retrieve messages before this period ends. Otherwise, the messages will be deleted and can no longer be retrieved.

    +

    Value range: 1 to 720

    +

    Default value: 72

    +

    Synchronous Replication

    +

    A message is returned to the client only after the message creation request has been received and the message has been acknowledged by all replicas.

    +

    After enabling synchronous replication, set acks to all or –1 on the client. Otherwise, this function will not take effect.

    +

    If there is only one replica, synchronous replication cannot be enabled.

    +

    Synchronous Flushing

    +

    An indicator of whether a message is immediately flushed to disk once created.

    +
    • Enabled: A message is immediately flushed to disk once it is created, resulting in higher reliability.
    • Disabled: A message is stored in the memory instead of being immediately flushed to disk once created.
    +
    +
    +

  7. Click OK.
+
+

Method 2: Create a Topic by Using Kafka CLI

If your client is v2.2 or later, you can use kafka-topics.sh to create topics and manage topic parameters.

+

If a topic name starts with a special character, for example, an underscore (_) or a number sign (#), monitoring data cannot be displayed.

+
+ +
+
+
+ +
+ diff --git a/docs/dms/umn/dms-ug-190128001.html b/docs/dms/umn/dms-ug-190128001.html new file mode 100644 index 000000000..088289601 --- /dev/null +++ b/docs/dms/umn/dms-ug-190128001.html @@ -0,0 +1,13 @@ + + +

Permissions

+

By default, there are two types of user permissions: user management and resource management.

+ +

For further details, see Permissions.

+
+
+ +
+ diff --git a/docs/dms/umn/en-us_image_0000001098967408.png b/docs/dms/umn/en-us_image_0000001098967408.png new file mode 100644 index 000000000..902c17bdb Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001098967408.png differ diff --git a/docs/dms/umn/en-us_image_0000001160594580.png b/docs/dms/umn/en-us_image_0000001160594580.png new file mode 100644 index 000000000..e0c8c3e5a Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001160594580.png differ diff --git a/docs/dms/umn/en-us_image_0000001191767177.png b/docs/dms/umn/en-us_image_0000001191767177.png new file mode 100644 index 000000000..c8df48a5a Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001191767177.png differ diff --git a/docs/dms/umn/en-us_image_0000001194643828.png b/docs/dms/umn/en-us_image_0000001194643828.png new file mode 100644 index 000000000..adf55a9b8 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001194643828.png differ diff --git a/docs/dms/umn/en-us_image_0000001206335999.png b/docs/dms/umn/en-us_image_0000001206335999.png new file mode 100644 index 000000000..98259cb05 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001206335999.png differ diff --git a/docs/dms/umn/en-us_image_0000001244372389.png b/docs/dms/umn/en-us_image_0000001244372389.png new file mode 100644 index 000000000..42aba96a9 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001244372389.png differ diff --git a/docs/dms/umn/en-us_image_0000001283221910.png b/docs/dms/umn/en-us_image_0000001283221910.png new file mode 100644 index 000000000..47a039305 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001283221910.png differ diff --git a/docs/dms/umn/en-us_image_0000001328313684.png b/docs/dms/umn/en-us_image_0000001328313684.png new file mode 100644 index 000000000..973d6c4ee Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001328313684.png differ diff --git a/docs/dms/umn/en-us_image_0000001328633848.png b/docs/dms/umn/en-us_image_0000001328633848.png new file mode 100644 index 000000000..b342e0335 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001328633848.png differ diff --git a/docs/dms/umn/en-us_image_0000001328644244.png b/docs/dms/umn/en-us_image_0000001328644244.png new file mode 100644 index 000000000..be9039f2a Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001328644244.png differ diff --git a/docs/dms/umn/en-us_image_0000001328948884.png b/docs/dms/umn/en-us_image_0000001328948884.png new file mode 100644 index 000000000..e09c361b3 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001328948884.png differ diff --git a/docs/dms/umn/en-us_image_0000001328950348.png b/docs/dms/umn/en-us_image_0000001328950348.png new file mode 100644 index 000000000..ae5b4e2d4 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001328950348.png differ diff --git a/docs/dms/umn/en-us_image_0000001328954164.png b/docs/dms/umn/en-us_image_0000001328954164.png new file mode 100644 index 000000000..31ad571ee Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001328954164.png differ diff --git a/docs/dms/umn/en-us_image_0000001329138322.png b/docs/dms/umn/en-us_image_0000001329138322.png new file mode 100644 index 000000000..808bbbc86 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001329138322.png differ diff --git a/docs/dms/umn/en-us_image_0000001329185932.png b/docs/dms/umn/en-us_image_0000001329185932.png new file mode 100644 index 000000000..c849f2834 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001329185932.png differ diff --git a/docs/dms/umn/en-us_image_0000001329793006.png b/docs/dms/umn/en-us_image_0000001329793006.png new file mode 100644 index 000000000..d025e16dc Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001329793006.png differ diff --git a/docs/dms/umn/en-us_image_0000001329906052.png b/docs/dms/umn/en-us_image_0000001329906052.png new file mode 100644 index 000000000..7a79d223c Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001329906052.png differ diff --git a/docs/dms/umn/en-us_image_0000001330112650.png b/docs/dms/umn/en-us_image_0000001330112650.png new file mode 100644 index 000000000..38189a0e7 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001330112650.png differ diff --git a/docs/dms/umn/en-us_image_0000001376864660.png b/docs/dms/umn/en-us_image_0000001376864660.png new file mode 100644 index 000000000..00da76e68 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001376864660.png differ diff --git a/docs/dms/umn/en-us_image_0000001377028284.png b/docs/dms/umn/en-us_image_0000001377028284.png new file mode 100644 index 000000000..9d14187d6 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001377028284.png differ diff --git a/docs/dms/umn/en-us_image_0000001378919582.png b/docs/dms/umn/en-us_image_0000001378919582.png new file mode 100644 index 000000000..0f21e6345 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001378919582.png differ diff --git a/docs/dms/umn/en-us_image_0000001379301802.png b/docs/dms/umn/en-us_image_0000001379301802.png new file mode 100644 index 000000000..1909444d2 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001379301802.png differ diff --git a/docs/dms/umn/en-us_image_0000001379445357.png b/docs/dms/umn/en-us_image_0000001379445357.png new file mode 100644 index 000000000..49a7f6e72 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001379445357.png differ diff --git a/docs/dms/umn/en-us_image_0000001380118889.png b/docs/dms/umn/en-us_image_0000001380118889.png new file mode 100644 index 000000000..ca1addbff Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001380118889.png differ diff --git a/docs/dms/umn/en-us_image_0000001380194201.png b/docs/dms/umn/en-us_image_0000001380194201.png new file mode 100644 index 000000000..8b261a1ee Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001380194201.png differ diff --git a/docs/dms/umn/en-us_image_0000001380403152.png b/docs/dms/umn/en-us_image_0000001380403152.png new file mode 100644 index 000000000..7c490b30c Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001380403152.png differ diff --git a/docs/dms/umn/en-us_image_0000001380945917.png b/docs/dms/umn/en-us_image_0000001380945917.png new file mode 100644 index 000000000..caf8732b0 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001380945917.png differ diff --git a/docs/dms/umn/en-us_image_0000001381108612.png b/docs/dms/umn/en-us_image_0000001381108612.png new file mode 100644 index 000000000..adf55a9b8 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001381108612.png differ diff --git a/docs/dms/umn/en-us_image_0000001382159745.png b/docs/dms/umn/en-us_image_0000001382159745.png new file mode 100644 index 000000000..261b7c810 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001382159745.png differ diff --git a/docs/dms/umn/en-us_image_0000001384665714.png b/docs/dms/umn/en-us_image_0000001384665714.png new file mode 100644 index 000000000..bb6029bd8 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001384665714.png differ diff --git a/docs/dms/umn/en-us_image_0000001427521685.png b/docs/dms/umn/en-us_image_0000001427521685.png new file mode 100644 index 000000000..2ad6a4604 Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001427521685.png differ diff --git a/docs/dms/umn/en-us_image_0000001427644729.png b/docs/dms/umn/en-us_image_0000001427644729.png new file mode 100644 index 000000000..25d9bb2ab Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001427644729.png differ diff --git a/docs/dms/umn/en-us_image_0000001435265813.png b/docs/dms/umn/en-us_image_0000001435265813.png new file mode 100644 index 000000000..81ce0db3f Binary files /dev/null and b/docs/dms/umn/en-us_image_0000001435265813.png differ diff --git a/docs/dms/umn/en-us_image_0143920315.png b/docs/dms/umn/en-us_image_0143920315.png new file mode 100644 index 000000000..09db68b57 Binary files /dev/null and b/docs/dms/umn/en-us_image_0143920315.png differ diff --git a/docs/dms/umn/en-us_image_0143929918.png b/docs/dms/umn/en-us_image_0143929918.png new file mode 100644 index 000000000..1909444d2 Binary files /dev/null and b/docs/dms/umn/en-us_image_0143929918.png differ diff --git a/docs/dms/umn/en-us_image_0169395994.png b/docs/dms/umn/en-us_image_0169395994.png new file mode 100644 index 000000000..cc0fb041b Binary files /dev/null and b/docs/dms/umn/en-us_image_0169395994.png differ diff --git a/docs/dms/umn/en-us_image_0169396006.png b/docs/dms/umn/en-us_image_0169396006.png new file mode 100644 index 000000000..54c26a8af Binary files /dev/null and b/docs/dms/umn/en-us_image_0169396006.png differ diff --git a/docs/dms/umn/en-us_image_0169396010.png b/docs/dms/umn/en-us_image_0169396010.png new file mode 100644 index 000000000..37ab98e5b Binary files /dev/null and b/docs/dms/umn/en-us_image_0169396010.png differ diff --git a/docs/dms/umn/en-us_image_0169396012.png b/docs/dms/umn/en-us_image_0169396012.png new file mode 100644 index 000000000..82987fe50 Binary files /dev/null and b/docs/dms/umn/en-us_image_0169396012.png differ diff --git a/docs/dms/umn/en-us_image_0169396015.png b/docs/dms/umn/en-us_image_0169396015.png new file mode 100644 index 000000000..03655d425 Binary files /dev/null and b/docs/dms/umn/en-us_image_0169396015.png differ diff --git a/docs/dms/umn/en-us_image_0252462263.png b/docs/dms/umn/en-us_image_0252462263.png new file mode 100644 index 000000000..e3b0eba7e Binary files /dev/null and b/docs/dms/umn/en-us_image_0252462263.png differ diff --git a/docs/dms/umn/en-us_image_0252462634.png b/docs/dms/umn/en-us_image_0252462634.png new file mode 100644 index 000000000..59c81dd64 Binary files /dev/null and b/docs/dms/umn/en-us_image_0252462634.png differ diff --git a/docs/dms/umn/en-us_image_0252462689.png b/docs/dms/umn/en-us_image_0252462689.png new file mode 100644 index 000000000..9bd33ca93 Binary files /dev/null and b/docs/dms/umn/en-us_image_0252462689.png differ diff --git a/docs/dms/umn/en-us_image_0252483830.png b/docs/dms/umn/en-us_image_0252483830.png new file mode 100644 index 000000000..1bf209e99 Binary files /dev/null and b/docs/dms/umn/en-us_image_0252483830.png differ diff --git a/docs/dms/umn/en-us_image_0272312053.png b/docs/dms/umn/en-us_image_0272312053.png new file mode 100644 index 000000000..9c6871e3d Binary files /dev/null and b/docs/dms/umn/en-us_image_0272312053.png differ diff --git a/docs/dms/umn/en-us_image_0281104603.png b/docs/dms/umn/en-us_image_0281104603.png new file mode 100644 index 000000000..4b899703c Binary files /dev/null and b/docs/dms/umn/en-us_image_0281104603.png differ diff --git a/docs/dms/umn/glossary-kafka.html b/docs/dms/umn/glossary-kafka.html new file mode 100644 index 000000000..0c468476c --- /dev/null +++ b/docs/dms/umn/glossary-kafka.html @@ -0,0 +1,30 @@ + + +

Basic Concepts

+

DMS for Kafka of the cloud service platform uses Kafka as the message engine. This chapter presents explanations of basic concepts of Kafka.

+

Topic

A topic is a category for messages. Messages are created, retrieved, and managed in the form of topics.

+

Topics adopt the publish-subscribe pattern. Producers publish messages into topics. One or more consumers subscribe to the messages in the topics. The producers and consumers are not directly linked to each other.

+
+

Producer

A producer publishes messages into topics. The messages are then delivered to other systems or modules for processing as agreed.

+
+

Consumer

A consumer subscribes to messages in topics and processes the messages. For example, a monitoring and alarm platform (a consumer) subscribing to log messages in certain topics can identify alarm logs and then send SMS or email alarm notifications.

+
+

Broker

A broker is a Kafka process in a Kafka cluster. Each process runs on a server, so a broker includes the storage, bandwidth, and other server resources.

+
+

Partition

A topic is divided into partitions. Messages are distributed to multiple partitions to achieve scalability and fault tolerance.

+
+

Replica

A replica is a redundant copy of a partition in a topic. Each partition can have one or more replicas, enabling message reliability.

+

Messages in each partition are fully replicated and synchronized, preventing data loss if one replica fails.

+

Each partition has one replica as the leader which handles the creation and retrievals of all messages. The rest replicas are followers which replicate the leader.

+
+

Topics and partitions are logical concepts, while replicas and brokers are physical concepts. The following diagram shows the relationships between partitions, brokers, and topics in messages streaming.

+
Figure 1 Kafka message streaming
+

Aging Time

The period that messages are retained for. Consumers must retrieve messages before this period ends. Otherwise, the messages will be deleted and can no longer be retrieved.

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-advantage.html b/docs/dms/umn/kafka-advantage.html new file mode 100644 index 000000000..b36d62dec --- /dev/null +++ b/docs/dms/umn/kafka-advantage.html @@ -0,0 +1,24 @@ + + +

Product Advantages

+

DMS provides easy-to-use message queuing based on Apache Kafka. Services can be quickly migrated to the cloud without any change, reducing maintenance and usage costs.

+ +
+
+ +
+ diff --git a/docs/dms/umn/kafka-connect-other.html b/docs/dms/umn/kafka-connect-other.html new file mode 100644 index 000000000..1d5e4e530 --- /dev/null +++ b/docs/dms/umn/kafka-connect-other.html @@ -0,0 +1,11 @@ + + +

Obtaining Kafka Clients

+

Kafka instances are fully compatible with open-source clients. You can obtain clients in other programming languages and access your instance as instructed by the official Kafka website.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-dnat.html b/docs/dms/umn/kafka-dnat.html new file mode 100644 index 000000000..5d645132a --- /dev/null +++ b/docs/dms/umn/kafka-dnat.html @@ -0,0 +1,36 @@ + + +

Using DNAT to Access a Kafka Instance

+

Scenario

You can use destination NAT (DNAT) to access a Kafka instance so that the instance can provide services on the public network through port mapping.

+
+

Prerequisites

You have created EIPs. The number of EIPs is the same as the number of brokers in the Kafka instance.

+
+

Step 1: Obtain Information About the Kafka Instance

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. In the Connection area on the Basic Information tab page, view and record the private network access addresses of the Kafka instance. In the Network area, view and record the VPC and subnet where the Kafka instance is located.
+
+

Step 2: Create a Public NAT Gateway

  1. Click Service List and choose Network > NAT Gateway.
  2. Click Create Public NAT Gateway.
  3. Set the following parameters:

    • Region: Select the region that the Kafka instance is in.
    • Name: Enter a name for the public NAT gateway.
    • VPC: Select the VPC recorded in 5.
    • Subnet: Select the subnet recorded in 5.
    +

    Set other parameters as required. For details, see Creating a NAT Gateway.

    +

  4. Click Create Now.
  5. Confirm the specifications and click Submit.
+
+

Step 3: Add a DNAT Rule

  1. On Public NAT Gateways page, locate the row that contains the newly created public NAT gateway and click Add Rule in the Operation column.
  2. On the DNAT Rules tab page, click Add DNAT Rule.
  3. Set the following parameters:

    • Scenario: Select VPC.
    • Port Type: Select Specific port.
    • Protocol: Select TCP.
    • EIP: Select an EIP.
    • Outside Port: Enter 9011.
    • Private IP Address: Enter one of the private network addresses of the Kafka instance recorded in 5.
    • Inside Port: Enter 9011.
    +

    For details about more parameters, see Adding a DNAT Rule.

    +
    Figure 1 Adding a DNAT rule
    +

  4. Click OK.

    View the DNAT rule status in the DNAT rule list. If Status is Running, the rule has been added successfully.

    +

  5. Repeat 2 to 4 to create DNAT rules for other private network addresses of the Kafka instance recorded in 5. Each private network address corresponds to a separate EIP.
  6. After all DNAT rules are created, click the DNAT Rules tab to view the created DNAT rules and record the EIPs corresponding to the private IP addresses.
+
+

Step 4: Bind EIPs on the Kafka Console

  1. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  2. Click the desired Kafka instance to view the instance details.
  3. In the Advanced Settings section on the Basic Information tab page, click Modify next to Cross-VPC Access.
  4. Change the values of advertised.listeners IP Address/Domain Name to the EIPs in the DNAT rules. Ensure that the mapping between the private network addresses and the EIPs is consistent with that recorded in 6. Then click Save.

    Figure 2 Changing the advertised.listeners IP addresses
    +

+
+

Step 5: Verify Connectivity

Check whether messages can be created and retrieved by referring to Accessing a Kafka Instance Without SASL or Accessing a Kafka Instance with SASL.

+

Notes:

+ +
+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0001.html b/docs/dms/umn/kafka-faq-0001.html new file mode 100644 index 000000000..786df671a --- /dev/null +++ b/docs/dms/umn/kafka-faq-0001.html @@ -0,0 +1,13 @@ + + +

How Do I Obtain the Public Access Address After Public Access Is Enabled?

+

Click the name of your Kafka instance. In the Connection section on the Basic Information tab page, view Instance Address (Public Network).

+

For details about how to connect to a Kafka instance, see Accessing a Kafka Instance.

+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0003.html b/docs/dms/umn/kafka-faq-0003.html new file mode 100644 index 000000000..8d4e40bcb --- /dev/null +++ b/docs/dms/umn/kafka-faq-0003.html @@ -0,0 +1,12 @@ + + +

What Should I Do If Kafka Storage Space Is Used Up Because Retrieved Messages Are Not Deleted?

+

Messages are not deleted immediately after being retrieved. They are deleted only when the aging time expires.

+

You can shorten the aging time.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0007.html b/docs/dms/umn/kafka-faq-0007.html new file mode 100644 index 000000000..e7779ce89 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0007.html @@ -0,0 +1,12 @@ + + +

Why Is the Monitored Number of Accumulated Messages Inconsistent with the Message Quantity Displayed on the Kafka Console?

+

Symptom: The monitoring data shows that there are 810 million accumulated messages. However, the Kafka console shows that there are 100 million messages in all six topics of the instance.

+

Analysis: The two statistics methods are different. The Kafka console shows the number of messages that have not been retrieved. The monitoring data shows the number of accumulated messages in the topics multiplied by the number of consumer groups.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0010.html b/docs/dms/umn/kafka-faq-0010.html new file mode 100644 index 000000000..64e1a6e1a --- /dev/null +++ b/docs/dms/umn/kafka-faq-0010.html @@ -0,0 +1,11 @@ + + +

Will a Kafka Instance Be Restarted After Its Automatic Topic Creation Setting Is Modified?

+

Yes. A Kafka instance will be restarted if you enable or disable automatic topic creation for it.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0014.html b/docs/dms/umn/kafka-faq-0014.html new file mode 100644 index 000000000..7164695a4 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0014.html @@ -0,0 +1,12 @@ + + +

How Do I Disable Automatic Topic Creation?

+
  1. On the Kafka console, click the name of your instance.
  2. In the Instance Information section of the Basic Information tab page, click next to Automatic Topic Creation to disable automatic topic creation.

    You can view the execution status of the task on the Background Tasks tab page.

    +
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0015.html b/docs/dms/umn/kafka-faq-0015.html new file mode 100644 index 000000000..9edbacd03 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0015.html @@ -0,0 +1,11 @@ + + +

Are Kafka Brokers and ZooKeeper Deployed on the Same VM or on Different VMs?

+

Kafka brokers and ZooKeeper are deployed on the same VM.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0018.html b/docs/dms/umn/kafka-faq-0018.html new file mode 100644 index 000000000..f2034dea6 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0018.html @@ -0,0 +1,11 @@ + + +

Do Kafka Instances Support Delayed Message Delivery?

+

No.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0020.html b/docs/dms/umn/kafka-faq-0020.html new file mode 100644 index 000000000..cdabe23d4 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0020.html @@ -0,0 +1,11 @@ + + +

Which Cipher Suites Are Supported by Kafka?

+

For security purposes, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 is supported.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0022.html b/docs/dms/umn/kafka-faq-0022.html new file mode 100644 index 000000000..933483066 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0022.html @@ -0,0 +1,11 @@ + + +

Why Is a Consumer Group Still on the Monitoring Page After Being Deleted?

+

The monitoring data is reported every minute. The reported data will be displayed on the monitoring page after being sorted. This process takes less than 20 minutes. After deleting a consumer group, you can wait for a while before checking the latest monitoring data.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0023.html b/docs/dms/umn/kafka-faq-0023.html new file mode 100644 index 000000000..5aae68f3d --- /dev/null +++ b/docs/dms/umn/kafka-faq-0023.html @@ -0,0 +1,11 @@ + + +

Can I Change an Instance from Single-AZ Deployment to Multi-AZ Deployment?

+

No. The AZ configuration cannot be changed once the instance is created. To use multiple AZs, create another instance.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0025.html b/docs/dms/umn/kafka-faq-0025.html new file mode 100644 index 000000000..10fa0a54f --- /dev/null +++ b/docs/dms/umn/kafka-faq-0025.html @@ -0,0 +1,12 @@ + + +

Does DMS for Kafka Support Cross-AZ Disaster Recovery? Where Can I View the AZs Configured for an Existing Instance?

+

DMS for Kafka supports cross-AZ disaster recovery. If you select multiple AZs when creating an instance, cross-AZ disaster recovery will be available.

+

You can view the AZs configured for an instance in the Network section on the Basic Information tab page of the instance. If there are multiple AZs, cross-AZ disaster recovery is available.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0026.html b/docs/dms/umn/kafka-faq-0026.html new file mode 100644 index 000000000..b9813d9ce --- /dev/null +++ b/docs/dms/umn/kafka-faq-0026.html @@ -0,0 +1,11 @@ + + +

Does DMS for Kafka Support Authentication on Clients by the Server?

+

No.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0027.html b/docs/dms/umn/kafka-faq-0027.html new file mode 100644 index 000000000..78ae2dc98 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0027.html @@ -0,0 +1,11 @@ + + +

Can I Use PEM SSL Truststore When Connecting to a Kafka Instance with SASL_SSL Enabled?

+

No. You can only use JKS certificates for connecting to instances in Java.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0028.html b/docs/dms/umn/kafka-faq-0028.html new file mode 100644 index 000000000..a0a431f29 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0028.html @@ -0,0 +1,11 @@ + + +

What Are the Differences Between JKS and CRT Certificates?

+

JKS certificates are used for connecting to instances in Java and CRT certificates are used for connecting to instances in Python.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0029.html b/docs/dms/umn/kafka-faq-0029.html new file mode 100644 index 000000000..6908fbb9c --- /dev/null +++ b/docs/dms/umn/kafka-faq-0029.html @@ -0,0 +1,11 @@ + + +

Which TLS Version Does DMS for Kafka Support?

+

TLS 1.2.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0030.html b/docs/dms/umn/kafka-faq-0030.html new file mode 100644 index 000000000..afff988b6 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0030.html @@ -0,0 +1,11 @@ + + +

Do Kafka Instances Support Disk Encryption?

+

Yes.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0031.html b/docs/dms/umn/kafka-faq-0031.html new file mode 100644 index 000000000..5fd0d22a3 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0031.html @@ -0,0 +1,11 @@ + + +

Can I Delete Unnecessary Topics in a Consumer Group?

+

Yes, just simply unsubscribe from it on the Kafka client.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0032.html b/docs/dms/umn/kafka-faq-0032.html new file mode 100644 index 000000000..2de817789 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0032.html @@ -0,0 +1,11 @@ + + +

Do I Need to Unsubscribe from a Topic Before Deleting a Consumer Group?

+

No. You can directly delete the consumer group.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0033.html b/docs/dms/umn/kafka-faq-0033.html new file mode 100644 index 000000000..229360732 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0033.html @@ -0,0 +1,12 @@ + + +

Is There a Limit on the Number of Client Connections to a Kafka Instance?

+

Yes. The maximum allowed number of client connections varies by instance specifications.

+ +
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0034.html b/docs/dms/umn/kafka-faq-0034.html new file mode 100644 index 000000000..34002e38e --- /dev/null +++ b/docs/dms/umn/kafka-faq-0034.html @@ -0,0 +1,11 @@ + + +

How Many Connections Are Allowed from Each IP Address?

+

Each Kafka broker allows a maximum of 1000 connections from each IP address by default. Excess connections will be rejected. You can change the limit by referring to Modifying Kafka Parameters.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0036.html b/docs/dms/umn/kafka-faq-0036.html new file mode 100644 index 000000000..6dbf626e1 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0036.html @@ -0,0 +1,11 @@ + + +

Can I Change the VPC and Subnet After a Kafka Instance Is Created?

+

No. Once an instance is created, its VPC and subnet cannot be changed.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0037.html b/docs/dms/umn/kafka-faq-0037.html new file mode 100644 index 000000000..3f7a8d84d --- /dev/null +++ b/docs/dms/umn/kafka-faq-0037.html @@ -0,0 +1,11 @@ + + +

Where Can I Find Kafka Streams Use Cases?

+

You can find Kafka Streams use cases on the official Kafka website.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0038.html b/docs/dms/umn/kafka-faq-0038.html new file mode 100644 index 000000000..aba39f09b --- /dev/null +++ b/docs/dms/umn/kafka-faq-0038.html @@ -0,0 +1,18 @@ + + +

What Can I Do If a Consumer Fails to Retrieve Messages from a Topic Due to Insufficient Permissions?

+

Symptom: Different consumers in a consumer group have different topic permissions. When a consumer attempts to retrieve messages from a topic, the error message "Not authorized to access topics." is displayed, and the message retrieval fails.

+

+

Analysis: When assigning partitions, the leader of the consumer group does not consider the permissions of individual consumers. Instead, the leader assigns partitions based on the overall subscription of the consumer group. In this case, consumers may be assigned topics that they do not have access to.

+

For example, consumers A, B, and C are in the same consumer group. Consumer A has subscribed to and has permissions to access Topics 0, 1, and 2; consumer B has subscribed to and has permissions to access Topics 3, 4, and 5; consumer C has subscribed to and has permissions to access Topics 6, 7, and 8. Assume that each topic has only one partition. Based on the partition assignment determined by the leader, consumer A may be assigned Topics 0, 3, and 6; consumer B is assigned Topics 1, 4, and 7; and consumer C is assigned Topics 2, 5, and 8. In this case, consumer A does not have permissions to access Topics 3 and 6, resulting in the error.

+
Figure 1 Consumer access permissions
+

Solution:

+ +

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0040.html b/docs/dms/umn/kafka-faq-0040.html new file mode 100644 index 000000000..ae4662fde --- /dev/null +++ b/docs/dms/umn/kafka-faq-0040.html @@ -0,0 +1,11 @@ + + +

Can I Upgrade Kafka Instances?

+

No. Kafka instances cannot be upgraded once they are created. To use a higher Kafka version, create another Kafka instance.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0041.html b/docs/dms/umn/kafka-faq-0041.html new file mode 100644 index 000000000..810cffefe --- /dev/null +++ b/docs/dms/umn/kafka-faq-0041.html @@ -0,0 +1,15 @@ + + +

How Do I View the Number of Accumulated Messages?

+

View the number of accumulated messages using any of the following methods:

+ +
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0043.html b/docs/dms/umn/kafka-faq-0043.html new file mode 100644 index 000000000..514fc5a8b --- /dev/null +++ b/docs/dms/umn/kafka-faq-0043.html @@ -0,0 +1,14 @@ + + +

Will a Consumer Group Without Active Consumers Be Automatically Deleted in 14 Days?

+

Yes.

+

Kafka uses the offsets.retention.minutes parameter to control how long to keep offsets for a consumer group. If offsets are not committed within this period, they will be deleted. The default value of offsets.retention.minutes is 20,160 minutes (14 days).

+

If Kafka determines that there are no active consumers in a consumer group (for example, when the consumer group is empty) and there are no offsets, Kafka will delete the consumer group.

+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0045.html b/docs/dms/umn/kafka-faq-0045.html new file mode 100644 index 000000000..9e93b0046 --- /dev/null +++ b/docs/dms/umn/kafka-faq-0045.html @@ -0,0 +1,11 @@ + + +

Why Is the Message Creation Time Displayed as Year 1970?

+

The message creation time is specified by CreateTime when a producer creates messages. If this parameter is not set during message creation, the message creation time is year 1970 by default.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-0604001.html b/docs/dms/umn/kafka-faq-0604001.html new file mode 100644 index 000000000..ad3938f7a --- /dev/null +++ b/docs/dms/umn/kafka-faq-0604001.html @@ -0,0 +1,45 @@ + + +

Troubleshooting Kafka Connection Exceptions

+

Overview

This section describes how to troubleshoot Kafka connection problems.

+
+

Problem Classification

If the connection to a Kafka instance is abnormal, perform the following operations to troubleshoot the fault:

+ +
+

Checking the Network

Before connecting to a Kafka instance, ensure that the client and the instance are interconnected. If they cannot be connected, check the network connection.

+

For example, if you have enabled SASL_SSL to access the Kafka instance, run the following command:

+

curl -kv {ip}:{port}

+ +
Solution:
  1. Check whether the client and the Kafka instance are in the same VPC. If they are not in the same VPC, refer to Do Kafka Instances Support Cross-VPC Access?
  2. Check whether the security group rules are correctly configured. For details, see How Do I Select and Configure a Security Group?
+
+
+

Checking Consumer and Producer Configurations

View logs to check whether the parameters printed during the initialization of the consumer and producer are the same as those set in the configuration files.

+

If they are different, check the parameters in the configuration file.

+
+

Common Errors on Java Clients

+
+

Common Errors on the Go Client

The Go client fails to connect to Kafka over SSL and the error "first record does not look like a TLS handshake" is returned.

+

Solution: Enable the TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 cipher suite (which is disabled by default).

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-180604024.html b/docs/dms/umn/kafka-faq-180604024.html new file mode 100644 index 000000000..7c3122e54 --- /dev/null +++ b/docs/dms/umn/kafka-faq-180604024.html @@ -0,0 +1,175 @@ + + +

How Do I Select and Configure a Security Group?

+

Kafka instances can be accessed within a VPC, across VPCs, through DNAT, or over public networks. Before accessing a Kafka instance, configure a security group.

+

Intra-VPC Access

  1. Check whether the client and instance use the same security group.

    • If they use the same security group, check whether the security group has the default inbound rule that allows communication among ECSs within the security group and the default outbound rule that allows all outbound traffic. If these rules are available, you do not need to add more rules. If these rules are not available, add rules according to Table 1. +
      + + + + + + + + + + + + + + + + + + + +
      Table 1 Security group rules

      Direction

      +

      Protocol

      +

      Port

      +

      Source

      +

      Description

      +

      Inbound

      +

      TCP

      +

      9092

      +

      0.0.0.0/0

      +

      Accessing an instance within a VPC (with SSL encryption disabled)

      +

      Inbound

      +

      TCP

      +

      9093

      +

      0.0.0.0/0

      +

      Accessing an instance within a VPC (with SSL encryption enabled)

      +
      +
      +
    • If they use different security groups, go to 2.
    +

  2. Configure security group rules as follows.

    Assume that the security groups of the client and Kafka instance are sg-53d4 and Default_All, respectively. You can specify a security group or IP address as the destination in the following rule. A security group is used as an example.

    +

    To ensure that your client can access the Kafka instance, add the following rule to the security group configured for the client:

    + +
    + + + + + + + + + +
    Table 2 Security group rule

    Direction

    +

    Protocol & Port

    +

    Destination

    +

    Outbound

    +

    All

    +

    Default_All

    +
    +
    +

    To ensure that your client can access the Kafka instance, add the following rule to the security group configured for the instance.

    + +
    + + + + + + + + + +
    Table 3 Security group rule

    Direction

    +

    Protocol & Port

    +

    Source

    +

    Inbound

    +

    All

    +

    sg-53d4

    +
    +
    +

+
+

Cross-VPC and DNAT-based Instance Access

Configure security group rules according to Table 5.

+ +
+ + + + + + + + + + + + + + + + + + + +
Table 4 Security group rules

Direction

+

Protocol

+

Port

+

Source

+

Description

+

Inbound

+

TCP

+

9011

+

198.19.128.0/17

+

Accessing a Kafka instance using VPC Endpoint (VPCEP)

+

Inbound

+

TCP

+

9011

+

0.0.0.0/0

+

Accessing a Kafka instance using DNAT

+
+
+

+
+

Public Access

Configure security group rules according to Table 5.

+ +
+ + + + + + + + + + + + + + + + + + + +
Table 5 Security group rules

Direction

+

Protocol

+

Port

+

Source

+

Description

+

Inbound

+

TCP

+

9094

+

0.0.0.0/0

+

Access Kafka through the public network (without SSL encryption).

+

Inbound

+

TCP

+

9095

+

0.0.0.0/0

+

Access Kafka through the public network (with SSL encryption).

+
+
+

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-190416001.html b/docs/dms/umn/kafka-faq-190416001.html new file mode 100644 index 000000000..6a0451680 --- /dev/null +++ b/docs/dms/umn/kafka-faq-190416001.html @@ -0,0 +1,27 @@ + + +

Messages

+
+
+ + + +
+ diff --git a/docs/dms/umn/kafka-faq-191030001.html b/docs/dms/umn/kafka-faq-191030001.html new file mode 100644 index 000000000..f10a27b34 --- /dev/null +++ b/docs/dms/umn/kafka-faq-191030001.html @@ -0,0 +1,47 @@ + + +

Connections

+
+
+ + + +
+ diff --git a/docs/dms/umn/kafka-faq-191030002.html b/docs/dms/umn/kafka-faq-191030002.html new file mode 100644 index 000000000..af20a2dec --- /dev/null +++ b/docs/dms/umn/kafka-faq-191030002.html @@ -0,0 +1,55 @@ + + +

Instances

+
+
+ + + +
+ diff --git a/docs/dms/umn/kafka-faq-191030003.html b/docs/dms/umn/kafka-faq-191030003.html new file mode 100644 index 000000000..26c762564 --- /dev/null +++ b/docs/dms/umn/kafka-faq-191030003.html @@ -0,0 +1,39 @@ + + +

Topics and Partitions

+
+
+ + + +
+ diff --git a/docs/dms/umn/kafka-faq-191030004.html b/docs/dms/umn/kafka-faq-191030004.html new file mode 100644 index 000000000..30720d734 --- /dev/null +++ b/docs/dms/umn/kafka-faq-191030004.html @@ -0,0 +1,19 @@ + + +

Monitoring & Alarm

+
+
+ + + +
+ diff --git a/docs/dms/umn/kafka-faq-200423001.html b/docs/dms/umn/kafka-faq-200423001.html new file mode 100644 index 000000000..7b7eaab50 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200423001.html @@ -0,0 +1,19 @@ + + +

Consumer Groups

+
+
+ + + +
+ diff --git a/docs/dms/umn/kafka-faq-200426002.html b/docs/dms/umn/kafka-faq-200426002.html new file mode 100644 index 000000000..da4c8fab6 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426002.html @@ -0,0 +1,13 @@ + + +

Why Can't I Select Two AZs?

+

To improve the reliability of a Kafka instance, you are advised to select three AZs or more when creating the instance. You cannot select two AZs.

+

Each Kafka instance contains three ZooKeeper nodes. The ZooKeeper cluster manages Kafka instance configurations. If the ZooKeeper cluster is faulty, the Kafka instance cannot run properly. At least two ZooKeepers are required for the cluster to run properly.

+

Assume that you select only two AZs. AZ 1 has one ZooKeeper node, and AZ 2 has two. If AZ 1 is faulty, the instance can be used properly. If AZ 2 is faulty, the cluster cannot be used. In this case, the availability rate of the Kafka instance is just 50%. Therefore, do not select 2 AZs.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426003.html b/docs/dms/umn/kafka-faq-200426003.html new file mode 100644 index 000000000..f70dfba4d --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426003.html @@ -0,0 +1,11 @@ + + +

Why Can't I View the Subnet and Security Group Information When Creating a DMS Instance?

+

This may be because you do not have the Server Administrator and VPC Administrator permissions. For details about how to add permissions to a user group, see "User and User Group Management" > "Viewing and Modifying User Group Information" in the Identity and Access Management User Guide.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426005.html b/docs/dms/umn/kafka-faq-200426005.html new file mode 100644 index 000000000..9c0f57552 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426005.html @@ -0,0 +1,13 @@ + + +

How Do I Select Storage Space for a Kafka Instance?

+

The storage space is the space for storing messages (including messages in replicas), logs and metadata. When specifying storage space, specify the disk type and disk size. Different bandwidth configurations support different disk types. For details, see Table 1.For more information about disks, see "Overview" > "Disk Types and Performance" in the Elastic Volume Service User Guide.

+

For example, if the required disk size to store data for the retention period is 100 GB, the disk capacity must be at least: 100 GB x Number of replicas + 100 GB (reserved space). In a Kafka cluster, each node uses a 33 GB disk to store logs and ZooKeeper data. Therefore, the actual available storage space is less than the created storage space.

+

The number of replicas (3 by default) can be configured when you create a topic. If automatic topic creation has been enabled, each automatically created topic has three replicas by default. You can change this quantity by setting default.replication.factor on the Parameters tab page.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426006.html b/docs/dms/umn/kafka-faq-200426006.html new file mode 100644 index 000000000..1771e0baa --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426006.html @@ -0,0 +1,13 @@ + + +

How Do I Choose Between High I/O and Ultra-high I/O?

+
+

You are advised to select ultra-high I/O, because ultra-high I/O disks deliver much higher bandwidth than high I/O.

+

Different bandwidth configurations support different disk types. For details, see Table 1.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426007.html b/docs/dms/umn/kafka-faq-200426007.html new file mode 100644 index 000000000..f6a011185 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426007.html @@ -0,0 +1,15 @@ + + +

Which Capacity Threshold Policy Should I Use?

+

The following policies are supported:

+ +

Select a proper policy based on requirements for data and service reliability. Both policies are only used for handling extreme scenarios. To avoid extreme scenarios, create sufficient disk space in the first place.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426008.html b/docs/dms/umn/kafka-faq-200426008.html new file mode 100644 index 000000000..293b6c932 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426008.html @@ -0,0 +1,11 @@ + + +

Which Kafka Versions Are Supported?

+

Kafka v1.1.0, v2.3.0, and v2.7.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426009.html b/docs/dms/umn/kafka-faq-200426009.html new file mode 100644 index 000000000..554d0f67e --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426009.html @@ -0,0 +1,12 @@ + + +

What Is the ZooKeeper Address of a Kafka Instance?

+

Kafka instances are managed using ZooKeeper. Opening ZooKeeper may cause misoperations and service losses. ZooKeeper is used only within Kafka clusters and does not provide services externally.

+

You can use open-source Kafka clients to connect to Kafka instances and call the native APIs to create and retrieve messages.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426010.html b/docs/dms/umn/kafka-faq-200426010.html new file mode 100644 index 000000000..3d7e323b3 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426010.html @@ -0,0 +1,11 @@ + + +

Are Kafka Instances in Cluster Mode?

+

Yes. A Kafka instance is a cluster that consists of three or more brokers.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426011.html b/docs/dms/umn/kafka-faq-200426011.html new file mode 100644 index 000000000..6ae5e8f18 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426011.html @@ -0,0 +1,17 @@ + + +

Can I Modify the Connection Address for Accessing a Kafka Instance?

+

No. You must access a Kafka instance through one of the following ports:

+ +

Ensure that correct rules have been configured for the security group of the instance. For details, see How Do I Select and Configure a Security Group?

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426012.html b/docs/dms/umn/kafka-faq-200426012.html new file mode 100644 index 000000000..170bb1720 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426012.html @@ -0,0 +1,11 @@ + + +

How Long Are Kafka SSL Certificates Valid for?

+

The certificates are valid for more than 15 years. You do not need to worry about certificate expiration. The certificates are used for one-way authentication when enabling SASL for Kafka instances.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426013.html b/docs/dms/umn/kafka-faq-200426013.html new file mode 100644 index 000000000..845ded181 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426013.html @@ -0,0 +1,11 @@ + + +

How Do I Synchronize Data from One Kafka Instance to Another?

+

Unfortunately, you cannot synchronize two Kafka instances in real time. To migrate services from one instance to another, create messages to both instances. After all messages in the original instance have been retrieved or aged, you can migrate services to the new instance.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426014.html b/docs/dms/umn/kafka-faq-200426014.html new file mode 100644 index 000000000..fa200fa43 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426014.html @@ -0,0 +1,11 @@ + + +

How Do I Change the SASL_SSL Setting of a Kafka Instance?

+

The SASL_SSL setting cannot be changed once the instance has been created. Be careful when configuring this setting during instance creation. If you need to change the setting, you must create another instance.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426015.html b/docs/dms/umn/kafka-faq-200426015.html new file mode 100644 index 000000000..c597b20f3 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426015.html @@ -0,0 +1,11 @@ + + +

Can I Access a Kafka Instance Over a Public Network?

+

Yes. For details, see the instance access instructions.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426016.html b/docs/dms/umn/kafka-faq-200426016.html new file mode 100644 index 000000000..12263f5d2 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426016.html @@ -0,0 +1,11 @@ + + +

How Many Connection Addresses Does a Kafka Instance Have by Default?

+

The number of connection addresses of a Kafka instance is the same as the number of brokers of the instance.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426017.html b/docs/dms/umn/kafka-faq-200426017.html new file mode 100644 index 000000000..0aca9d254 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426017.html @@ -0,0 +1,11 @@ + + +

Do Kafka Instances Support Cross-Region Access?

+

Yes. You can access a Kafka instance across regions over a public network or by using direct connections.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426019.html b/docs/dms/umn/kafka-faq-200426019.html new file mode 100644 index 000000000..ceee8124b --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426019.html @@ -0,0 +1,12 @@ + + +

Do Kafka Instances Support Cross-VPC Access?

+

Yes. You can use one of the following methods to access a Kafka instance across VPCs:

+ +
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426020.html b/docs/dms/umn/kafka-faq-200426020.html new file mode 100644 index 000000000..b39d380ca --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426020.html @@ -0,0 +1,12 @@ + + +

Do Kafka Instances Support Cross-Subnet Access?

+

Yes.

+

If the client and the instance are in the same VPC, cross-subnet access is supported.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426023.html b/docs/dms/umn/kafka-faq-200426023.html new file mode 100644 index 000000000..cb9591082 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426023.html @@ -0,0 +1,12 @@ + + +

Does DMS for Kafka Support Authentication with Kerberos?

+

No, Kerberos authentication is not supported. Kafka supports client authentication with SASL and API calling authentication using tokens and AK/SK.

+

To access an instance in SASL mode, you need the certificates provided by DMS. For details, see Accessing a Kafka Instance with SASL.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426024.html b/docs/dms/umn/kafka-faq-200426024.html new file mode 100644 index 000000000..2a67e898d --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426024.html @@ -0,0 +1,90 @@ + + +

Is There a Limit on the Number of Topics in a Kafka Instance?

+

The number of topics is related to the total number of topic partitions and the number of partitions in each topic. There is an upper limit on the aggregate number of partitions of topics. When this limit is reached, no more topics can be created.

+

The partition limit varies depending on the flavor, as shown in the following table.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 TPS and the maximum number of partitions supported by different instance specifications and I/O types

Bandwidth

+

I/O Type

+

TPS (High-Throughput)

+

TPS (Synchronous Replication)

+

Maximum Partitions

+

100 MB/s

+

High I/O

+

100,000

+

60,000

+

300

+

Ultra-high I/O

+

100,000

+

80,000

+

300

+

300 MB/s

+

High I/O

+

300,000

+

150,000

+

900

+

Ultra-high I/O

+

300,000

+

200,000

+

900

+

600 MB/s

+

Ultra-high I/O

+

600,000

+

300,000

+

1800

+

1200 MB/s

+

Ultra-high I/O

+

1,200,000

+

400,000

+

1800

+
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426025.html b/docs/dms/umn/kafka-faq-200426025.html new file mode 100644 index 000000000..fd6c9d209 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426025.html @@ -0,0 +1,90 @@ + + +

Why Is Partition Quantity Limited?

+

Kafka manages messages by partition. If there are too many partitions, message creation, storage, and retrieval will be fragmented, affecting the performance and stability. If the total number of partitions of topics reaches the upper limit, you cannot create more topics.

+

The partition limit varies depending on the flavor, as shown in the following table.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 TPS and the maximum number of partitions supported by different instance specifications and I/O types

Bandwidth

+

I/O Type

+

TPS (High-Throughput)

+

TPS (Synchronous Replication)

+

Maximum Partitions

+

100 MB/s

+

High I/O

+

100,000

+

60,000

+

300

+

Ultra-high I/O

+

100,000

+

80,000

+

300

+

300 MB/s

+

High I/O

+

300,000

+

150,000

+

900

+

Ultra-high I/O

+

300,000

+

200,000

+

900

+

600 MB/s

+

Ultra-high I/O

+

600,000

+

300,000

+

1800

+

1200 MB/s

+

Ultra-high I/O

+

1,200,000

+

400,000

+

1800

+
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426026.html b/docs/dms/umn/kafka-faq-200426026.html new file mode 100644 index 000000000..a37df62e1 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426026.html @@ -0,0 +1,12 @@ + + +

Why Do I Fail to Create Topics?

+

Possible cause: The aggregate number of partitions of created topics has reached the upper limit. The maximum number of partitions varies with instance specifications. For details, see Specifications.

+

Solution: Delete unnecessary topics.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426027.html b/docs/dms/umn/kafka-faq-200426027.html new file mode 100644 index 000000000..f525b301d --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426027.html @@ -0,0 +1,13 @@ + + +

Do Kafka Instances Support Batch Importing Topics or Automatic Topic Creation?

+

Automatic topic creation is supported, but batch topic import is not supported. You can only export topics in batches.

+

Enable automatic topic creation using one of the following methods:

+ +
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426028.html b/docs/dms/umn/kafka-faq-200426028.html new file mode 100644 index 000000000..e9e5d2b9c --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426028.html @@ -0,0 +1,12 @@ + + +

Why Do Deleted Topics Still Exist?

+

This may be because automatic topic creation has been enabled and a consumer is connecting to the topic. If no existing topics are available for message creation, new topics will be automatically created.

+

To solve this problem, disable automatic topic creation.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426030.html b/docs/dms/umn/kafka-faq-200426030.html new file mode 100644 index 000000000..58b6de8ed --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426030.html @@ -0,0 +1,13 @@ + + +

Can I View the Disk Space Used by a Topic?

+

Yes. Use either of the following methods to check the disk space used by a topic:

+ +

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426032.html b/docs/dms/umn/kafka-faq-200426032.html new file mode 100644 index 000000000..f0ea93a01 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426032.html @@ -0,0 +1,12 @@ + + +

Can I Add ACL Permissions for Topics?

+

If you have enabled SASL_SSL for your Kafka instance, you can configure ACL permissions for your topics. On the Topics tab page of the Kafka console, click Grant User Permission in the row that contains the topic for which you want to configure user permissions.

+

For details, see Granting Permissions to a SASL_SSL User.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426033.html b/docs/dms/umn/kafka-faq-200426033.html new file mode 100644 index 000000000..70825fcae --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426033.html @@ -0,0 +1,12 @@ + + +

Do I Need to Create Consumer Groups, Producers, and Consumers for Kafka Instances?

+

No. They are generated automatically when you use the instance.

+

For details about creating and retrieving messages after connecting to a Kafka instance, see Accessing a Kafka Instance.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426035.html b/docs/dms/umn/kafka-faq-200426035.html new file mode 100644 index 000000000..3f3fc1a20 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426035.html @@ -0,0 +1,11 @@ + + +

What Is the Maximum Size of a Message that Can be Created?

+

10 MB.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426036.html b/docs/dms/umn/kafka-faq-200426036.html new file mode 100644 index 000000000..a1148d3fe --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426036.html @@ -0,0 +1,23 @@ + + +

Why Does Message Poll Often Fail During Rebalancing?

+

Rebalancing is a process where partitions of topics are re-allocated for a consumer group.

+

In normal cases, rebalancing occurs inevitably when a consumer is added to or removed from a consumer group. However, if a consumer is regarded as abnormal and removed from the consumer group, message retrieval may fail.

+

This may happen in the following scenarios:

+
  1. Heartbeat requests are not sent in time.

    A consumer sends heartbeat requests to the broker at the interval specified by heartbeat.interval.ms. If the broker does not receive any heartbeat request from the consumer within the period specified by session.timeout.ms, the broker considers that the consumer is abnormal and removes the consumer from the consumer group, triggering rebalancing.

    +
  2. The interval between retrievals is too long.

    The maximum number of messages that a consumer can retrieve at a time is specified by max.poll.records. In most cases, a client processes the retrieved data before starting the next retrieval. The processing may be prolonged when a large number of messages are retrieved at a time and cannot be processed within the time specified by max.poll.interval.ms, or when an exception occurs during the process (for example, data needs to be written to the backend database, but the backend database pressure is too high, resulting in high latency). If the consumer does not send the next retrieval request within the time specified by max.poll.interval.ms, the broker considers that the consumer is inactive and removes it from the consumer group, triggering rebalancing.

    +
+

Solutions and Troubleshooting Methods

Scenario 1: Heartbeat requests are not sent in time.

+

Solution: Set the value of session.timeout.ms to three times the value of heartbeat.interval.ms.

+

Scenario 2: The interval between retrievals is too long.

+

Troubleshooting methods:

+
  1. Check the time required for processing a single message and whether the time required for processing a specified number (max.poll.records) of messages exceeds the time specified by max.poll.interval.ms.
  2. Check whether message processing requires network connections, such as writing data to the database and calling backend APIs, and whether the backend is normal in rebalancing scenarios.
+
+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426037.html b/docs/dms/umn/kafka-faq-200426037.html new file mode 100644 index 000000000..723c70334 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426037.html @@ -0,0 +1,16 @@ + + +

Why Can't I Query Messages on the Console?

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426041.html b/docs/dms/umn/kafka-faq-200426041.html new file mode 100644 index 000000000..5c8d9a14c --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426041.html @@ -0,0 +1,13 @@ + + +

Why Can't I View the Monitoring Data?

+

The possible causes are as follows:

+ +

To solve the problem, delete topics and consumer groups whose names contain the special character.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200426101.html b/docs/dms/umn/kafka-faq-200426101.html new file mode 100644 index 000000000..fae68a3ae --- /dev/null +++ b/docs/dms/umn/kafka-faq-200426101.html @@ -0,0 +1,11 @@ + + +

Can I Change the Partition Quantity?

+

No. If you want to use fewer partitions, delete the corresponding topic, create another one, and specify the desired number of partitions.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200708001.html b/docs/dms/umn/kafka-faq-200708001.html new file mode 100644 index 000000000..fd7f467e7 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200708001.html @@ -0,0 +1,15 @@ + + +

Why Do Messages Still Exist After the Retention Period Elapses?

+

If the aging time has been set for a topic, the value of the log.retention.hours parameter does not take effect for the topic. The value of the log.retention.hours parameter takes effect only if the aging time has not been set for the topic.

+

Possible cause 1: The segment files are in use.

+

Solution: Wait until the segment is no longer in use or delete the topic where messages have reached their retention period.

+

Possible cause 2: In a topic, there is a message whose CreateTime is a future time. For example, assume that it is January 1, and the CreateTime is February 1. The message will not be aged after 72 hours from now. As a result, messages created subsequently will also not be aged.

+

Solution: Delete the topic where the CreateTime of a message is a future time.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-faq-200708002.html b/docs/dms/umn/kafka-faq-200708002.html new file mode 100644 index 000000000..efc875481 --- /dev/null +++ b/docs/dms/umn/kafka-faq-200708002.html @@ -0,0 +1,12 @@ + + +

Does DMS for Kafka Support Password-Free Access?

+

Yes. No password is required for accessing a Kafka instance with SASL disabled. For details, see Accessing a Kafka Instance Without SASL.

+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-pd-190605001.html b/docs/dms/umn/kafka-pd-190605001.html new file mode 100644 index 000000000..aaef23cee --- /dev/null +++ b/docs/dms/umn/kafka-pd-190605001.html @@ -0,0 +1,16 @@ + + +

What Is DMS?

+

Apache Kafka is distributed message middleware that features high throughput, data persistence, horizontal scalability, and stream data processing. It adopts the publish-subscribe pattern and is widely used for log collection, data streaming, online/offline system analytics, and real-time monitoring.

+

DMS is a message queuing service based on Apache Kafka. It provides Kafka instances with isolated compute, storage, and bandwidth resources. DMS allows you to apply and configure resources based on service requirements. It can be used out of the box and frees you from deployment and O&M so that you can focus on the agile development of your applications.

+

+

Readers' Guide

This documentation introduces DMS for Kafka and its differences from Apache Kafka. You will learn about the detailed information about the specifications, console operations, and client access to instances of DMS for Kafka.

+

For more information about the basic knowledge of Kafka or technical details about creating and retrieving messages, please go to the official Apache Kafka website.

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-pd-190605002.html b/docs/dms/umn/kafka-pd-190605002.html new file mode 100644 index 000000000..39db25f6b --- /dev/null +++ b/docs/dms/umn/kafka-pd-190605002.html @@ -0,0 +1,24 @@ + + +

Related Services

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-pd-190605003.html b/docs/dms/umn/kafka-pd-190605003.html new file mode 100644 index 000000000..3f0ad2ab0 --- /dev/null +++ b/docs/dms/umn/kafka-pd-190605003.html @@ -0,0 +1,158 @@ + + +

Notes and Constraints

+

This section describes the notes and constraints on DMS.

+

Instance

+
+ + + + + + + + + + + + + + + + + + + +
Table 1 Instance notes and constraints

Item

+

Notes and Constraints

+

Kafka ZooKeeper

+

Kafka clusters are managed using ZooKeeper. Opening ZooKeeper may cause misoperations and service losses. Currently, ZooKeeper is used only within Kafka clusters and does not provide services externally.

+

Version

+
  • The service version can be 1.1.0, 2.3.0, or 2.7. Kafka instances cannot be upgraded once they are created.
  • Clients later than version 0.10 are supported. Use a version that is consistent with the service version.
+

Logging in to the VM where the Kafka brokers reside

+

Not supported

+

VPC and subnet

+

After an instance is created, its VPC and subnet cannot be modified.

+

Kerberos authentication

+

Not supported

+
+
+
+

Topic

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Topic notes and constraints

Item

+

Notes and Constraints

+

Total number of topic partitions

+

The total number of topic partitions is related to the instance specifications. For details, see Specifications.

+

Kafka manages messages by partition. If there are too many partitions, message creation, storage, and retrieval will be fragmented, affecting the performance and stability. If the total number of partitions of topics reaches the upper limit, you cannot create more topics.

+

Number of partitions in a topic

+

The number of partitions in a topic can be increased but cannot be decreased.

+

Topic quantity

+

The topic quantity is related to the total number of topic partitions and number of partitions in each topic. For details, see Specifications.

+

Automatic topic creation

+

Supported. If automatic topic creation is enabled, the system automatically creates a topic when a message is created in or retrieved from a topic that does not exist. This topic has the following default settings: 3 partitions, 3 replicas, aging time 72 hours, and synchronous replication and flushing disabled.

+

After you change the value of the log.retention.hours, default.replication.factor, or num.partitions parameter, automatically created topics later use the new value. For example, if num.partitions is set to 5, an automatically created topic will have the following settings: 5 partitions, 3 replicas, aging time 72 hours, and synchronous replication and flushing disabled.

+

Decreasing partition quantity

+

The partition quantity cannot be decreased due to the limitations of Apache Kafka.

+

Synchronous replication

+

If a topic has only one replica, synchronous replication cannot be enabled.

+

Replica quantity

+

Single-replica topics are not recommended. If an instance node is faulty, an internal service error may be reported when you query messages in a topic with only one replica. Therefore, you are not advised to use a topic with only one replica.

+

Aging time

+

The value of the log.retention.hours parameter takes effect only if the aging time has not been set for the topic.

+

For example, if the aging time of Topic01 is set to 60 hours and log.retention.hours is set to 72 hours, the actual aging time of Topic01 is 60 hours.

+

Batch importing and exporting topics

+

Batch export is supported, but batch import is not supported.

+

Topic name

+

If a topic name starts with a special character, for example, an underscore (_) or a number sign (#), monitoring data cannot be displayed.

+

Delay queues

+

Not supported

+
+
+
+

Consumer Group

+
+ + + + + + + + + + + + + +
Table 3 Consumer group notes and constraints

Item

+

Notes and Constraints

+

Creating consumer groups, consumers, and producers

+

Consumer groups, consumers, and producers are generated automatically when you use the instance.

+

Resetting the consumer offset

+

Messages may be retrieved more than once after the offset is reset.

+

Consumer group name

+

If a consumer group name starts with a special character, for example, an underscore (_) or a number sign (#), monitoring data cannot be displayed.

+
+
+
+

Message

+
+ + + + + + + +
Table 4 Message notes and constraints

Item

+

Notes and Constraints

+

Message size

+

The maximum length of a message is 10 MB. If the length exceeds 10 MB, the production fails.

+
+
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-pd-200720001.html b/docs/dms/umn/kafka-pd-200720001.html new file mode 100644 index 000000000..fe7414585 --- /dev/null +++ b/docs/dms/umn/kafka-pd-200720001.html @@ -0,0 +1,97 @@ + + +

Comparing DMS for Kafka and Open-Source Kafka

+

DMS is compatible with open-source Kafka and has customized and enhanced Kafka features. In addition to the advantages of open-source Kafka, DMS for Kafka provides more reliable and useful features.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Differences between DMS and open-source Kafka

Category

+

Item

+

DMS

+

Open-source Kafka

+

Ease of use

+

Readily available

+

Instances can be created intuitively within minutes and used right out of the box with visualized operations and real-time monitoring.

+

Preparing server resources and installing and configuring the software is time-consuming and prone to mistakes.

+

APIs

+

Instances can be managed easily by calling RESTful APIs.

+

N/A

+

Costs

+

On-demand use

+

Multiple specifications are available to suit different needs.

+

Expenses are incurred for setting up a message service and occupying underlying resources.

+

Fully managed

+

Services are readily available without requiring additional hardware resources or expenses.

+

Users must prepare hardware resources and set up the service by themselves, and bear high usage and maintenance costs.

+

Proven success

+

+

Mature

+

DMS has been deployed in many cloud products and proven successful in large e-commerce events. It is also used in the clouds of carrier-grade customers across the world, and meets strict carrier-grade reliability standards. DMS closely follows up with community updates to continuously fix known open-source vulnerabilities and add support for new features.

+

Using open-source software requires lengthy self-development and verification and has had few successful cases.

+

Feature-rich

+

While maintaining 100% open-source compatibility, DMS further optimizes open-source code to improve performance and reliability, and provides message querying, and many other features.

+

Functionality is limited and requires self-development.

+

Reliability

+

Highly available

+

DMS supports cross-AZ deployment to improve reliability. In addition, automatic fault detection and alarms ensure reliable operations of key services.

+

High availability requires self-development or open-source code implementation, which are costly and cannot guarantee reliability.

+

Simple O&M

+

O&M is entirely transparent to tenants with a full set of monitoring and alarm functions. O&M personnel will be informed of any exceptions, eliminating the need for 24/7 attending.

+

Users need to develop and optimize O&M functions, especially alarm notification functions. Otherwise, manual attendance is required.

+

Secure

+

DMS uses VPC isolation, disk encryption, and SSL channel encryption.

+

Security must be hardened by users themselves.

+
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-scenarios.html b/docs/dms/umn/kafka-scenarios.html new file mode 100644 index 000000000..68cccf92f --- /dev/null +++ b/docs/dms/umn/kafka-scenarios.html @@ -0,0 +1,29 @@ + + +

Application Scenarios

+

Kafka is popular message-oriented middleware that features highly reliable, asynchronous message delivery. It is widely used for transmitting data between different systems in many industries, including enterprise application, payment, telecommunications, e-commerce, social networking, instant messaging, video, Internet of Things, and Internet of Vehicle.

+

Asynchronous Communication

Non-core or less important messages are sent asynchronously to receiving systems, so that the main service process is not kept waiting for the results of other systems, allowing for faster responses.

+

For example, Kafka can be used to send a notification email and SMS message after a user has registered with a website, providing fast responses throughout the registration process.

+
Figure 1 Serial registration and notification
+
Figure 2 Asynchronous registration and notification using message queues
+
+

Traffic Control

In e-commerce systems or large-scale websites, there is a processing capability gap between upstream and downstream systems. Traffic bursts from upstream systems with high processing capabilities may have a large impact on downstream systems with lower processing capabilities. For example, online sales promotions involve a huge amount of traffic flooding into e-commerce systems. Kafka provides a three-day buffer by default for hundreds of millions of messages, such as orders and other information. In this way, message consumption systems can process the messages during off-peak periods.

+

In addition, flash sale traffic bursts originating from frontend systems can be handled with Kafka, keeping the backend systems from crashing.

+
Figure 3 Traffic burst handling using Kafka
+
+

Log Synchronization

In large-scale service systems, logs of different applications are collected for quick troubleshooting, full-link tracing, and real-time monitoring.

+

Kafka is originally designed for this scenario. Applications asynchronously send log messages to message queues over reliable transmission channels. Other components can read the log messages from message queues for further analysis, either in real time or offline. In addition, Kafka can collect key log information to monitor applications.

+

Log synchronization involves three major components: log collection clients, Kafka, and backend log processing applications.

+
  1. The log collection clients collect log data from a user application service and asynchronously send the log data in batches to Kafka clients.

    Kafka clients receive and compress messages in batches. This only has a minor impact on the service performance.

    +
  2. Kafka persists logs.
  3. Log processing applications, such as Logstash, subscribe to messages in Kafka and retrieve log messages from Kafka. Then, the messages are searched for by file search services or delivered to big data applications such as Hadoop for storage and analysis.
+
Figure 4 Log synchronization process
+

Logstash is for log analytics, Elasticsearch is for log search, and Hadoop is for big data analytics. They are all open-source tools.

+
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-00001.html b/docs/dms/umn/kafka-ug-00001.html new file mode 100644 index 000000000..b4672fc65 --- /dev/null +++ b/docs/dms/umn/kafka-ug-00001.html @@ -0,0 +1,132 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Released On

+

What's New

+

2022-10-30

+

This release incorporates the following changes:

+ +

2020-08-11

+

This release incorporates the following changes:

+ +

2020-07-29

+

This release incorporates the following changes:

+
  • Added the description that public access is not supported when the instance specification is 100 MB/s in section Creating an Instance.
  • Deleted the description about public network bandwidth being 100 MB/s in section Configuring Public Access.
+

2020-02-20

+

This release incorporates the following changes:

+ +

2019-12-16

+

Accepted for RM-2128.

+

2019-11-30

+

This release incorporates the following changes:

+
  • Optimized description about Kafka premium instances in section What Is DMS?.
  • Added description about DMS functions in section "Functions".
  • Added description about the differences between Kafka queues and Kafka premium instances in section "Comparing Kafka Queues and Kafka Premium Instances".
  • Added description about the specifications of Kafka queues and Kafka premium instances in section Specifications.
  • Added explanation of the relationship between Kafka premium instances and VPCs in section Related Services.
  • Optimized description about DMS queues and added description about Kafka premium instances in section Basic Concepts.
  • Added recommendations on Kafka client configurations in section Best Practices.
  • Removed the Region parameter in section "Creating a Queue".
  • Optimized description about queue policy parameters in section "Managing Queue Policies".
  • Optimized description about Kafka premium instance operations and parameters in chapter "Managing Kafka Premium Instances".
  • Optimized description about DMS metrics in section Kafka Metrics.
  • Added description about Kafka premium instance operations supported by CTS in section Operations Logged by CTS.
+

2019-11-08

+

This release incorporates the following changes:

+ +

2018-11-07

+

Accepted in OTC 3.2.

+

2018-05-25

+

Accepted in OTC 3.1.

+

2018-04-28

+

Added the following content:

+ +

2018-04-03

+

Added the following content:

+
  • Added queue policy description in section "Managing Queue Policies".
+

2018-01-19

+

Modified the following content:

+
  • Added the support for Kafka queues.
+

2017-12-05

+

Modified the following content:

+
  • Modified the description of some steps based on DMS console UI 3.0.
+

2017-10-25

+

Modified the following content:

+ +

2017-07-28

+

Modified the following content:

+
  • Provided support for FIFO queues.
  • Provided support for dead letter queues.
  • Added two dead letter message monitoring metrics to Cloud Eye.
  • Added section Basic Concepts.
  • Added the step of selecting a region and a project.
+

2017-03-30

+

Modified the following content:

+
  • In section "Retrieving Messages", changed Consume Interval to Queue Polling Interval.
  • In section "Retrieving Messages", changed Consume Message to Retrieve Message.
+

2017-01-19

+

Modified the following content:

+
  • In sections Change History and "Functions", added description about how multiple consumer groups retrieve messages.
  • In section Change History, revised description about attribute names.
  • In section "Creating a Queue", added description about queue quota.
  • In section Change History, added description about attribute names.
  • In section "Retrieving Messages", changed Message Count to Max. Message Count.
+
  • In section "Retrieving Messages", revised description about message retrieval.
+

2017-01-13

+

Modified the following content:

+
  • In section Change History, revised description about queues and messages.
  • In section Change History, revised the figure "Distribution of messages from a queue".
  • Deleted redundant information.
+

2017-01-09

+

Modified the following content:

+
  • In section Change History, added description about message creation results.
  • Added section "Why Do Consumers Need to Acknowledge Messages?".
+

2016-12-19

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/dms/umn/kafka-ug-0001.html b/docs/dms/umn/kafka-ug-0001.html new file mode 100644 index 000000000..d31c02cb3 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0001.html @@ -0,0 +1,52 @@ + + +

Cross-VPC Access to a Kafka Instance

+

Context

VPCs are logically isolated from each other. If a Kafka instance and a Kafka client are in different VPCs within a region, they cannot communicate with each other. In this case, you can use one of the following methods to access a Kafka instance across VPCs:

+ +
+

Scenario

The following describes how to use VPCEP to implement cross-VPC access.

+

VPCEP provides two types of resources: VPC endpoint services and VPC endpoints.

+ +
Figure 1 Working principle of accessing a Kafka instance across VPCs
+
+

Procedure

Figure 2 Process for accessing a Kafka instance across VPCs
+
+

Creating a VPC Endpoint Service

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. In the Advanced Settings section on the Basic Information tab page, obtain the listeners IP addresses and port IDs of the instance for Cross-VPC Access.

    Figure 3 Cross-VPC access–related listeners IP addresses and corresponding port IDs of the Kafka instance
    +

  6. In the Network section on the Basic Information tab page, view the VPC to which the Kafka instance belongs.

    Figure 4 Viewing the VPC to which the Kafka instance belongs
    +

  7. Click the VPC to obtain the VPC ID on the VPC console.

    Figure 5 Obtaining the VPC ID
    +

  8. Call the VPC Endpoint API to create a VPC endpoint service. For details, see "Creating a VPC Endpoint Service" in VPC Endpoint API Reference.

    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -X POST -H "X-Auth-Token:$token" -d '{"port_id":"38axxxeac","vpc_id":"706xxx888","ports":[{"protocol":"TCP","client_port":9011,"server_port":9011 }],"approval_enabled":false,"service_type":"interface","server_type":"VM"}' https://{endpoint}/v1/{project_id}/vpc-endpoint-services
    +

    Parameter description:

    +
    • token: an access credential issued to an IAM user to bear its identity and permissions. For details on how to obtain a token, see Obtaining a User Token.
    • port_id: one of the port IDs obtained in 5.
    • vpc_id: VPC ID obtained in 7.
    • endpoint: VPCEP endpoint obtained from Regions and Endpoints. The region must be the same as that of the Kafka instance.
    • project_id: project ID obtained from "Obtaining a Project ID". The region must be the same as that of the Kafka instance. For details about how to obtain the value, see section "Common Parameters" > "Obtaining a Project ID" in the VPC Endpoint API Reference.
    +

    +

    Record the value of service_name in the response. This parameter indicates the name of the VPC endpoint service.

    +

  9. Repeat 8 to create VPC endpoint services for other port IDs obtained in 5 and record the VPC endpoint service names.
+
+

(Optional) Adding a Whitelist Record

If the Kafka client and Kafka instance belong to different accounts, add the ID of the account to which the Kafka client belongs to the whitelist of the endpoint service. For details, see Add a Whitelist Record.

+
+

Creating a VPC Endpoint

  1. Click Service List. Then choose Networking > VPC Endpoint.
  2. Click Create VPC Endpoint.
  3. Set the following parameters:

    • Region: Select the region that the Kafka instance is in.
    • Service Category: Select Find a service by name.
    • VPC Endpoint Service Name: Enter the VPC endpoint service name recorded in 8 and click Verify. If Service name found is displayed, proceed with subsequent operations.
    • VPC: Select the VPC that the Kafka instance is in.
    • Subnet: Select the subnet that the Kafka instance is in.
    • Private IP Address: Select Automatic.
    +

    Retain the default values for other parameters. For details, see Creating a VPC Endpoint.

    +

  4. Click Create Now.
  5. Confirm the configurations and submit the request.
  6. Go back to the VPC endpoint list and check whether the status of the created VPC endpoint has changed to Accepted. The Accepted state means that the VPC endpoint has been connected to the VPC endpoint service.

    Figure 6 Checking the VPC endpoint status
    +

  7. Click the VPC endpoint ID. On the Summary tab page, obtain the private IP address.

    You can use the private IP address to access the VPC endpoint service.

    +
    Figure 7 Viewing the private IP address
    +

  8. Repeat 1 to 7 to create a VPC endpoint for each VPC endpoint service created in 9, and view and record the private IP addresses of the VPC endpoint services.
+
+

Changing the advertised.listeners IP Address

  1. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  2. Click the desired Kafka instance to view the instance details.
  3. On the Advanced Settings section of the Basic Information tab page, click Modify for Cross-VPC Access to change the value of advertised.listeners IP address to the private IP addresses recorded in 7 and 8. Click Save.

    Each IP address must match the corresponding port ID. Otherwise, the network will be disconnected.

    +
    +
    Figure 8 Changing the advertised.listeners IP addresses
    +

+
+

Verifying Connectivity

Check whether messages can be created and retrieved by referring to Accessing a Kafka Instance Without SASL or Accessing a Kafka Instance with SASL.

+

Notes:

+ +

198.19.128.0/17 is the network segment allocated to the VPCEP service. To use VPCEP, allow access from this network segment.

+
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0002.html b/docs/dms/umn/kafka-ug-0002.html new file mode 100644 index 000000000..3dddf617b --- /dev/null +++ b/docs/dms/umn/kafka-ug-0002.html @@ -0,0 +1,29 @@ + + +

Granting Permissions to a SASL_SSL User

+

DMS supports ACL permission management for topics. You can differentiate the operations that different users are allowed to perform on a topic by granting the users different permissions.

+

This section describes how to grant topic permissions to a SASL_SSL user. For details about how to create a SASL_SSL user, see Creating a SASL_SSL User.

+

If no SASL_SSL user is granted any permission for a topic, all users can subscribe to or publish messages to the topic.

+

If one or more SASL_SSL users are granted permissions for a topic, only the authorized users can subscribe to or publish messages to the topic.

+

Prerequisites

+
+

Granting Permissions to a SASL_SSL User

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. In the navigation pane, choose the Topics tab.
  6. In the row that contains the topic for which you want to configure user permissions, click Grant User Permission.

    In the upper part of the Grant User Permission dialog box, the topic information is displayed, including the topic name, number of partitions, aging time, number of replicas, and whether synchronous flushing is enabled. In the middle part, you can use the search box to search for a user if there are many SASL_SSL users. In the Users area, the list of created SASL_SSL users is displayed. In the Selected area, you can grant permissions to the SASL_SSL users.

    +

  7. In the Users area of the Grant User Permission dialog box, select target users. In the Selected area, configure permissions (Subscribe, Publish, and Publish/Subscribe) for the users.

    Figure 1 Granting user permissions
    +

    As shown in Figure 1, only the test, send, and receive users can subscribe to or publish messages to topic-01. The send_receive user cannot subscribe to or publish messages to topic-01.

    +

  8. Click OK.

    On the Topics tab page, click next to the topic name to view the authorized users and their permissions.

    +
    Figure 2 Viewing authorized users and their permissions
    +

+
+

(Optional) Removing Permissions from a SASL_SSL User

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. In the navigation pane, choose the Topics tab.
  6. In the row that contains the topic for which you want to remove user permissions, click Grant User Permission.
  7. In the Selected area of the displayed Grant User Permission dialog box, locate the row that contains the SASL_SSL user whose permissions are to be removed, click Delete, and click OK.
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0003.html b/docs/dms/umn/kafka-ug-0003.html new file mode 100644 index 000000000..affec0b49 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0003.html @@ -0,0 +1,19 @@ + + +

Creating a SASL_SSL User

+

DMS supports ACL permission management for topics. You can differentiate the operations that different users are allowed to perform on a topic by granting the users different permissions.

+

This section describes how to create a SASL_SSL user after SASL_SSL is enabled for a Kafka instance. For details about how to grant user permissions, see Granting Permissions to a SASL_SSL User.

+

Prerequisites

SASL_SSL has been enabled when you create the Kafka instance.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. On the Users tab page, click Create User.
  6. In the displayed Create User dialog box, set the username and password, and click OK.

    After the SASL_SSL user is created, grant permissions to the user by referring to Granting Permissions to a SASL_SSL User.

    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0004.html b/docs/dms/umn/kafka-ug-0004.html new file mode 100644 index 000000000..17a6c9610 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0004.html @@ -0,0 +1,18 @@ + + +

Viewing Disk Usage

+

On the Kafka console, you can view the disk usage of each broker.

+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click a Kafka instance to go to the Basic Information tab page.
  5. Click the Disk Usage Statistics tab.

    Figure 1 Viewing disk usage
    +

    You can query topics that use the most disk space or topics that have used a specified amount or percentage of disk space.

    +

    In the upper right corner of the page, click View Metric. On the displayed Cloud Eye page, you can view metrics of Kafka instances.

    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0006.html b/docs/dms/umn/kafka-ug-0006.html new file mode 100644 index 000000000..e7d13e0a0 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0006.html @@ -0,0 +1,29 @@ + + +

Changing Partition Quantity

+

After creating a topic, you can increase the number of partitions based on service requirements.

+

Changing the number of partitions does not affect services.

+
+

Methods for changing the partition quantity:

+ +

Method 1: By Using the Console

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Click the Topics tab.
  6. Modify the number of partitions using either of the following methods:

    • Select one or more topics and click Edit Topic in the upper left corner.
    • In the row containing the desired topic, click Edit.
    +

  7. In the Edit Topic dialog box, enter the number of partitions and click OK.

    • The number of partitions can only be increased.
    • To ensure performance, the Kafka console allows a maximum of 100 partitions for each topic.
    • The total number of partitions of all topics cannot exceed the maximum number of partitions allowed by the instance.
    +
    +

+
+

Method 2: By Using Kafka CLI

If your Kafka client version is later than 2.2, you can use kafka-topics.sh to change the partition quantity.

+ +
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0007.html b/docs/dms/umn/kafka-ug-0007.html new file mode 100644 index 000000000..0d9d30b89 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0007.html @@ -0,0 +1,245 @@ + + +

Modifying Kafka Parameters

+

Scenario

Your Kafka instances, topics, and consumers come with default configuration parameter settings. You can modify common parameters on the DMS console. For details about parameters that are not listed on the console, see the Kafka official website.

+

Parameters of v1.1.0 instances are all static parameters. v2.3.0/2.7 instances have both dynamic and static parameters.

+ +

Configuration parameters of some old instances cannot be modified. Check whether your instance parameters can be modified on the console. If they cannot be modified, contact customer service.

+
+
+

Prerequisites

You can modify configuration parameters of a Kafka instance when the instance is in the Running state.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. On the Parameters tab page, click Edit in the row containing the parameter to modify. Table 1 describes the parameters of v1.1.0 instances. Table 2 and Table 3 describe the parameters of v2.3.0/2.7 instances.

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Static parameters (v1.1.0 instances)

    Parameter

    +

    Description

    +

    Value Range

    +

    Default Value

    +

    min.insync.replicas

    +

    If a producer sets the acks parameter to all (or -1), the min.insync.replicas parameter specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.

    +

    1–3

    +

    1

    +

    message.max.bytes

    +

    Maximum length of a single message, in bytes.

    +

    0–10,485,760

    +

    10,485,760

    +

    unclean.leader.election.enable

    +

    Indicates whether to allow replicas not in the ISR set to be elected as the leader as a last resort, even though doing so may result in data loss.

    +

    true or false

    +

    true

    +

    connections.max.idle.ms

    +

    Idle connection timeout (in ms). Connections that are idle for the duration specified by this parameter will be closed.

    +

    5000–600,000

    +

    600,000

    +

    log.retention.hours

    +

    Duration (in hours) for retaining a log file.

    +

    This parameter takes effect only for topics that have no aging time configured. If there is aging time configured for topics, it overrides this parameter.

    +

    1–168

    +

    72

    +

    max.connections.per.ip

    +

    The maximum number of connections allowed from each IP address. Request for new connections will be rejected once the limit is reached. The limit set using this parameter will be replaced if there are overrides configured using the max.connections.per.ip.overrides parameter.

    +

    100–20,000

    +

    1000

    +

    group.max.session.timeout.ms

    +

    The maximum session timeout (in ms) for consumers. A longer timeout gives consumers more time to process messages between heartbeats but results in a longer time to detect failures.

    +

    6000–1,800,000

    +

    1,800,000

    +

    default.replication.factor

    +

    The default number of replicas configured for an automatically created topic.

    +

    1–3

    +

    3

    +

    num.partitions

    +

    The default number of partitions configured for each automatically created topic.

    +

    1–100

    +

    3

    +

    group.min.session.timeout.ms

    +

    The minimum session timeout (in ms) for consumers. A shorter timeout enables quicker failure detection but results in more frequent consumer heartbeating, which can overwhelm broker resources.

    +

    6000–300,000

    +

    6000

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Dynamic parameters (v2.3.0/2.7 instances)

    Parameter

    +

    Description

    +

    Value Range

    +

    Default Value

    +

    min.insync.replicas

    +

    If a producer sets the acks parameter to all (or -1), the min.insync.replicas parameter specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.

    +

    1–3

    +

    1

    +

    message.max.bytes

    +

    Maximum length of a single message, in bytes.

    +

    0–10,485,760

    +

    10,485,760

    +

    unclean.leader.election.enable

    +

    Indicates whether to allow replicas not in the ISR set to be elected as the leader as a last resort, even though doing so may result in data loss.

    +

    true or false

    +

    true

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 Static parameters (v2.3.0/2.7 instances)

    Parameter

    +

    Description

    +

    Value Range

    +

    Default Value

    +

    connections.max.idle.ms

    +

    Idle connection timeout (in ms). Connections that are idle for the duration specified by this parameter will be closed.

    +

    5000–600,000

    +

    600,000

    +

    log.retention.hours

    +

    Duration (in hours) for retaining a log file.

    +

    This parameter takes effect only for topics that have no aging time configured. If there is aging time configured for topics, it overrides this parameter.

    +

    1–168

    +

    72

    +

    max.connections.per.ip

    +

    The maximum number of connections allowed from each IP address. Request for new connections will be rejected once the limit is reached. The limit set using this parameter will be replaced if there are overrides configured using the max.connections.per.ip.overrides parameter.

    +

    100–20,000

    +

    1000

    +

    group.max.session.timeout.ms

    +

    The maximum session timeout (in ms) for consumers. A longer timeout gives consumers more time to process messages between heartbeats but results in a longer time to detect failures.

    +

    6000–1,800,000

    +

    1,800,000

    +

    default.replication.factor

    +

    The default number of replicas configured for an automatically created topic.

    +

    1–3

    +

    3

    +

    num.partitions

    +

    The default number of partitions configured for each automatically created topic.

    +

    1–100

    +

    3

    +

    group.min.session.timeout.ms

    +

    The minimum session timeout (in ms) for consumers. A shorter timeout enables quicker failure detection but results in more frequent consumer heartbeating, which can overwhelm broker resources.

    +

    6000–300,000

    +

    6000

    +
    +
    +
    • To modify multiple dynamic or static parameters at a time, click Modify above the parameter list.
    • If you want to restore the default values, click Restore Default in the row containing the desired parameter.
    +
    +

  6. Click Save.

    Modifying dynamic parameters will not restart the instance. Static parameter modification requires manual restart of the instance.

    +
    +

+
+
+ diff --git a/docs/dms/umn/kafka-ug-0009.html b/docs/dms/umn/kafka-ug-0009.html new file mode 100644 index 000000000..f10e2323f --- /dev/null +++ b/docs/dms/umn/kafka-ug-0009.html @@ -0,0 +1,21 @@ + + + +

Managing Users

+ +

+
+ +
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0011.html b/docs/dms/umn/kafka-ug-0011.html new file mode 100644 index 000000000..057742bbb --- /dev/null +++ b/docs/dms/umn/kafka-ug-0011.html @@ -0,0 +1,21 @@ + + + +

Managing Consumer Groups

+ +

+
+ +
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0012.html b/docs/dms/umn/kafka-ug-0012.html new file mode 100644 index 000000000..2914fa65a --- /dev/null +++ b/docs/dms/umn/kafka-ug-0012.html @@ -0,0 +1,34 @@ + + +

Deleting a Consumer Group

+

You can delete a consumer group using either of the following methods:

+ +

Prerequisites

The status of the consumer group to be deleted is EMPTY.

+
+

Method 1: Deleting a Consumer Group on the Console

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. In the navigation pane, choose the Consumer Groups tab.
  6. Delete consumer groups using either of the following methods:

    • Select one or more consumer groups and click Delete Consumer Group above the consumer group list.
    • In the row containing the consumer group you want to delete, click Delete.
    +

    A consumer group can be deleted only when its status is EMPTY.

    +
    +

    Consumer group statuses include:

    +
    • DEAD: The consumer group has no member or metadata.
    • EMPTY: The consumer group has metadata but has no member.
    • PREPARING_REBALANCE: The consumer group is to be rebalanced.
    • COMPLETING_REBALANCE: All members have joined the consumer group.
    • STABLE: Members in the consumer group can consume messages normally.
    +

  7. In the displayed Delete Consumer Group dialog box, click Yes.
+
+

Method 2: Using the CLI to Delete a Consumer Group

The following uses Linux as an example.

+
  1. Download Kafka CLI v1.1.0, v2.7.2, or v2.3.0. Ensure that the Kafka instance and the CLI are of the same version.
  2. Use the CLI to connect to the Kafka instance. For details, see Accessing a Kafka Instance Without SASL or Accessing a Kafka Instance with SASL.
  3. In the /{directory where the CLI is located}/kafka_{version}/bin/ directory, run the following command to delete a consumer group:

    kafka-consumer-groups.sh --bootstrap-server {Kafka instance connection address} --delete --group {consumer group name}

    +
    [root@zk-server-1 bin]# ./kafka-consumer-groups.sh --bootstrap-server 192.168.1.245:9091,192.168.1.86:9091,192.168.1.128:9091 --delete --group bbbb
    +Note: This will not show information about old Zookeeper-based consumers.
    +Deletion of requested consumer groups ('bbbb') was successful.
    +

    If SASL authentication is enabled for the Kafka instance, the --command-config {consumer.properties file with SASL authentication} parameter must be added to the preceding commands. For details about the consumer.properties file, see Accessing a Kafka Instance with SASL.

    +
    +

+

+
+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0014.html b/docs/dms/umn/kafka-ug-0014.html new file mode 100644 index 000000000..916b6b9ca --- /dev/null +++ b/docs/dms/umn/kafka-ug-0014.html @@ -0,0 +1,50 @@ + + +

Resetting the Consumer Offset

+

Resetting the consumer offset is to change the retrieval position of a consumer.

+

Messages may be retrieved more than once after the offset is reset. Exercise caution when performing this operation.

+
+

Prerequisites

The consumer offset cannot be reset on the fly. You must first stop retrieval of the desired consumer group.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. In the navigation pane, choose the Consumer Groups tab.
  6. Click the name of the desired consumer group.
  7. On the Consumer Offset tab page, you can perform the following operations:

    • To reset the consumer offset of all partitions of a topic, click Reset Consumer Offset in the row containing the desired topic.
    • To reset the consumer offset of a single partition of a topic, click Reset Consumer Offset in the row containing the desired partition.
    +

  8. In the displayed Reset Consumer Offset dialog box, set the parameters by referring to Table 1.

    +

    + + + + + + + + + + + + + +
    Table 1 Parameters for resetting the consumer offset

    Parameter

    +

    Description

    +

    Reset By

    +

    You can reset an offset by:

    +
    • Time: Reset the offset to the specified time.
    • Offset: Reset the offset to the specified position.
    +

    Time

    +

    Set this parameter if Reset By is set to Time.

    +

    Select a time point. After the reset is complete, retrieval starts from this time point.

    +
    • Earliest: earliest offset
    • Custom Time Range: a custom time point
    • Latest: latest offset
    +

    Offset

    +

    Set this parameter if Reset By is set to Offset.

    +

    Enter an offset, which is greater than or equal to 0. After the reset is complete, retrieval starts from this offset.

    +
    +
    +

  9. Click OK.
  10. Click Yes in the confirmation dialog box. The consumer offset is reset.
+
+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0015.html b/docs/dms/umn/kafka-ug-0015.html new file mode 100644 index 000000000..dd56601a1 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0015.html @@ -0,0 +1,19 @@ + + +

Viewing Consumer Connection Addresses

+

View consumer connection addresses on the DMS console.

+

The connection address of a consumer can be viewed only when the consumer is connected to a Kafka instance.

+
+

Viewing Consumer Addresses on Console

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. In the navigation pane, choose Consumer Groups.
  6. Click the desired consumer group.
  7. On the Consumers tab page, view the consumer addresses.
+
+

+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0319001.html b/docs/dms/umn/kafka-ug-0319001.html new file mode 100644 index 000000000..e67676ff5 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0319001.html @@ -0,0 +1,64 @@ + + +

Configuring Public Access

+

To access a Kafka instance over a public network, enable public access and configure EIPs for the instance.

+

If you no longer need public access to the instance, you can disable it as required.

+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click a Kafka instance to go to the Basic Information tab page.
  5. Configure public access.

    • You can change the public access setting only when the Kafka instance is in the Running state.
    • Only IPv4 EIPs can be bound to Kafka instances.
    +
    +

    Enabling public access

    +

    Click next to Public Access to enable public access. For Elastic IP Address, select an EIP for each broker and then click .

    +

    You can view the operation progress on the Background Tasks page. If the task status is Successful, the modification has succeeded.

    +
    Figure 1 Configuring public access
    +

    After public access is enabled, configure security group rules listed in Table 1 before attempting to access Kafka. For details about accessing Kafka, see Accessing a Kafka Instance.

    + +
    + + + + + + + + + + + + + + + + + + + +
    Table 1 Security group rules

    Direction

    +

    Protocol

    +

    Port

    +

    Source

    +

    Description

    +

    Inbound

    +

    TCP

    +

    9094

    +

    0.0.0.0/0

    +

    Access Kafka through the public network (without SSL encryption).

    +

    Inbound

    +

    TCP

    +

    9095

    +

    0.0.0.0/0

    +

    Access Kafka through the public network (with SSL encryption).

    +
    +
    +

    Disabling public access

    +

    Click next to Public Access.

    +

    You can view the operation progress on the Background Tasks page. If the task status is Successful, the modification has succeeded.

    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0720001.html b/docs/dms/umn/kafka-ug-0720001.html new file mode 100644 index 000000000..94f4a896b --- /dev/null +++ b/docs/dms/umn/kafka-ug-0720001.html @@ -0,0 +1,27 @@ + + + +

Managing Topics

+ +

+
+ +
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0720002.html b/docs/dms/umn/kafka-ug-0720002.html new file mode 100644 index 000000000..7198c52e3 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0720002.html @@ -0,0 +1,15 @@ + + + +

Managing Messages

+ +

+
+ +
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0723001.html b/docs/dms/umn/kafka-ug-0723001.html new file mode 100644 index 000000000..67d5e797f --- /dev/null +++ b/docs/dms/umn/kafka-ug-0723001.html @@ -0,0 +1,30 @@ + + +

Service Overview

+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-0723004.html b/docs/dms/umn/kafka-ug-0723004.html new file mode 100644 index 000000000..3863de836 --- /dev/null +++ b/docs/dms/umn/kafka-ug-0723004.html @@ -0,0 +1,25 @@ + + + +

FAQs

+ +

+
+ +
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180413001.html b/docs/dms/umn/kafka-ug-180413001.html new file mode 100644 index 000000000..62b30b1e2 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180413001.html @@ -0,0 +1,13 @@ + + +

Monitoring

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180418001.html b/docs/dms/umn/kafka-ug-180418001.html new file mode 100644 index 000000000..a88902318 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180418001.html @@ -0,0 +1,13 @@ + + +

Auditing

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180418002.html b/docs/dms/umn/kafka-ug-180418002.html new file mode 100644 index 000000000..606839da4 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180418002.html @@ -0,0 +1,282 @@ + + +

Operations Logged by CTS

+

With Cloud Trace Service (CTS), you can record operations associated with DMS for later query, audit, and backtrack operations.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 DMS operations that can be recorded by CTS

Operation

+

Resource Type

+

Trace Name

+

Successfully deleting a background task

+

kafka

+

deleteDMSBackendJobSuccess

+

Failing to delete a background task

+

kafka

+

deleteDMSBackendJobFailure

+

Successfully creating an order for creating an instance

+

kafka

+

createDMSInstanceOrderSuccess

+

Failing to create an order for creating an instance

+

kafka

+

createDMSInstanceOrderFailure

+

Successfully submitting a request to modify an instance order

+

kafka

+

modifyDMSInstanceOrderSuccess

+

Failing to submit a request to modify an instance order

+

kafka

+

modifyDMSInstanceOrderFailure

+

Successfully submitting a request to scale up an instance

+

kafka

+

extendDMSInstanceSuccess

+

Failing to submit a request to scale up an instance

+

kafka

+

extendDMSInstanceFailure

+

Successfully submitting a request to reset instance password

+

kafka

+

resetDMSInstancePasswordSuccess

+

Failing to submit a request to reset instance password

+

kafka

+

resetDMSInstancePasswordFailure

+

Successfully creating a topic for a Kafka instance

+

kafka

+

Kafka_platinum_create_topicSuccess

+

Failing to create a topic for a Kafka instance

+

kafka

+

Kafka_platinum_create_topicFailure

+

Successfully deleting a topic from a Kafka instance

+

kafka

+

Kafka_platinum_delete_topicsSuccess

+

Failing to delete a topic for a Kafka instance

+

kafka

+

Kafka_platinum_delete_topicsFailure

+

Successfully deleting an instance that failed to be created

+

kafka

+

deleteDMSCreateFailureInstancesSuccess

+

Failing to delete an instance that failed to be created

+

kafka

+

deleteDMSCreateFailureInstancesFailure

+

Successfully submitting a request to restart an instance

+

kafka

+

restartDMSInstanceSuccess

+

Failing to submit a request to restart an instance

+

kafka

+

restartDMSInstanceFailure

+

Successfully submitting a request to delete multiple instances at a time

+

kafka

+

batchDeleteDMSInstanceSuccess

+

Failing to submit a request to delete multiple instances at a time

+

kafka

+

batchDeleteDMSInstanceFailure

+

Successfully submitting a request to restart multiple instances at a time

+

kafka

+

batchRestartDMSInstanceSuccess

+

Failing to submit a request to restart multiple instances at a time

+

kafka

+

batchRestartDMSInstanceFailure

+

Successfully submitting a request to modify instance information

+

kafka

+

modifyDMSInstanceInfoSuccess

+

Failing to submit a request to modify instance information

+

kafka

+

modifyDMSInstanceInfoFailure

+

Deleting multiple instance tasks at a time

+

kafka

+

batchDeleteDMSInstanceTask

+

Successfully deleting an instance

+

kafka

+

deleteDMSInstanceTaskSuccess

+

Failing to delete an instance

+

kafka

+

deleteDMSInstanceTaskFailure

+

Successfully creating an instance

+

kafka

+

createDMSInstanceTaskSuccess

+

Failing to create an instance

+

kafka

+

createDMSInstanceTaskFailure

+

Successfully scaling up an instance

+

kafka

+

extendDMSInstanceTaskSuccess

+

Failing to scale up an instance

+

kafka

+

extendDMSInstanceTaskFailure

+

Successfully restarting an instance

+

kafka

+

restartDMSInstanceTaskSuccess

+

Failing to restart an instance

+

kafka

+

restartDMSInstanceTaskFailure

+

Successfully restarting multiple instances at a time

+

kafka

+

batchRestartDMSInstanceTaskSuccess

+

Failing to restart multiple instances at a time

+

kafka

+

batchRestartDMSInstanceTaskFailure

+

Successfully modifying instance information

+

kafka

+

modifyDMSInstanceInfoTaskSuccess

+

Failing to modify instance information

+

kafka

+

modifyDMSInstanceInfoTaskFailure

+
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180418003.html b/docs/dms/umn/kafka-ug-180418003.html new file mode 100644 index 000000000..46d2a6d2f --- /dev/null +++ b/docs/dms/umn/kafka-ug-180418003.html @@ -0,0 +1,20 @@ + + +

Viewing Audit Logs

+

Scenario

This section describes how to view operation records of the last 7 days on the CTS console.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Management & Deployment > Cloud Trace Service.
  4. In the navigation pane, choose Trace List.
  5. Set filters to search for desired traces. The following filters are available:

    • Trace Source: Select DMS.
    • Resource Type: Select kafka or Instance.
    • Search By: Select an option from the drop-down list.
      • When you select Trace name, you also need to select a specific trace name.
      • If you select Resource ID for Search By, you need to enter a specific resource ID. The corresponding operation trace can be queried only when the resource ID is completely matched.
      • When you select Resource name, you also need to select a specific resource name.
      +
    • Operator: Select a specific operator (a user other than tenant).
    • Trace Status: Available options include All trace statuses, normal, warning, and incident. You can only select one of them.
    • Time Range: In the upper right corner, choose Last 1 hour, Last 1 day, or Last 1 week, or specify a custom time range. If you select Customize, you also need to select the start time and end time, and then click OK.
    +

  6. Click on the left of a trace to expand its details.

    Figure 1 Expanding trace details
    +

  7. Click View Trace in the Operation column. In the dialog box, the trace details are displayed, as shown in Figure 2.

    Figure 2 Viewing a trace
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180604011.html b/docs/dms/umn/kafka-ug-180604011.html new file mode 100644 index 000000000..6b0ed21de --- /dev/null +++ b/docs/dms/umn/kafka-ug-180604011.html @@ -0,0 +1,27 @@ + + +

Managing Instances

+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180604012.html b/docs/dms/umn/kafka-ug-180604012.html new file mode 100644 index 000000000..1e98d9290 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180604012.html @@ -0,0 +1,139 @@ + + +

Preparing Required Resources

+

Overview

Before creating a Kafka instance, ensure the availability of resources, including a virtual private cloud (VPC), subnet, security group, and security group rules. Each Kafka instance is deployed in a VPC and bound to a specific subnet and security group. In this way, Kafka provides an isolated virtual network environment and security protection policies that you can easily configure and manage.

+

To access a Kafka instance over a public network, prepare an elastic IP address (EIP) in advance.

+

To encrypt the disk, prepare a KMS key in advance.

+
+

Required Resources

Table 1 lists the resources required by a Kafka instance.

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Kafka resources

Resource

+

Requirement

+

Operations

+

VPC and subnet

+

Different Kafka instances can use the same or different VPCs and subnets based on site requirements. Note the following when creating a VPC and a subnet:

+
  • The VPC must be created in the same region as the Kafka instance.
  • Use the default settings when creating a VPC and subnet.
+

For details about how to create a VPC and subnet, see the Virtual Private Cloud User Guide.

+

Security group

+

Different Kafka instances can use the same or different security groups. Note the following when creating a security group:

+
  • To use Kafka instances, add the security group rules described in Table 2. Other rules can be added based on site requirements.
    NOTE:

    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 Kafka instance within a VPC, and do not need to add rules according to Table 2.

    +
    +
+

For details about how to create a security group and configure security group rules, see the Virtual Private Cloud User Guide.

+

EIP

+

Note the following when creating EIPs:

+
  • The EIPs must be created in the same region as the Kafka instance.
  • The number of EIPs must be the same as the number of Kafka instance brokers.
+

For details about how to create an EIP, see "Assigning an EIP" in Elastic IP User Guide.

+

KMS key

+

To encrypt the disk for a Kafka instance, prepare a KMS key in advance.

+

The KMS key must be created in the same region as the Kafka instance.

+

For details about how to create a KMS key, see "Creating a Key" in the Key Management Service User Guide.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Security group rules

Direction

+

Protocol

+

Port

+

Source

+

Description

+

Inbound

+

TCP

+

9094

+

0.0.0.0/0

+

Access a Kafka instance through the public network (without SSL encryption).

+

Inbound

+

TCP

+

9092

+

0.0.0.0/0

+

Access a Kafka instance within a VPC (without SSL encryption).

+

Inbound

+

TCP

+

9095

+

0.0.0.0/0

+

Access a Kafka instance through the public network (with SSL encryption).

+

Inbound

+

TCP

+

9093

+

0.0.0.0/0

+

Access a Kafka instance within a VPC (with SSL encryption).

+

Inbound

+

TCP

+

9011

+

198.19.128.0/17

+

Access a Kafka instance using VPC Endpoint (VPCEP).

+

Inbound

+

TCP

+

9011

+

0.0.0.0/0

+

Access a Kafka instance using DNAT.

+
+
+
+
+ diff --git a/docs/dms/umn/kafka-ug-180604014.html b/docs/dms/umn/kafka-ug-180604014.html new file mode 100644 index 000000000..7e13f30ce --- /dev/null +++ b/docs/dms/umn/kafka-ug-180604014.html @@ -0,0 +1,82 @@ + + +

Viewing an Instance

+

Scenario

View detailed information about a Kafka instance on the DMS console, for example, the IP addresses and port numbers for accessing the instance.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Search for a Kafka instance by tag, status, name, ID, or connection address. Table 1 describes the various possible statuses of a Kafka instance.

    +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Kafka instance status description

    Status

    +

    Description

    +

    Creating

    +

    The instance is being created.

    +

    Running

    +

    The instance is running properly.

    +

    Only instances in the Running state can provide services.

    +

    Faulty

    +

    The instance is not running properly.

    +

    Starting

    +

    The status between Frozen and Running.

    +

    Restarting

    +

    The instance is being restarted.

    +

    Changing

    +

    The instance specifications or public access configurations are being modified.

    +

    Change failed

    +

    The instance specifications or public access configurations failed to be modified.

    +

    Frozen

    +

    The instance is frozen.

    +

    Freezing

    +

    The status between Running and Frozen.

    +

    Upgrading

    +

    The instance is being upgraded.

    +

    Rolling back

    +

    The instance is being rolled back.

    +
    +
    +

  5. Click the name of the desired Kafka instance and view detailed information about the instance on the Basic Information tab page.
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180604015.html b/docs/dms/umn/kafka-ug-180604015.html new file mode 100644 index 000000000..20640e211 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180604015.html @@ -0,0 +1,24 @@ + + +

Restarting an Instance

+

Scenario

Restart one or more Kafka instances at a time on the DMS console.

+

When a Kafka instance is being restarted, message retrieval and creation requests of clients will be rejected.

+
+
+

Prerequisites

The status of the Kafka instance you want to restart is either Running or Faulty.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Restart Kafka instances using one of the following methods:

    • Select one or more Kafka instances and click Restart in the upper left corner.
    • In the row containing the desired instance, click Restart.
    +

  5. In the Restart Instance dialog box, click Yes to restart the Kafka instance.

    It takes 3 to 15 minutes to restart a Kafka instance. After the instance is successfully restarted, its status should be Running.

    +

    Restarting a Kafka instance only restarts the instance process and does not restart the VM where the instance is located.

    +
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180604016.html b/docs/dms/umn/kafka-ug-180604016.html new file mode 100644 index 000000000..714959830 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180604016.html @@ -0,0 +1,31 @@ + + +

Deleting an Instance

+

Scenario

On the DMS console, you can delete one or more Kafka instances that have been created or failed to be created.

+

Deleting a Kafka instance will delete the data in the instance without any backup. Exercise caution when performing this operation.

+
+
+

Prerequisites

The status of the Kafka instance you want to delete is Running or Faulty.

+
+

Deleting Kafka Instances

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Delete Kafka instances using one of the following methods:

    • Select one or more Kafka instances and click Delete in the upper left corner.
    • In the row containing the Kafka instance to be deleted, choose More > Delete.
    +

    Kafka instances in the Creating, Starting, Changing, Change failed, or Restarting state cannot be deleted.

    +
    +

  5. In the Delete Instance dialog box, click Yes to delete the Kafka instance.

    It takes 1 to 60 seconds to delete a Kafka instance.

    +

+
+

Deleting Kafka Instances That Failed to Be Created

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. If there are Kafka instances that failed to be created, Instance Creation Failures and quantity information will be displayed.

    Instances that fail to be created do not occupy other resources.

    +
    +

  5. Click Instance Creation Failures or the icon or quantity next to it.
  6. Delete Kafka instances that failed to be created in either of the following ways:

    • To delete all Kafka instances that failed to be created at once, click Clear Failed Instance.
    • To delete a single Kafka instance that failed to be created, click Delete in the row containing the chosen Kafka instance.
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180604017.html b/docs/dms/umn/kafka-ug-180604017.html new file mode 100644 index 000000000..fe0359a09 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180604017.html @@ -0,0 +1,18 @@ + + +

Modifying the Information About an Instance

+

After creating a Kafka instance, you can modify some parameters of the instance based on service requirements, including the instance name, description, security group, and capacity threshold policy.

+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Modify the following parameters if needed:

    • Instance Name
    • Description
    • Security Group
    • Public Access (For details about how to change the public access configuration, see Configuring Public Access.)
    • Capacity Threshold Policy (Modifying this setting will not restart the instance.)
    • Automatic Topic Creation (Modifying this setting will restart the instance.)
    +

    After the parameters are modified, view the modification result in one of the following ways:

    +
    • If Capacity Threshold Policy, Public Access, or Automatic Topic Creation has been modified, you will be redirected to the Background Tasks page, which displays the modification progress and result.
    • If Instance Name, Description, or Security Group has been modified, the modification result will be displayed on the upper right corner of the page.
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180604019.html b/docs/dms/umn/kafka-ug-180604019.html new file mode 100644 index 000000000..75800fc96 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180604019.html @@ -0,0 +1,26 @@ + + +

Deleting a Topic

+

Delete a topic using either of the following methods:

+ +

Prerequisites

+
+

Deleting a Topic on the Console

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Click the Topics tab.
  6. Delete topics using either of the following methods:

    • Select one or more topics and click Delete Topic in the upper left corner.
    • In the row containing the topic you want to delete, click Delete.
    +

  7. In the Delete Topic dialog box that is displayed, click Yes to delete the topic.
+
+

Deleting a Topic with the Kafka CLI

If your Kafka client version is later than 2.2, you can use kafka-topics.sh to delete topics.

+ +
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180604020.html b/docs/dms/umn/kafka-ug-180604020.html new file mode 100644 index 000000000..f94200c3e --- /dev/null +++ b/docs/dms/umn/kafka-ug-180604020.html @@ -0,0 +1,54 @@ + + +

Accessing a Kafka Instance Without SASL

+

This section describes how to use an open-source Kafka client to access a Kafka instance if SASL access is not enabled for the instance. There are two scenarios. For cross-VPC access, see Cross-VPC Access to a Kafka Instance. For DNAT-based access, see Using DNAT to Access a Kafka Instance.

+

For details on how to use Kafka clients in different languages, visit https://cwiki.apache.org/confluence/display/KAFKA/Clients.

+
  • The following describes the procedure for accessing a Kafka instance using CLI. To access an instance in your service code, see the Distributed Message Service Developer Guide.
  • Each Kafka broker allows a maximum of 1000 connections from each IP address by default. Excess connections will be rejected. You can change the limit by referring to Modifying Kafka Parameters.
+
+

Prerequisites

+
+

Accessing the Instance Using CLI

The following uses Linux as an example.

+
  1. Decompress the Kafka CLI package.

    Access the directory where the CLI package is stored and run the following command to decompress the package:

    +

    tar -zxf [kafka_tar]

    +

    In the preceding command, [kafka_tar] indicates the name of the CLI package.

    +

    For example:

    +

    tar -zxf kafka_2.12-2.7.2.tgz

    +

  2. Access the /bin directory of the Kafka CLI.

    In Windows, you need to access the /bin/windows directory.

    +

  3. Run the following command to create messages:

    ./kafka-console-producer.sh --broker-list ${connection-address} --topic ${topic-name}
    +

    Parameter description:

    +
    • {connection-address}: the address obtained in Prerequisites. For public access, use Instance Address (Public Network). For intra-VPC access, use Instance Address (Private Network).
    • {topic-name}: the name of the topic created for the Kafka instance. If automatic topic creation has enabled for the Kafka instance, set this parameter to the name of a created topic or a topic that has not been created.
    +

    The following example uses connection addresses 10.3.196.45:9094,10.78.42.127:9094,10.4.49.103:9094. After running the preceding command, you can send a message to the Kafka instance by writing it and pressing Enter. Each line of content is sent as a message.

    +
    [root@ecs-kafka bin]# ./kafka-console-producer.sh --broker-list 10.3.196.45:9094,10.78.42.127:9094,10.4.49.103:9094  --topic topic-demo
    +>Hello
    +>DMS
    +>Kafka!
    +>^C[root@ecs-kafka bin]# 
    +

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

    +

  4. Run the following command to retrieve messages:

    ./kafka-console-consumer.sh --bootstrap-server ${connection-address} --topic ${topic-name} --group ${consumer-group-name} --from-beginning
    +

    Parameter description:

    +
    • {connection-address}: the address obtained in Prerequisites. For public access, use Instance Address (Public Network). For intra-VPC access, use Instance Address (Private Network).
    • {topic-name}: the name of the topic created for the Kafka instance
    • {consumer-group-name}: the consumer group name set based on your service requirements. If a consumer group name has been specified in the configuration file, ensure that you use the same name in the command line. Otherwise, consumption may fail. If a consumer group name starts with a special character, such as an underscore (_) or a number sign (#), the monitoring data cannot be displayed.
    +

    Example:

    +
    [root@ecs-kafka bin]#  ./kafka-console-consumer.sh --bootstrap-server 10.3.196.45:9094,10.78.42.127:9094,10.4.49.103:9094 --topic topic-demo --group order-test --from-beginning
    +Kafka!
    +DMS
    +Hello
    +^CProcessed a total of 3 messages
    +[root@ecs-kafka bin]# 
    +

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

    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180718001.html b/docs/dms/umn/kafka-ug-180718001.html new file mode 100644 index 000000000..ccf041408 --- /dev/null +++ b/docs/dms/umn/kafka-ug-180718001.html @@ -0,0 +1,22 @@ + + +

Resetting Kafka Password

+

Scenario

You can reset the SASL_SSL password for accessing a Kafka instance by resetting Kafka password if you forget it.

+
  • You can reset the Kafka password only if Kafka SASL_SSL has been enabled for the instance.
  • You can reset the Kafka password only when the instance is in the Running state.
+
+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Reset the Kafka instance password using either of the following methods:

    • Choose More > Reset Kafka Password in the row containing the desired Kafka instance.
    • Click the desired Kafka instance to view its details. On the Basic Information tab page, click Reset Password next to Username in the Connection section.
    • Click the desired Kafka instance to view its details. On the Users tab page, click Reset Password in the row containing the desired user.
    +

  5. In the Reset Kafka Password dialog box, enter and confirm a new password, and click OK.

    • If the password is successfully reset, a success message is displayed.
    • If the password fails to be reset, a failure message is displayed. Reset the password again. If you still fail to reset the password after multiple attempts, contact customer service.
    +

    The system will display a success message only after the password is successfully reset on all brokers.

    +
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-180801001.html b/docs/dms/umn/kafka-ug-180801001.html new file mode 100644 index 000000000..133c6543d --- /dev/null +++ b/docs/dms/umn/kafka-ug-180801001.html @@ -0,0 +1,74 @@ + + +

Accessing a Kafka Instance with SASL

+

If you enable SASL_SSL when creating an instance, data will be encrypted before transmission for enhanced security.

+

For security purposes, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 is supported.

+

This section describes how to use an open-source Kafka client to access a Kafka instance if SASL has been enabled for the instance. There are two scenarios. For cross-VPC access, see Cross-VPC Access to a Kafka Instance. For DNAT-based access, see Using DNAT to Access a Kafka Instance.

+

Each Kafka broker allows a maximum of 1000 connections from each IP address by default. Excess connections will be rejected. You can change the limit by referring to Modifying Kafka Parameters.

+
+

Prerequisites

+
+

Accessing the Instance Using CLI

The following uses Linux as an example.

+
  1. Map hosts to IP addresses in the /etc/hosts file on the host where the client is located, so that the client can quickly parse the instance brokers.

    Set IP addresses to the instance connection addresses obtained in Prerequisites. Set hosts to the names of instance hosts. Specify a unique name for each host.

    +

    For example:

    +

    10.154.48.120 server01

    +

    10.154.48.121 server02

    +

    10.154.48.122 server03

    +

  2. Decompress the Kafka CLI package.

    Access the directory where the CLI package is stored and run the following command to decompress the package:

    +

    tar -zxf [kafka_tar]

    +

    In the preceding command, [kafka_tar] indicates the name of the CLI package.

    +

    For example:

    +

    tar -zxf kafka_2.12-2.7.2.tgz

    +

  3. Modify the configuration file of the Kafka CLI.

    Find the consumer.properties and producer.properties files in the /config directory of the Kafka CLI and add the following content to the files:

    +
    sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required \
    +username="**********" \
    +password="**********";        
    +sasl.mechanism=PLAIN
    +
    +security.protocol=SASL_SSL
    +ssl.truststore.location={ssl_truststore_path}
    +ssl.truststore.password=dms@kafka
    +ssl.endpoint.identification.algorithm=
    +

    Parameter description:

    +
    • username and password: username and password you set when enabling SASL_SSL during Kafka instance creation or when creating a SASL_SSL user.
    • ssl.truststore.location: path for storing the client.truststore.jks certificate. Even in Windows, you need to use slashes (/) for the certificate path. Do not use backslashes (\), which are used by default for paths in Windows. Otherwise, the client will fail to obtain the certificate.
    • ssl.truststore.password: server certificate password, which must be set to dms@kafka and cannot be changed.
    • ssl.endpoint.identification.algorithm: whether to verify the certificate domain name. This parameter must be left blank, which indicates disabling domain name verification.
    +

  4. Access the /bin directory of the Kafka CLI.

    In Windows, you need to access the /bin/windows directory.

    +

  5. Run the following command to create messages:

    ./kafka-console-producer.sh --broker-list ${connection-address} --topic ${topic-name} --producer.config ../config/producer.properties
    +

    Parameter description:

    +
    • {connection-address}: the address obtained in Prerequisites. For public access, use Instance Address (Public Network). For intra-VPC access, use Instance Address (Private Network).
    • {topic-name}: the name of the topic created for the Kafka instance If automatic topic creation has enabled for the Kafka instance, set this parameter to the name of a created topic or a topic that has not been created.
    +

    The following example uses connection addresses 10.3.196.45:9095,10.78.42.127:9095,10.4.49.103:9095.

    +

    After running the preceding command, you can send a message to the Kafka instance by writing it and pressing Enter. Each line of content is sent as a message.

    +
    [root@ecs-kafka bin]#./kafka-console-producer.sh --broker-list 10.3.196.45:9095,10.78.42.127:9095,10.4.49.103:9095  --topic topic-demo --producer.config ../config/producer.properties
    +>Hello
    +>DMS
    +>Kafka!
    +>^C[root@ecs-kafka bin]# 
    +

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

    +

  6. Run the following command to retrieve messages:

    ./kafka-console-consumer.sh --bootstrap-server ${connection-address} --topic ${topic-name} --group ${consumer-group-name} --from-beginning  --consumer.config ../config/consumer.properties
    +

    Parameter description:

    +
    • {connection-address}: the address obtained in Prerequisites. For public access, use Instance Address (Public Network). For intra-VPC access, use Instance Address (Private Network).
    • {topic-name}: the name of the topic created for the Kafka instance
    • {consumer-group-name}: the consumer group name set based on your service requirements. If a consumer group name has been specified in the configuration file, ensure that you use the same name in the command line. Otherwise, consumption may fail. If a consumer group name starts with a special character, such as an underscore (_) or a number sign (#), the monitoring data cannot be displayed.
    +

    Example:

    +
    [root@ecs-kafka bin]#  ./kafka-console-consumer.sh --bootstrap-server 10.3.196.45:9095,10.78.42.127:9095,10.4.49.103:9095 --topic topic-demo --group order-test --from-beginning --consumer.config ../config/consumer.properties
    +Hello
    +DMS
    +Kafka!
    +^CProcessed a total of 3 messages
    +[root@ecs-kafka bin]# 
    +

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

    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-190605001.html b/docs/dms/umn/kafka-ug-190605001.html new file mode 100644 index 000000000..fc6b7bc37 --- /dev/null +++ b/docs/dms/umn/kafka-ug-190605001.html @@ -0,0 +1,19 @@ + + +

Viewing Metrics

+

Scenario

Cloud Eye monitors Kafka instance metrics in real time. You can view these metrics on the Cloud Eye console.

+
+

Prerequisites

At least one Kafka instance has been created. The instance has at least one available message.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. View the instance metrics using either of the following methods:

    • Click next to a Kafka instance name. On the Cloud Eye console, view the metrics of the instance, nodes, topics, and consumer groups. Metric data is reported to Cloud Eye every minute.
    • Click the desired Kafka instance to view its details. In the navigation pane, choose Monitoring view. On the displayed page, view the metrics of the instance, nodes, topics, and consumer groups. Metric data is reported to Cloud Eye every minute.
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-190904001.html b/docs/dms/umn/kafka-ug-190904001.html new file mode 100644 index 000000000..303f21039 --- /dev/null +++ b/docs/dms/umn/kafka-ug-190904001.html @@ -0,0 +1,23 @@ + + +

Querying Messages

+

Scenario

You can view the offset of different partitions, the message size, creation time, and body of messages in topics.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Click the Message Query tab. Then specify the topic name, partition, and the search method.

    If no partition is specified, messages in all partitions of the topic are displayed.

    +

    You can search by the following methods:

    +
    • Creation time: Search by the time that messages are created.
    • Offset: Search by the message position.
    +

    If a topic contains a large amount of data, an internal service error may be reported when you query messages in a topic with only one replica. You can shorten the time range for query based on the data volume.

    +
    +

  6. Click Search to query messages.

    Parameter description:

    +
    • Topic Name: name of the topic where the message is located
    • Partition: partition where the message is located
    • Offset: position of the message in the partition
    • Message Size (Byte) size of the message
    • Created: time when the message is created. The message creation time is specified by CreateTime when a producer creates messages. If this parameter is not set during message creation, the message creation time is year 1970 by default.
    +

  7. Click View Message Body. In the displayed View Message Body dialog box, view the message content, including the topic name, partition, offset, creation time, and message body.
  8. (Optional) To restore the default settings, click Reset.
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-200119002.html b/docs/dms/umn/kafka-ug-200119002.html new file mode 100644 index 000000000..a0864a677 --- /dev/null +++ b/docs/dms/umn/kafka-ug-200119002.html @@ -0,0 +1,20 @@ + + +

Viewing Background Tasks

+

After you initiate certain instance operations such as configuring public access and modifying the capacity threshold policy, a background task will start for each operation. On the console, you can view the background task status and clear task information by deleting task records.

+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click a Kafka instance to go to the Basic Information tab page.
  5. Click the Background Tasks tab.

    A list of background tasks is displayed.

    +

  6. In the upper right corner, click the time period next to the calendar icon, select the start time and end time, and click OK. Tasks started in the specified period are displayed.

    On the Background Tasks page, you can also perform the following operations:
    • Click to refresh the task status.
    • Click Delete. In the displayed Delete Task dialog box, click Yes to clear the task information.

      You can only delete the records of tasks in the Successful or Failed state.

      +
      +
    +
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug-200506001.html b/docs/dms/umn/kafka-ug-200506001.html new file mode 100644 index 000000000..d5bf6aeaf --- /dev/null +++ b/docs/dms/umn/kafka-ug-200506001.html @@ -0,0 +1,21 @@ + + +

Modifying Topic Aging Time

+

Aging time is a period that messages in the topic are retained for. Consumers must retrieve messages before this period ends. Otherwise, the messages will be deleted and can no longer be retrieved.

+

After creating a topic, you can change its aging time based on service requirements. Changing the aging time does not affect services. The default aging time is 72 hours.

+

You can change the aging time in either of the following ways:

+ +

The log.retention.hours parameter takes effect only for topics that have no aging time configured. If there is aging time configured for a topic, it overrides the log.retention.hours parameter. For example, if the aging time of Topic01 is set to 60 hours and log.retention.hours is set to 72 hours, the actual aging time of Topic01 is 60 hours.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Click the Topics tab.
  6. Modify the topic aging time using either of the following methods:

    • Select one or more topics and click Edit Topic in the upper left corner.
    • In the row containing the desired topic, click Edit.
    +

  7. In the Edit Topic dialog box, enter the aging time and click OK.
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka-ug190605003.html b/docs/dms/umn/kafka-ug190605003.html new file mode 100644 index 000000000..877a56d4a --- /dev/null +++ b/docs/dms/umn/kafka-ug190605003.html @@ -0,0 +1,18 @@ + + +

Accessing a Kafka Instance

+

+
+
+ +
+ diff --git a/docs/dms/umn/kafka_faq_0046.html b/docs/dms/umn/kafka_faq_0046.html new file mode 100644 index 000000000..db3bc8012 --- /dev/null +++ b/docs/dms/umn/kafka_faq_0046.html @@ -0,0 +1,11 @@ + + +

How Do I Bind an EIP Again?

+

On the DMS console, click the name of the target Kafka instance. Disable Public Access in the Connection section on the Basic Information tab page, and then enable it again. Select the EIP to be bound.

+
+
+ +
+ diff --git a/docs/dms/umn/kafka_ug_0021.html b/docs/dms/umn/kafka_ug_0021.html new file mode 100644 index 000000000..09bf4b7de --- /dev/null +++ b/docs/dms/umn/kafka_ug_0021.html @@ -0,0 +1,47 @@ + + +

Querying Consumer Group Details

+

View the consumer group list, consumer list, and consumer offsets.

+

Prerequisites

The consumer list can be viewed only when consumers in a consumer group are connected to the Kafka instance (that is, the consumer group is in the STABLE state).

+
+

Viewing the Consumer Group List (Console)

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view its details.
  5. In the navigation pane, choose the Consumer Groups tab.

    The consumer group name, status, and Coordinator are displayed. Coordinator indicates the broker where the coordinator component is located. The consumer group status can be:

    +
    • DEAD: The consumer group has no member or metadata.
    • EMPTY: The consumer group has metadata but has no member.
    • PREPARING_REBALANCE: The consumer group is to be rebalanced.
    • COMPLETING_REBALANCE: All members have joined the consumer group.
    • STABLE: Members in the consumer group can consume messages normally.
    +

  6. (Optional) To query a specific consumer group, enter the consumer group name in the search box and click .
  7. (Optional) To refresh the consumer group list, click in the upper right corner.
+
+

Viewing the Consumer Group List (Kafka CLI)

+
+

Viewing the Consumer List (Console)

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view its details.
  5. In the navigation pane, choose the Consumer Groups tab.
  6. Click the name of the desired consumer group.
  7. On the Consumers tab page, view the consumer list.

    In the consumer list, you can view the consumer ID, consumer address, and client ID.

    +

  8. (Optional) To query a specific consumer, enter the consumer ID in the search box and click .
+

+
+

Viewing the Consumer List (Kafka CLI)

+
+

Viewing Consumer Offsets (Console)

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view its details.
  5. In the navigation pane, choose the Consumer Groups tab.
  6. Click the name of the desired consumer group.
  7. On the Consumer Offset tab page, view the list of topics that the consumer group has subscribed to, total number of messages accumulated in the topic, number of messages accumulated in each partition of the topic, offset of each partition, and latest offset.
  8. (Optional) To query the consumer offsets of a specific topic, enter the topic name in the search box and click .
+
+

Viewing Consumer Offsets (Kafka CLI)

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka_ug_0022.html b/docs/dms/umn/kafka_ug_0022.html new file mode 100644 index 000000000..2c7851a24 --- /dev/null +++ b/docs/dms/umn/kafka_ug_0022.html @@ -0,0 +1,22 @@ + + +

Modifying Synchronous Replication and Flushing Settings

+

Synchronous replication: A message is returned to the client only after the message creation request has been received and the message has been acknowledged by all replicas.

+

Synchronous flushing: A message is immediately flushed to disk once created.

+ +

The following procedure describes how to modify synchronous replication and synchronous flushing settings on the console.

+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Click the Topics tab.
  6. Use either of the following methods to modify synchronous replication and synchronous flushing settings:

    • Select one or more topics and click Edit Topic above the topic list.
    • In the row that contains the topic whose synchronous replication and flushing settings are to be modified, click Edit.
    +

  7. In the Edit Topic dialog box, enable or disable synchronous replication and synchronous flushing, and click OK.

    • To enable them, click .
    • To disable them, click .
    +
    • If there is only one replica, synchronous replication cannot be enabled.
    • After enabling synchronous replication, set acks to all or –1 on the client. Otherwise, this function will not take effect.
    +
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka_ug_0024.html b/docs/dms/umn/kafka_ug_0024.html new file mode 100644 index 000000000..2902869ef --- /dev/null +++ b/docs/dms/umn/kafka_ug_0024.html @@ -0,0 +1,16 @@ + + +

Viewing Sample Code

+

On the console, view sample code for creating and retrieving messages in Java, Go, and Python.

+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Click the Topics tab.
  6. Click View Sample Code. The Sample Code dialog box is displayed.

    View sample code for creating and retrieving messages in Java, Go, and Python. In the sample code in Go and Python, you can see whether SASL_SSL authentication is enabled. If Access By is PLAINTEXT, SASL_SSL authentication is disabled. If Access By is SASL_SSL, SASL_SSL authentication is enabled.

    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka_ug_0025.html b/docs/dms/umn/kafka_ug_0025.html new file mode 100644 index 000000000..d0a2bd448 --- /dev/null +++ b/docs/dms/umn/kafka_ug_0025.html @@ -0,0 +1,22 @@ + + +

Resetting the SASL_SSL Password

+

Scenario

If you forget the password of a SASL_SSL user created on the Users tab page, you can reset the password and use the new password to connect to the Kafka instance.

+

If you forget the SASL_SSL password set during instance creation, reset the password by following the instructions provided in Resetting Kafka Password.

+
  • You can reset the SASL_SSL password only if Kafka SASL_SSL has been enabled for the instance.
  • You can reset the SASL_SSL password only when the instance is in the Running state.
+
+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the name of the desired Kafka instance.
  5. On the Users tab page, click Reset Password in the row containing the desired user.
  6. Enter and confirm a new password, and click OK.

    • If the password is successfully reset, a success message is displayed.
    • If the password fails to be reset, a failure message is displayed. In this case, reset the password again. If you still fail to reset the password after multiple attempts, contact customer service.
    +

    The system will display a success message only after the password is successfully reset on all brokers.

    +
    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka_ug_0026.html b/docs/dms/umn/kafka_ug_0026.html new file mode 100644 index 000000000..1046c6288 --- /dev/null +++ b/docs/dms/umn/kafka_ug_0026.html @@ -0,0 +1,18 @@ + + +

Deleting a SASL_SSL User

+

This section describes how to delete a SASL_SSL user.

+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view its details.
  5. Delete a SASL_SSL user using either of the following methods:

    • On the Users tab page, click Delete in the row that contains the SASL_SSL user to be deleted.
    • On the Users tab page, select one or more SASL_SSL users and click Delete above the list.
    +

    The SASL_SSL user configured during the creation of a Kafka instance cannot be deleted.

    +
    +

  6. In the displayed Delete User dialog box, click Yes to delete the SASL_SSL user.
+
+
+
+ +
+ diff --git a/docs/dms/umn/kafka_ug_0027.html b/docs/dms/umn/kafka_ug_0027.html new file mode 100644 index 000000000..4f049a950 --- /dev/null +++ b/docs/dms/umn/kafka_ug_0027.html @@ -0,0 +1,18 @@ + + +

Exporting Topics

+

Export topics on the console. Batch export is supported.

+

Prerequisites

A topic has been created.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner to select a region.

    Select the region where your Kafka instance is located.

    +
    +

  3. Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
  4. Click the desired Kafka instance to view the instance details.
  5. Click the Topics tab.
  6. Select one or more topics and click in the upper right corner to export the topic list.

    The topic list contains the following information: topic name, number of partitions, number of replicas, aging time, and whether synchronous replication and flushing are enabled.

    +

+
+
+
+ +
+ diff --git a/docs/dms/umn/public_sys-resources/ExpandCollapse.js b/docs/dms/umn/public_sys-resources/ExpandCollapse.js new file mode 100644 index 000000000..116ddaabf --- /dev/null +++ b/docs/dms/umn/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}}; \ No newline at end of file diff --git a/docs/dms/umn/public_sys-resources/caution_3.0-en-us.png b/docs/dms/umn/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 000000000..60f607621 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/dms/umn/public_sys-resources/commonltr.css b/docs/dms/umn/public_sys-resources/commonltr.css new file mode 100644 index 000000000..c5480b0ab --- /dev/null +++ b/docs/dms/umn/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/dms/umn/public_sys-resources/commonltr_print.css b/docs/dms/umn/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/dms/umn/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/dms/umn/public_sys-resources/commonrtl.css b/docs/dms/umn/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..f261da752 --- /dev/null +++ b/docs/dms/umn/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/dms/umn/public_sys-resources/danger_3.0-en-us.png b/docs/dms/umn/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 000000000..47a9c7235 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/dms/umn/public_sys-resources/delta.gif b/docs/dms/umn/public_sys-resources/delta.gif new file mode 100644 index 000000000..0d1b1f674 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/delta.gif differ diff --git a/docs/dms/umn/public_sys-resources/deltaend.gif b/docs/dms/umn/public_sys-resources/deltaend.gif new file mode 100644 index 000000000..cc7da0fc8 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/deltaend.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-arrowdn.gif b/docs/dms/umn/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 000000000..379428032 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-arrowrt.gif b/docs/dms/umn/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 000000000..6aaaa11c2 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-caution.gif b/docs/dms/umn/public_sys-resources/icon-caution.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-caution.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-danger.gif b/docs/dms/umn/public_sys-resources/icon-danger.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-danger.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-huawei.gif b/docs/dms/umn/public_sys-resources/icon-huawei.gif new file mode 100644 index 000000000..a31d60f89 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-huawei.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-note.gif b/docs/dms/umn/public_sys-resources/icon-note.gif new file mode 100644 index 000000000..31be2b039 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-note.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-notice.gif b/docs/dms/umn/public_sys-resources/icon-notice.gif new file mode 100644 index 000000000..409070650 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-notice.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-tip.gif b/docs/dms/umn/public_sys-resources/icon-tip.gif new file mode 100644 index 000000000..c47bae05c Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-tip.gif differ diff --git a/docs/dms/umn/public_sys-resources/icon-warning.gif b/docs/dms/umn/public_sys-resources/icon-warning.gif new file mode 100644 index 000000000..079c79b26 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/icon-warning.gif differ diff --git a/docs/dms/umn/public_sys-resources/note_3.0-en-us.png b/docs/dms/umn/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 000000000..57a0e1f53 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/dms/umn/public_sys-resources/notice_3.0-en-us.png b/docs/dms/umn/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 000000000..fa4b64990 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/dms/umn/public_sys-resources/popup.js b/docs/dms/umn/public_sys-resources/popup.js new file mode 100644 index 000000000..a550862ed --- /dev/null +++ b/docs/dms/umn/public_sys-resources/popup.js @@ -0,0 +1 @@ +var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(da){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/dms/umn/public_sys-resources/warning_3.0-en-us.png b/docs/dms/umn/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 000000000..def5c3565 Binary files /dev/null and b/docs/dms/umn/public_sys-resources/warning_3.0-en-us.png differ