DMS UMN Initial Version

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

docs/dms/umn/PARAMETERS.txt

@@ -0,0 +1,3 @@
+version=""
+language="en-us"
+type=""

docs/dms/umn/TagManagement.html

@@ -0,0 +1,44 @@
+<a name="TagManagement"></a><a name="TagManagement"></a>
+
+<h1 class="topictitle1">Managing Instance Tags</h1>
+<div id="body1577263534920"><p id="TagManagement__p16892119416">Tags facilitate Kafka instance identification and management.</p>
+<p id="TagManagement__p164691516615">You can add tags to a Kafka instance when creating the instance or add tags on the <strong id="TagManagement__b68294410312">Tags</strong> tab page of the created instance. Up to 20 tags can be added to an instance. Tags can be modified and deleted.</p>
+<p id="TagManagement__p8060118">A tag consists of a tag key and a tag value. <a href="#TagManagement__table193611920984">Table 1</a> lists the tag key and value requirements.</p>
+
+<div class="tablenoborder"><a name="TagManagement__table193611920984"></a><a name="table193611920984"></a><table cellpadding="4" cellspacing="0" summary="" id="TagManagement__table193611920984" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Tag key and value requirements</caption><thead align="left"><tr id="TagManagement__row143632201486"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.3.1.1"><p id="TagManagement__p536311201182">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.3.1.2"><p id="TagManagement__p63637201685">Requirements</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="TagManagement__row43636201815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.3.1.1 "><p id="TagManagement__p336313201814">Tag key</p>
+</td>
+<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.3.1.2 "><ul id="TagManagement__ul133310231694"><li id="TagManagement__li833315236915">Cannot be left blank.</li><li id="TagManagement__li1733312319916">Must be unique for the same instance.</li><li id="TagManagement__li73333233916">Can contain a maximum of 36 characters.</li><li id="TagManagement__li19333112314912">Cannot contain the following characters: =*&lt;&gt;\,|/</li><li id="TagManagement__li1933311235916">Cannot start or end with a space.</li></ul>
+</td>
+</tr>
+<tr id="TagManagement__row193632201781"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.3.1.1 "><p id="TagManagement__p736315201282">Tag value</p>
+</td>
+<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.3.1.2 "><ul id="TagManagement__ul1216717306916"><li id="TagManagement__li9970165517266">Cannot be left blank.</li><li id="TagManagement__li81671630990">Can contain a maximum of 43 characters.</li><li id="TagManagement__li151672301596">Cannot contain the following characters: =*&lt;&gt;\,|/</li><li id="TagManagement__li111671630290">Cannot start or end with a space.</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="TagManagement__section184051819123810"><h4 class="sectiontitle">Procedure</h4><ol id="TagManagement__ol3625154473819"><li id="TagManagement__li68751861819"><span>Log in to the management console.</span></li><li id="TagManagement__li20371161464820"><span>Click <span><img id="TagManagement__kafka-ug-180604014_image129423217218" src="en-us_image_0143929918.png"></span> in the upper left corner to select a region.</span><p><div class="note" id="TagManagement__kafka-ug-180604014_note596412409275"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="TagManagement__kafka-ug-180604014_p11964174020277">Select the region where your Kafka instance is located.</p>
+</div></div>
+</p></li><li id="TagManagement__li189561034172215"><span>Click <strong id="TagManagement__b14774858509570">Service List</strong> and choose <strong id="TagManagement__b2055053229570">Application</strong> &gt; <strong id="TagManagement__b18820194239570">Distributed Message Service</strong>. The Kafka instance list is displayed.</span></li><li id="TagManagement__li1489192711531"><span>Click the name of an instance.</span></li><li id="TagManagement__li189991214141019"><span>Click the <strong id="TagManagement__b118441347203019">Tags</strong> tab.</span><p><p id="TagManagement__p16898133410247">View the tags of the instance.</p>
+</p></li><li id="TagManagement__li658882719391"><span>Perform the following operations as required:</span><p><ul id="TagManagement__ul143482985319"><li id="TagManagement__li184341129115317">Add a tag<ol type="a" id="TagManagement__ol15591750115315"><li id="TagManagement__li165913500532">Click <strong id="TagManagement__b1264418221323">Add/Edit Tag</strong>.</li><li id="TagManagement__li75973412544">Enter a tag key and a tag value, and click <strong id="TagManagement__b17953037173518">Add</strong>.<p id="TagManagement__p1580923115586">If you have predefined tags, select a predefined pair of tag key and value, and click <strong id="TagManagement__b99061025123610">Add</strong>.</p>
+</li><li id="TagManagement__li1217122155815">Click <strong id="TagManagement__b13934927193610">OK</strong>.</li></ol>
+</li><li id="TagManagement__li246328183010">Modify a tag<ol type="a" id="TagManagement__ol121461527103219"><li id="TagManagement__li101462277325">Click <strong id="TagManagement__b7894145034316">Add/Edit Tag</strong>.</li><li id="TagManagement__li10953549323">Click <span><img id="TagManagement__image124055234111" src="en-us_image_0000001427644729.png"></span> next to the tag to be edited, enter the original tag key and the new tag value, and click <strong id="TagManagement__b19855103119557">Add</strong>.</li><li id="TagManagement__li614912439509">Click <strong id="TagManagement__b15414618559">OK</strong>.</li></ol>
+</li><li id="TagManagement__li1931437145316">Delete a tag<p id="TagManagement__p10415343125317"><a name="TagManagement__li1931437145316"></a><a name="li1931437145316"></a>Delete a tag using either of the following methods:</p>
+<ul id="TagManagement__ul649151145418"><li id="TagManagement__li949311135418">In the row containing the tag to be deleted, click <strong id="TagManagement__b135611420124310">Delete</strong>. In the <strong id="TagManagement__b10212143711438">Delete Tag</strong> dialog box, click <strong id="TagManagement__b153592574422">Yes</strong>.</li><li id="TagManagement__li4750125155414">Click <strong id="TagManagement__b6803105813427">Add/Edit Tag</strong>. In the <strong id="TagManagement__b1941577114418">Add/Edit Tag</strong> dialog box, click <span><img id="TagManagement__image1543573125614" src="en-us_image_0000001427644729.png"></span> next to the tag to be deleted and click <strong id="TagManagement__b87193289449">OK</strong>.</li></ul>
+</li></ul>
+</p></li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="kafka-ug-180604011.html">Managing Instances</a></div>
+</div>
+</div>
+

docs/dms/umn/dms-ug-0312114.html

@@ -0,0 +1,7 @@
+<a name="dms-ug-0312114"></a><a name="dms-ug-0312114"></a>
+
+<h1 class="topictitle1">Glossary</h1>
+<div id="body0000001381284617"><p id="dms-ug-0312114__p8060118">See <a href="https://docs.otc.t-systems.com/en-us/glossary/index.html" target="_blank" rel="noopener noreferrer">Glossary</a>.</p>
+</div>
+<div></div>
+

docs/dms/umn/dms-ug-180604013.html

@@ -0,0 +1,45 @@
+<a name="dms-ug-180604013"></a><a name="dms-ug-180604013"></a>
+
+<h1 class="topictitle1">Creating an Instance</h1>
+<div id="body1526549638065"><div class="section" id="dms-ug-180604013__section66578044"><h4 class="sectiontitle">Scenario</h4><p id="dms-ug-180604013__p1553143317530">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.</p>
+</div>
+<div class="section" id="dms-ug-180604013__section62331491"><h4 class="sectiontitle">Before You Start</h4><ul id="dms-ug-180604013__ul426112718412"><li id="dms-ug-180604013__li0935452204112">Before creating a Kafka instance, ensure that a VPC configured with security groups and subnets is available.</li><li id="dms-ug-180604013__li15977611318">(Optional) If you want to access a Kafka instance over a public network, prepare an elastic IP address (EIP) in advance.</li><li id="dms-ug-180604013__li1449852783112">(Optional) If you need to encrypt the disk, prepare a KMS key in advance.</li></ul>
+</div>
+<div class="section" id="dms-ug-180604013__section1474721314405"><h4 class="sectiontitle">Procedure</h4><ol id="dms-ug-180604013__ol5830987918728"><li id="dms-ug-180604013__li947606918728"><span>Log in to the management console.</span></li><li id="dms-ug-180604013__li14905725134512"><span>Click <span><img id="dms-ug-180604013__image918235631918" src="en-us_image_0143929918.png"></span> in the upper left corner to select a region.</span><p><div class="note" id="dms-ug-180604013__note596412409275"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dms-ug-180604013__p11964174020277">Select the same region as your application service.</p>
+</div></div>
+</p></li><li id="dms-ug-180604013__li189561034172215"><span>Click <strong id="dms-ug-180604013__b69768989795651">Service List</strong> and choose <strong id="dms-ug-180604013__b169328353295651">Application</strong> &gt; <strong id="dms-ug-180604013__b7799859995651">Distributed Message Service</strong>. The Kafka instance list is displayed.</span></li><li id="dms-ug-180604013__li35416756"><span>Click <strong id="dms-ug-180604013__b196342036191118">Create Instance</strong> in the upper right corner of the page.</span><p><p id="dms-ug-180604013__p7654183010494">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.</p>
+</p></li><li id="dms-ug-180604013__li1439814384720"><span>Specify <strong id="dms-ug-180604013__b15181533123513">Region</strong>, <strong id="dms-ug-180604013__b121818339353">Project</strong>, and <strong id="dms-ug-180604013__b318203393516">AZ</strong>.</span></li><li id="dms-ug-180604013__li1518911167330"><span>Enter an instance name.</span></li><li id="dms-ug-180604013__li10794171731812"><span>Configure the following instance parameters:</span><p><ol type="a" id="dms-ug-180604013__ol177941417161819"><li id="dms-ug-180604013__li137941417101814"><strong id="dms-ug-180604013__b1773411719537">Version</strong>: Kafka v1.1.0, v2.3.0, and v2.7 are supported. v2.7 is recommended. <strong id="dms-ug-180604013__b13582141117527">The version cannot be changed once the instance is created.</strong></li><li id="dms-ug-180604013__li87941417151813"><strong id="dms-ug-180604013__b76575413142420">CPU Architecture</strong>: The x86 architecture is supported.</li><li id="dms-ug-180604013__li27951171187"><strong id="dms-ug-180604013__b134301136201318">Flavor</strong>: Select a bandwidth based on the estimated service traffic.<p id="dms-ug-180604013__p16795101718182">You can view the broker quantity and flavor, the maximum number of partitions allowed, and number of consumer groups recommended for each bandwidth option.</p>
+<p id="dms-ug-180604013__p2795121716183">The <strong id="dms-ug-180604013__b299102178">Maximum Partitions</strong> 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.</p>
+</li><li id="dms-ug-180604013__li1379581731812"><strong id="dms-ug-180604013__b1063584312527">Storage Space</strong>: Disk type and total disk space for storing the instance data. <strong id="dms-ug-180604013__b989815945214">The disk type cannot be changed once the instance is created.</strong><p id="dms-ug-180604013__p379514178181">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).</p>
+<p id="dms-ug-180604013__p1179541710187">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.</p>
+<ul id="dms-ug-180604013__ul77955173182"><li id="dms-ug-180604013__li37951617181817">100 MB/s bandwidth: The value range of <strong id="dms-ug-180604013__b128130378042420">Storage Space</strong> is 600–90,000 GB.</li><li id="dms-ug-180604013__li879591717189">300 MB/s bandwidth: The value range of <strong id="dms-ug-180604013__b690313202422">Storage Space</strong> is 1200–90,000 GB.</li><li id="dms-ug-180604013__li579501791816">600 MB/s bandwidth: The value range of <strong id="dms-ug-180604013__b8215152334211">Storage Space</strong> is 2400–90,000 GB.</li><li id="dms-ug-180604013__li77951017181818">1200 MB/s bandwidth: The value range of <strong id="dms-ug-180604013__b166531425104318">Storage Space</strong> is 4800–90,000 GB.</li></ul>
+<div class="note" id="dms-ug-180604013__note1179516174188"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="dms-ug-180604013__ul7795111720184"><li id="dms-ug-180604013__li779517179187">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.</li><li id="dms-ug-180604013__li107950178187">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.</li><li id="dms-ug-180604013__li1979511714180">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.</li><li id="dms-ug-180604013__li20795417171816">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.</li><li id="dms-ug-180604013__li3795617171812">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.</li><li id="dms-ug-180604013__li147953172187">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.</li></ul>
+</div></div>
+</li><li id="dms-ug-180604013__li679614179189"><strong id="dms-ug-180604013__b361463110814">Disk Encryption</strong>: 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. <strong id="dms-ug-180604013__b16483162015318">This parameter cannot be modified once the instance is created.</strong></li><li id="dms-ug-180604013__li3796181715187"><strong id="dms-ug-180604013__b195185462042420">Capacity Threshold Policy</strong>: policy used when the disk usage reaches the threshold. The capacity threshold is 95%.<ul id="dms-ug-180604013__ul9796417171810"><li id="dms-ug-180604013__li8796161715185"><strong id="dms-ug-180604013__b195576967042420">Automatically delete</strong>: 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.</li><li id="dms-ug-180604013__li17961917161811"><strong id="dms-ug-180604013__b47854603042420">Stop production</strong>: 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.</li></ul>
+</li></ol>
+</p></li><li id="dms-ug-180604013__li9463112163718"><span>Configure the instance network parameters.</span><p><ul id="dms-ug-180604013__ul0501221133819"><li id="dms-ug-180604013__li479611751816">Select a VPC and a subnet.<p id="dms-ug-180604013__p167961317181817"><a name="dms-ug-180604013__li479611751816"></a><a name="li479611751816"></a>A VPC provides an isolated virtual network for your Kafka instances. You can configure and manage the network as required.</p>
+<div class="note" id="dms-ug-180604013__note167962017101820"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dms-ug-180604013__p1279631714182">After the Kafka instance is created, its VPC and subnet cannot be changed.</p>
+</div></div>
+</li><li id="dms-ug-180604013__li117962017151816">Select a security group.<p id="dms-ug-180604013__p147961917201817"><a name="dms-ug-180604013__li117962017151816"></a><a name="li117962017151816"></a>A security group is a set of rules for accessing a Kafka instance. You can click <strong id="dms-ug-180604013__b178632510543">Manage Security Group</strong> to view or create security groups on the network console.</p>
+</li></ul>
+</p></li><li id="dms-ug-180604013__li136733024611"><span>Click <strong id="dms-ug-180604013__b105189575254">Advanced Settings</strong> to configure more parameters.</span><p><ol type="a" id="dms-ug-180604013__ol18114435134614"><li id="dms-ug-180604013__li4932453164611">Configure public access.<p id="dms-ug-180604013__p1614516437469"><a name="dms-ug-180604013__li4932453164611"></a><a name="li4932453164611"></a>Public access is disabled by default. You can enable or disable it as required.</p>
+<p id="dms-ug-180604013__p1997402084620">After public access is enabled, configure an IPv4 EIP for each broker.</p>
+</li><li id="dms-ug-180604013__li851412565454">Configure <strong id="dms-ug-180604013__b14220250161615">Kafka SASL_SSL</strong>.<p id="dms-ug-180604013__p1988151615716">This parameter indicates whether to enable SSL authentication when a client connects to the instance. If you enable <strong id="dms-ug-180604013__b5491471579">Kafka SASL_SSL</strong>, data will be encrypted before transmission to enhance security.</p>
+<p id="dms-ug-180604013__p82195013508"><strong id="dms-ug-180604013__b16668113195516">Kafka SASL_SSL</strong> is disabled by default. You can enable or disable it as required. <strong id="dms-ug-180604013__b135995615415">This setting cannot be changed after the instance is created.</strong> If you want to use a different setting, you must create a new instance.</p>
+<p id="dms-ug-180604013__p1322750185010">If you enable <strong id="dms-ug-180604013__b2983613175515">Kafka SASL_SSL</strong>, you must also set the username and password for accessing the instance.</p>
+</li><li id="dms-ug-180604013__li179906520399">Configure <strong id="dms-ug-180604013__b98964531264">Automatic Topic Creation</strong>.<p id="dms-ug-180604013__p98461918114515">This setting is disabled by default. You can enable or disable it as required.</p>
+<p id="dms-ug-180604013__p122131142134015">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.</p>
+<p id="dms-ug-180604013__p17451319455">After you change the value of the <strong id="dms-ug-180604013__b20873125816551">log.retention.hours</strong>, <strong id="dms-ug-180604013__b168731758125512">default.replication.factor</strong>, or <strong id="dms-ug-180604013__b1874145875518">num.partitions</strong> parameter, automatically created topics later use the new value. For example, if <strong id="dms-ug-180604013__b3194163165612">num.partitions</strong> is set to <strong id="dms-ug-180604013__b1194739569">5</strong>, an automatically created topic will have the following settings: 5 partitions, 3 replicas, aging time 72 hours, and synchronous replication and flushing disabled.</p>
+</li><li id="dms-ug-180604013__li161619561652">Specify <strong id="dms-ug-180604013__b16984122331118">Tags</strong>.<p id="dms-ug-180604013__p198651356121410">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).</p>
+<ul id="dms-ug-180604013__ul1322213817273"><li id="dms-ug-180604013__li92226852712">If you have predefined tags, select a predefined pair of tag key and value. Click <strong id="dms-ug-180604013__b10416650121111">View predefined tags</strong>. On the Tag Management Service (TMS) console, view predefined tags or create tags.</li><li id="dms-ug-180604013__li19963131962715">You can also create new tags by specifying <strong id="dms-ug-180604013__b18631587124">Tag key</strong> and <strong id="dms-ug-180604013__b08641487120">Tag value</strong>.</li></ul>
+<p id="dms-ug-180604013__p27531152173714">Up to 20 tags can be added to each Kafka instance. For details about the requirements on tags, see <a href="TagManagement.html">Managing Instance Tags</a>.</p>
+</li><li id="dms-ug-180604013__li096610334233">Enter a description of the instance.</li></ol>
+</p></li><li id="dms-ug-180604013__li10149123410160"><span>Click <strong id="dms-ug-180604013__b380417428917">Create</strong>.</span></li><li id="dms-ug-180604013__li1541745896"><span>Confirm the instance information, and click <strong id="dms-ug-180604013__b1869223818114">Submit</strong>.</span></li><li id="dms-ug-180604013__li5094516318728"><span>Return to the instance list and check whether the Kafka instance has been created.</span><p><p id="dms-ug-180604013__p723116471910">It takes 3 to 15 minutes to create an instance. During this period, the instance status is <strong id="dms-ug-180604013__b9114154920281">Creating</strong>.</p>
+<ul id="dms-ug-180604013__ul3581181512433"><li id="dms-ug-180604013__li4757194719177">If the instance is created successfully, its status changes to <strong id="dms-ug-180604013__b16368103515332">Running</strong>.</li><li id="dms-ug-180604013__li55813157434">If the instance fails to be created, view <strong id="dms-ug-180604013__b7318223193915">Instance Creation Failures</strong>. Delete the instance by referring to <a href="kafka-ug-180604016.html">Deleting an Instance</a> and create another instance. If the instance creation fails again, contact customer service.<div class="note" id="dms-ug-180604013__note448616441312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dms-ug-180604013__p5487154483114">Instances that fail to be created do not occupy other resources.</p>
+</div></div>
+</li></ul>
+</p></li></ol>
+</div>
+</div>
+<div></div>
+

docs/dms/umn/dms-ug-180604018.html

@@ -0,0 +1,85 @@
+<a name="dms-ug-180604018"></a><a name="dms-ug-180604018"></a>
+
+<h1 class="topictitle1">Creating a Topic</h1>
+<div id="body1526550096864"><p id="dms-ug-180604018__p1156153913716">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.</p>
+<p id="dms-ug-180604018__p41291349122117">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 <strong id="dms-ug-180604018__b1679623411912">log.retention.hours</strong>, <strong id="dms-ug-180604018__b385813407193">default.replication.factor</strong>, or <strong id="dms-ug-180604018__b1771104411916">num.partitions</strong> parameter, automatically created topics later use the new value. For example, if <strong id="dms-ug-180604018__b1629245015190">num.partitions</strong> 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.</p>
+<p id="dms-ug-180604018__p9746173813410">There is a limit on the total number of partitions in topics. <strong id="dms-ug-180604018__b84821938132014">When the partition quantity limit is reached, you can no longer create topics.</strong> The total number of partitions varies with instance specifications. For details, see <a href="Kafka-specification.html">Specifications</a>.</p>
+<p id="dms-ug-180604018__p9580145916458">Methods that can be used to manually create a topic:</p>
+<ul id="dms-ug-180604018__ul13880145020328"><li id="dms-ug-180604018__li1588010504326"><a href="#dms-ug-180604018__section0249155910409">Method 1: Creating a Topic on the Console</a></li><li id="dms-ug-180604018__li10901132216410"><a href="#dms-ug-180604018__section1623746152018">Method 2: Create a Topic by Using Kafka CLI</a></li></ul>
+<div class="note" id="dms-ug-180604018__note978972316534"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dms-ug-180604018__p578917231534">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.</p>
+</div></div>
+<div class="section" id="dms-ug-180604018__section0249155910409"><a name="dms-ug-180604018__section0249155910409"></a><a name="section0249155910409"></a><h4 class="sectiontitle">Method 1: Creating a Topic on the Console</h4><ol id="dms-ug-180604018__ol363518281765"><li id="dms-ug-180604018__li10427115412419"><span>Log in to the management console.</span></li><li id="dms-ug-180604018__li14905725134512"><span>Click <span><img id="dms-ug-180604018__image4338192711244" src="en-us_image_0143929918.png"></span> in the upper left corner to select a region.</span><p><div class="note" id="dms-ug-180604018__note596412409275"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dms-ug-180604018__p11964174020277">Select the region where your Kafka instance is located.</p>
+</div></div>
+</p></li><li id="dms-ug-180604018__li189561034172215"><span>Click <strong id="dms-ug-180604018__b13696694049573">Service List</strong> and choose <strong id="dms-ug-180604018__b8985732149573">Application</strong> &gt; <strong id="dms-ug-180604018__b2064523509573">Distributed Message Service</strong>. The Kafka instance list is displayed.</span></li><li id="dms-ug-180604018__li26520051765"><span>Click the desired Kafka instance to view the instance details.</span></li><li id="dms-ug-180604018__li6318234617851"><span>Click the <strong id="dms-ug-180604018__b14653022155310">Topics</strong> tab, and click <strong id="dms-ug-180604018__b16653142235318">Create Topic</strong>.</span><p><p id="dms-ug-180604018__p46894370318">The <strong id="dms-ug-180604018__b842352706152859">Create Topic</strong> dialog box is displayed.</p>
+</p></li><li id="dms-ug-180604018__li11652913193216"><span>Specify the topic parameters listed in the following table.</span><p>
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dms-ug-180604018__table186364410350" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Topic parameters</caption><thead align="left"><tr id="dms-ug-180604018__row66474473513"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.2.6.2.1.2.3.1.1"><p id="dms-ug-180604018__p7641944173520">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="77%" id="mcps1.3.7.2.6.2.1.2.3.1.2"><p id="dms-ug-180604018__p264154419353">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="dms-ug-180604018__row8641444183514"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.6.2.1.2.3.1.1 "><p id="dms-ug-180604018__p12649444358">Topic Name</p>
+</td>
+<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.7.2.6.2.1.2.3.1.2 "><p id="dms-ug-180604018__p886312445210">When creating a topic, you can modify the automatically generated topic name.</p>
+<p id="dms-ug-180604018__p19863142405214">Once the topic is created, you cannot modify its name.</p>
+</td>
+</tr>
+<tr id="dms-ug-180604018__row196494414358"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.6.2.1.2.3.1.1 "><p id="dms-ug-180604018__p10641644103512">Partitions</p>
+</td>
+<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.7.2.6.2.1.2.3.1.2 "><p id="dms-ug-180604018__p1064194443517">A larger number of partitions for a topic indicates more messages retrieved concurrently.</p>
+<p id="dms-ug-180604018__p515812152115">If this parameter is set to <strong id="dms-ug-180604018__b67319136262">1</strong>, messages will be retrieved in the FIFO order.</p>
+<p id="dms-ug-180604018__p14572074216">Value range: 1 to 100</p>
+<p id="dms-ug-180604018__p49191315152018">Default value: <strong id="dms-ug-180604018__b81014141505">3</strong></p>
+</td>
+</tr>
+<tr id="dms-ug-180604018__row764164413519"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.6.2.1.2.3.1.1 "><p id="dms-ug-180604018__p2647442357">Replicas</p>
+</td>
+<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.7.2.6.2.1.2.3.1.2 "><p id="dms-ug-180604018__p133039601910">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.</p>
+<p id="dms-ug-180604018__p155911384258">If this parameter is set to <strong id="dms-ug-180604018__b127623594269">1</strong>, only one set of data is available.</p>
+<p id="dms-ug-180604018__p1420827152712">Value range: 1 to 3</p>
+<p id="dms-ug-180604018__p74201827182717">Default value: <strong id="dms-ug-180604018__b71501319501">3</strong></p>
+<div class="note" id="dms-ug-180604018__note1525310165717"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dms-ug-180604018__dms-ug-180604018_p578917231534">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.</p>
+</div></div>
+</td>
+</tr>
+<tr id="dms-ug-180604018__row464194417358"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.6.2.1.2.3.1.1 "><p id="dms-ug-180604018__p136464453511">Aging Time (h)</p>
+</td>
+<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.7.2.6.2.1.2.3.1.2 "><p id="dms-ug-180604018__p1946217619120">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.</p>
+<p id="dms-ug-180604018__p1367151412910">Value range: 1 to 720</p>
+<p id="dms-ug-180604018__p885211915294">Default value: <strong id="dms-ug-180604018__b4135223304">72</strong></p>
+</td>
+</tr>
+<tr id="dms-ug-180604018__row24651137132"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.6.2.1.2.3.1.1 "><p id="dms-ug-180604018__p646518311134">Synchronous Replication</p>
+</td>
+<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.7.2.6.2.1.2.3.1.2 "><p id="dms-ug-180604018__p5290129194418">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.</p>
+<p id="dms-ug-180604018__p177312016154417">After enabling synchronous replication, set <strong id="dms-ug-180604018__b65425580205">acks</strong> to <strong id="dms-ug-180604018__b1176215162118">all</strong> or <strong id="dms-ug-180604018__b13260055213">–1</strong> on the client. Otherwise, this function will not take effect.</p>
+<p id="dms-ug-180604018__p6199143215378">If there is only one replica, synchronous replication cannot be enabled.</p>
+</td>
+</tr>
+<tr id="dms-ug-180604018__row564184403515"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.6.2.1.2.3.1.1 "><p id="dms-ug-180604018__p9641944123515">Synchronous Flushing</p>
+</td>
+<td class="cellrowborder" valign="top" width="77%" headers="mcps1.3.7.2.6.2.1.2.3.1.2 "><p id="dms-ug-180604018__p1164144413516">An indicator of whether a message is immediately flushed to disk once created.</p>
+<ul id="dms-ug-180604018__ul74988451913"><li id="dms-ug-180604018__li19498174201916">Enabled: A message is immediately flushed to disk once it is created, resulting in higher reliability.</li><li id="dms-ug-180604018__li1172317615193">Disabled: A message is stored in the memory instead of being immediately flushed to disk once created.</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</p></li><li id="dms-ug-180604018__li800987517934"><span>Click <strong id="dms-ug-180604018__b1943613110583">OK</strong>.</span></li></ol>
+</div>
+<div class="section" id="dms-ug-180604018__section1623746152018"><a name="dms-ug-180604018__section1623746152018"></a><a name="section1623746152018"></a><h4 class="sectiontitle">Method 2: Create a Topic by Using Kafka CLI</h4><p id="dms-ug-180604018__p168427588518">If your client is v2.2 or later, you can use <strong id="dms-ug-180604018__b1273932314374">kafka-topics.sh</strong> to create topics and manage topic parameters.</p>
+<div class="notice" id="dms-ug-180604018__note105391178571"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="dms-ug-180604018__p3539474572">If a topic name starts with a special character, for example, an underscore (_) or a number sign (#), monitoring data cannot be displayed.</p>
+</div></div>
+<ul id="dms-ug-180604018__ul14955625613"><li id="dms-ug-180604018__li15955620614">If SASL is not enabled for the Kafka instance, run the following command in the <strong id="dms-ug-180604018__b632313183410">/</strong><em id="dms-ug-180604018__i112045803314">{directory where the CLI is located}</em><strong id="dms-ug-180604018__b14323717343">/kafka_{version}/bin/</strong> directory to create a topic:<pre class="screen" id="dms-ug-180604018__screen1719958142520">./kafka-topics.sh --create --topic {topic_name} --bootstrap-server {broker_ip}:{port} --partitions {partition_num} --replication-factor {replication_num}</pre>
+</li><li id="dms-ug-180604018__li2174501363">If SASL has been enabled for the Kafka instance, perform the following steps to create a topic:<ol id="dms-ug-180604018__ol39441754276"><li id="dms-ug-180604018__li15966133810218">(Optional) If the SSL certificate configuration has been set, skip this step. Otherwise, perform the following operations:<p id="dms-ug-180604018__p2013074012213"><a name="dms-ug-180604018__li15966133810218"></a><a name="li15966133810218"></a>Create the <strong id="dms-ug-180604018__b06981828202115">ssl-user-config.properties</strong> file in the <strong id="dms-ug-180604018__b116981228192119">/config</strong> directory of the Kafka client and add the SSL certificate configurations by referring to <a href="kafka-ug-180801001.html#kafka-ug-180801001__li5414277457">3</a>.</p>
+</li><li id="dms-ug-180604018__li529219395271">Run the following command in the <strong id="dms-ug-180604018__b1221915162345">/</strong><em id="dms-ug-180604018__i10607613173416">{directory where the CLI is located}</em><strong id="dms-ug-180604018__b2021917163344">/kafka_{version}/bin/</strong> directory to create a topic:<pre class="screen" id="dms-ug-180604018__screen117611716133716">./kafka-topics.sh --create --topic {topic_name} --bootstrap-server {broker_ip}:{port} --partitions {partition_num} --replication-factor {replication_num} --command-config ./config/ssl-user-config.properties </pre>
+</li></ol>
+</li></ul>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="kafka-ug-0720001.html">Managing Topics</a></div>
+</div>
+</div>
+

docs/dms/umn/dms-ug-190128001.html

@@ -0,0 +1,13 @@
+<a name="dms-ug-190128001"></a><a name="dms-ug-190128001"></a>
+
+<h1 class="topictitle1">Permissions</h1>
+<div id="body0000001327552522"><p id="dms-ug-190128001__p17268142442020">By default, there are two types of user permissions: user management and resource management.</p>
+<ul id="dms-ug-190128001__ul132951147114914"><li id="dms-ug-190128001__li1829524754913">User management refers to the management of users, user groups, and user group rights.</li><li id="dms-ug-190128001__li198647497498">Resource management refers to the control operations that can be performed by users on cloud service resources.</li></ul>
+<p id="dms-ug-190128001__p697641311205">For further details, see <a href="https://docs.otc.t-systems.com/en-us/permissions/index.html" target="_blank" rel="noopener noreferrer">Permissions</a>.</p>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="kafka-ug-0723001.html">Service Overview</a></div>
+</div>
+</div>
+