Pre-configuring an Apache Kafka® cluster connection
You can connect to Managed Service for Apache Kafka® cluster hosts:
- Over the internet if you configured public access for your cluster. This cluster allows connections only via SSL.
- From Yandex Cloud virtual machines located in the same cloud network. If the cluster is not publicly accessible, you do not need to use SSL to connect from these VMs.
You can connect to an Apache Kafka® cluster both with encryption (SASL_SSL, port 9091) and without it (SASL_PLAINTEXT, port 9092).
To connect to an Apache Kafka® cluster:
- Create users for clients (producers and consumers) with access to the appropriate topics.
- Connect the clients to the cluster:
- Producers using the Kafka Producer API
. - Consumers using the Kafka Consumer API
.
- Producers using the Kafka Producer API
There are ready-made Apache Kafka® API implementations for most popular programming languages. For use cases, see Code examples.
Configuring security groups
To connect to a cluster, security groups must include rules allowing traffic from certain ports, IP addresses, or from other security groups.
Rule settings depend on the connection method you select:
Configure all cluster security groups to allow incoming traffic on port 9091 from any IP address. To do this, create the following inbound rule:
- Port range:
9091. - Protocol:
TCP. - Source:
CIDR. - CIDR blocks:
0.0.0.0/0.
To allow the use of Managed Service for Apache Kafka® API, e.g., to work with Managed Schema Registry, add the following inbound rule:
- Port range:
443. - Protocol:
TCP. - Source:
CIDR. - CIDR blocks:
0.0.0.0/0.
-
Configure all cluster security groups to allow incoming traffic on ports 9091 and 9092 from your VM’s security group. To do this, create the following inbound rule in these groups:
- Port range:
9091-9092. - Protocol:
TCP. - Source:
Security group. - Security group: If your cluster and VM share the same security group, select
Current(Self). Otherwise, specify the VM security group.
To allow the use of Managed Service for Apache Kafka® API, e.g., to work with Managed Schema Registry, add the following inbound rule:
- Port range:
443. - Protocol:
TCP. - Source:
CIDR. - CIDR blocks:
0.0.0.0/0.
- Port range:
-
Configure the VM security group to allow VM connections and traffic between the VM and cluster hosts.
For example, you can set the following rules for your VM:
-
For incoming traffic:
- Port range:
22. - Protocol:
TCP. - Source:
CIDR. - CIDR blocks:
0.0.0.0/0.
This rule allows inbound VM connections over SSH.
- Port range:
-
For outgoing traffic:
- Protocol:
Any. - Port range:
0-65535. - Destination name:
CIDR. - CIDR blocks:
0.0.0.0/0.
This rule allows all outgoing traffic, thus enabling you not only to connect to the cluster but also to install the certificates and utilities your VM needs for the connection.
- Protocol:
-
Note
You can specify more granular rules for your security groups, such as only allowing traffic within specific subnets.
Make sure to configure the security groups correctly for all subnets where the cluster hosts will reside. With incomplete or incorrect security group settings, you may lose access to the cluster.
For more information about security groups, see Security groups.
Getting an SSL certificate
To use an encrypted connection, get an SSL certificate:
mkdir -p /usr/local/share/ca-certificates/Yandex/ && \
wget "https://storage.yandexcloud.net/cloud-certs/CA.pem" \
--output-document /usr/local/share/ca-certificates/Yandex/YandexInternalRootCA.crt && \
chmod 0655 /usr/local/share/ca-certificates/Yandex/YandexInternalRootCA.crt
The certificate will be saved to the /usr/local/share/ca-certificates/Yandex/YandexInternalRootCA.crt file.
mkdir $HOME\.kafka; curl.exe -o $HOME\.kafka\YandexInternalRootCA.crt https://storage.yandexcloud.net/cloud-certs/CA.pem
The certificate will be saved to the $HOME\.kafka\YandexInternalRootCA.crt file.
Your corporate security policies and antivirus software may block the certificate download. For more information, see FAQ.
This certificate is also used to access the Managed Service for Apache Kafka® REST API.
Getting FQDNs of Apache Kafka® hosts
To connect to a host, you need its fully qualified domain name (FQDN). Example of an Apache Kafka® host FQDN:
rc1a-goh2a9tr********.mdb.yandexcloud.net
You can get the FQDN by doing one of the following:
-
Look up the FQDN in the management console:
- Navigate to the cluster page.
- Navigate to Hosts.
- Copy the Host FQDN column value.
-
In the management console
, copy the command for connecting to the cluster. It contains the broker host FQDN. To get the command, go to the cluster page and click Connect. -
Get the list of cluster hosts using the CLI or API.
With the Managed Service for Apache Kafka® REST API, you can send requests to any broker host: the API is available from all the cluster's broker hosts.