Help Center/ Distributed Message Service for Kafka/ User Guide (Paris Region)/ Creating an Instance
Updated on 2024-04-07 GMT+08:00
View PDF
Share

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

  • Before creating a Kafka instance, ensure that a VPC configured with security groups and subnets is available.
  • (Optional) If you want to access a Kafka instance over a public network, prepare an elastic IP address (EIP) in advance.

Procedure

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

    Select the region your application is in.

  3. Click in the upper left corner and choose Application > Distributed Message Service for Kafka to open the console of DMS for Kafka.
  4. Click Create Instance in the upper right corner of the page.
  5. Specify Region, Project, and AZ.
  6. Enter an instance name and select an enterprise project.
  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: Retain the default value.
    3. Broker Flavor: Select broker specifications that best fit your business needs. For Brokers, specify the broker quantity.

      Maximum number of partitions per broker x Number of brokers = Maximum number of partitions of an instance. If the total number of partitions of all topics exceeds the upper limit of partitions, topic creation fails.

    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.

    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. If no key is available, click View KMS Keys to go to the KMS console and create one. 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.
    Figure 1 Creating a Kafka instance

  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. Configure the username and password for logging in to Kafka Manager. The Kafka Manager username cannot be changed once the instance is created.

    Kafka Manager is an open-source tool for managing Kafka clusters. After a Kafka instance is created, you can go to the instance details page to obtain the address for logging in to Kafka Manager. In Kafka Manager, you can view the monitoring statistics and broker information of your Kafka clusters.

  10. 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 SASL authentication when a client connects to the instance. If you enable Kafka SASL_SSL, data will be encrypted for 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.

      After Kafka SASL_SSL is enabled, you can determine whether to enable SASL/PLAIN. If SASL/PLAIN is disabled, the SCRAM-SHA-512 mechanism is used to transmit data. If SASL/PLAIN is enabled, both the SCRAM-SHA-512 and PLAIN mechanisms are supported. You can select either of them as required. The SASL/PLAIN setting cannot be changed once the instance is created.

      What are SCRAM-SHA-512 and PLAIN mechanisms?

      • SCRAM-SHA-512: uses the hash algorithm to generate credentials for usernames and passwords to verify identities. SCRAM-SHA-512 is more secure than PLAIN.
      • PLAIN: a simple username and password verification mechanism.

      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 multiple cloud resources of the same type, you can use tags to classify them based on usage, owner, or environment.

      • If you have predefined tags, select a predefined pair of tag key and value. You can click View predefined tags to go to the Tag Management Service (TMS) console and view 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.

  11. Click Create Now.
  12. Confirm the instance information, and click Submit.
  13. 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 an instance fails to be created, view it in the Instance Creation Failures area, and delete it by referring to Deleting an Instance. Then create a new one. If the instance creation fails again, contact customer service.

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