Creating clusters

If you don't have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

1. View a description of the CLI create cluster command:

   yc managed-kafka cluster create --help
   

2. Specify the cluster parameters in the create command (only some of the supported parameters are given in the example):

   yc managed-kafka cluster create \
      --name <cluster name> \
      --environment <prestable or production> \
      --version <version: 2.1, 2.6, or 2.8> \
      --network-name <network name> \
      --brokers-count <number of brokers in the zone> \
      --resource-preset <host class> \
      --disk-type <network-hdd | network-ssd | local-ssd | network-ssd-nonreplicated> \
      --disk-size <storage size in GB> \
      --assign-public-ip <public access> \
      --security-group-ids <list of security group IDs> \
      --deletion-protection=<protect cluster from deletion: true or false>
   

   Cluster deletion protection will not prevent a manual connection to a cluster to delete data.

   If necessary, you can also configure the Apache Kafka® settings here.

3. To manage topics via the Apache Kafka® Admin API:

   Alert

   Once you create a cluster, you cannot change the Manage topics via the API setting.

   1. When creating a cluster, set the --unmanaged-topics parameter to true:

      yc managed-kafka cluster create \
         ...
         --unmanaged-topics true
      

   2. After creating a cluster, create an administrator account.

4. To create a cluster hosted using groups of dedicated hosts, list their IDs separated by commas in the --host-group-ids parameter when creating a cluster:

   yc managed-kafka cluster create \
      ...
      --host-group-ids <IDs of dedicated host groups>
   

   Alert

   You cannot edit this setting after you create a cluster. The use of dedicated hosts significantly affects cluster pricing.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it by configuration files. They store the infrastructure description in HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Mozilla Public License.

For more information about the provider resources, see the documentation on the Terraform site or mirror site.

If you change the configuration files, Terraform automatically determines which part of your configuration is already deployed and what should be added or removed.

If you don't have Terraform, install it and configure the provider.

To create a cluster:

1. In the configuration file, describe the parameters of resources that you want to create:

   • Apache Kafka® cluster: Description of a cluster and its hosts. If necessary, you can also configure the Apache Kafka® settings here.

   • Network: Description of the cloud network where a cluster will be located. If you already have a suitable network, you don't have to describe it again.

   • Subnets: Description of the subnets to connect the cluster hosts to. If you already have suitable subnets, you don't have to describe them again.

   Example configuration file structure:

   terraform {
     required_providers {
       yandex = {
        source = "yandex-cloud/yandex"
       }
     }
   }
   
   provider "yandex" {
     token     = "<OAuth or static key of service account>"
     cloud_id  = "<cloud ID>"
     folder_id = "<folder ID>"
     zone      = "<availability zone>"
   }
   
   resource "yandex_mdb_kafka_cluster" "<cluster name>" {
     environment         = "<environment: PRESTABLE or PRODUCTION>"
     name                = "<cluster name>"
     network_id          = "<network ID>"
     security_group_ids  = ["<list of cluster security group IDs>"]
     deletion_protection = <protect cluster from deletion: true or false>
   
     config {
       assign_public_ip = "<public access to the cluster: true or false>"
       brokers_count    = <number of brokers>
       version          = "<Apache Kafka version: 2.1, 2.6, or 2.8>"
       schema_registry  = "<data schema management: true or false>"
       kafka {
         resources {
           disk_size          = <storage size in GB>
           disk_type_id       = "<storage type: network-ssd, network-hdd, network-ssd-nonreplicated, or local-ssd>"
           resource_preset_id = "<host class>"
         }
       }
   
       zones = [
         "<availability zones>"
       ]
     }
   }
   
   resource "yandex_vpc_network" "<network name>" {
     name = "<network name>"
   }
   
   resource "yandex_vpc_subnet" "<subnet name>" {
     name           = "<subnet name>"
     zone           = "<availability zone>"
     network_id     = "<network ID>"
     v4_cidr_blocks = ["<range>"]
   }
   

   Cluster deletion protection will not prevent a manual connection to a cluster to delete data.

2. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

3. Create a cluster.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   After this, all the necessary resources will be created in the specified folder and the IP addresses of the VMs will be displayed in the terminal. You can check resource availability and their settings in the management console.

For more information, see the Terraform provider documentation.

Use the create API method and pass the following information in the request:

• The ID of the folder where the cluster should be placed in the folderId parameter.

• The cluster name in the name parameter.

• Security group IDs in the parameter securityGroupIds.

• Cluster deletion protection settings in the deletionProtection parameter.

  Cluster deletion protection will not prevent a manual connection to a cluster to delete data.

To manage topics via the Apache Kafka® Admin API:

1. Pass true for the unmanagedTopics parameter.
2. After creating a cluster, create an administrator account.

To manage data schemas using Managed Schema Registry, pass the true value for the configSpec.schemaRegistry parameter.

To create a cluster hosted using groups of dedicated hosts, pass their IDs in the hostGroupIds parameter.

Let's say we need to create a Managed Service for Apache Kafka® cluster with the following characteristics:

• In the cloud with the ID b1gq90dgh25bebiu75o.
• In the folder with the ID b1gia87mbaomkfvsleds.
• With the name mykf.
• In the PRODUCTION environment.
• With Apache Kafka® version 2.6.
• In the new mynet network with the subnet mysubnet.
• In the new security group mykf-sg allowing connection to the cluster from the Internet via port 9091.
• With one s2.micro host in the ru-central1-c availability zone.
• With one broker.
• With 10 GB of SSD network storage (network-ssd).
• With public access.
• With accidental cluster deletion protection.

The configuration file for the cluster looks like this:

terraform {
  required_providers {
    yandex = {
      source = "yandex-cloud/yandex"
    }
  }
}

provider "yandex" {
  token     = "<OAuth or static key of service account>"
  cloud_id  = "b1gq90dgh25bebiu75o"
  folder_id = "b1gia87mbaomkfvsleds"
  zone      = "ru-central1-c"
}

resource "yandex_mdb_kafka_cluster" "mykf" {
  environment         = "PRODUCTION"
  name                = "mykf"
  network_id          = yandex_vpc_network.mynet.id
  security_group_ids  = [ yandex_vpc_security_group.mykf-sg.id ]
  deletion_protection = true

  config {
    assign_public_ip = true
    brokers_count    = 1
    version          = "2.6"
    kafka {
      resources {
        disk_size          = 10
        disk_type_id       = "network-ssd"
        resource_preset_id = "s2.micro"
      }
    }

    zones = [
      "ru-central1-c"
    ]
  }
}

resource "yandex_vpc_network" "mynet" {
  name = "mynet"
}

resource "yandex_vpc_subnet" "mysubnet" {
  name           = "mysubnet"
  zone           = "ru-central1-c"
  network_id     = yandex_vpc_network.mynet.id
  v4_cidr_blocks = ["10.5.0.0/24"]
}

resource "yandex_vpc_security_group" "mykf-sg" {
  name       = "mykf-sg"
  network_id = yandex_vpc_network.mynet.id

  ingress {
    description    = "Kafka"
    port           = 9091
    protocol       = "TCP"
    v4_cidr_blocks = [ "0.0.0.0/0" ]
  }
}