You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/public_cloud/public_cloud_databases/kafka_02_getting_started/guide.de-de.md
+75-77Lines changed: 75 additions & 77 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Kafka - Getting started
3
-
excerpt: Find out how to set up and manage your Public Cloud Databases for Kafka
4
-
updated: 2022-01-05
3
+
excerpt: Find out how to set up and manage your Kafka service
4
+
updated: 2025-08-04
5
5
---
6
6
7
7
## Objectives
@@ -12,7 +12,7 @@ Apache Kafka is an open-source and highly resilient event streaming platform bas
12
12
- store streams of events;
13
13
- process streams of events.
14
14
15
-
You can get more information on Kafka from the [official Kafka website](https://kafka.apache.org/intro){.external).
15
+
You can get more information on Kafka from the [official Kafka website](https://kafka.apache.org/intro){.external}.
16
16
17
17
This guide explains how to successfully configure Public Cloud Databases for Kafka via the OVHcloud Control Panel.
18
18
@@ -25,132 +25,137 @@ This guide explains how to successfully configure Public Cloud Databases for Kaf
25
25
26
26
### Subscribe to the service
27
27
28
-
Log in to your [OVHcloud Control Panel](/links/manager) and switch to `Public Cloud`{.action} in the top navigation bar. After selecting your Public Cloud project, click on `Databases`{.action} in the left-hand navigation bar under **Storage**.
28
+
Log in to your [OVHcloud Control Panel](/links/manager) and switch to `Public Cloud`{.action} in the top navigation bar. After selecting your Public Cloud project, click on `Data Streaming`{.action} in the left-hand navigation bar under **Databases & Analytics**.
29
29
30
-
Click the `Create a database instance`{.action} button. (`Create a service`{.action} if your project already contains databases.)
30
+
Click the `Create a service`{.action} button.
31
31
32
-
#### Step 1: Select your database type
32
+
#### Select your analytics service
33
33
34
-
Click on the type of database you want to use and then select the version to install from the respective drop-down menu. Click `Next`{.action} to continue.
34
+
Click on the type of analytics service you want to use and its version.
35
+
A random name is generated for your service that can change in this step or later.
{.thumbnail}
43
44
44
-
Please visit the [capabilities page](/products/public-cloud-databases) of your selected database type for detailed information on each plan's properties.
45
+
#### Select a plan
45
46
46
-
Click `Next`{.action} to continue.
47
+
In this step, choose an appropriate service plan. If needed, you will be able to upgrade or downgrade the plan after creation.
Choose the geographical region of the datacenter where your service will be hosted.
51
+
Please visit the [capabilities page](/products/public-cloud-data-analytics) of your selected analytics service for detailed information on each plan's properties.
Choose the instance type for the nodes of your service, you will be able to change it afterward. The number of nodes depends on the plan previously chosen.
You can increase the number of nodes and choose the node template in this step. The minimum and maximum amount of nodes depends on the solution chosen in step 2.
Storage could be scaled up to 3 time the base storage.
61
62
62
-
Please visit the [capabilities page](/products/public-cloud-databases) of your selected database type for detailed information on hardware resources and other properties of the database installation.
A summary of your order is display to help you review your service configuration.
74
74
75
-
The final section will display a summary of your order as well as the API equivalent of creating this database instance with the [OVHcloud API](/pages/manage_and_operate/api/first-steps).
The components of the price is also summarized with a monthly estimation.
78
78
79
-
In a matter of minutes, your new Apache Kafka service will be deployed. Messages in the OVHcloud Control Panel will inform you when the streaming tool is ready to use.
Click the `API and Terraform equivalent`{.action} button to open the following window:
82
+
83
+
{.thumbnail}
84
+
85
+
The informations displayed in this window could help you automate your service creation with the [OVHcloud API](/pages/manage_and_operate/api/first-steps) or the OVHcloud Terraform Provider.
86
+
87
+
When you are ready click the `Order`{.action} button to create your service.
88
+
In a matter of minutes, your new Apache Kafka service will be deployed.
89
+
Messages in the OVHcloud Control Panel will inform you when the streaming tool is ready to use.
80
90
81
91
### Configure the Apache Kafka service
82
92
83
-
Once the Public Cloud Databases for Kafka service is up and running, you will have to define at least one user and one authorised IP in order to fully connect to the service (as producer or consumer).
93
+
Once the Public Cloud Databases for Kafka service is up and running, you will have to define at least one user and one authorised IP (if not already provided during the order) in order to fully connect to the service (as producer or consumer).
The `General information`{.action} tab should inform you to create users and authorized IPs.
97
+
The `Dashboard`{.action} tab automatically updates when your service is ready.
88
98
89
-
{.thumbnail}
99
+
{.thumbnail}
90
100
91
-
#### Step 1 (mandatory): Set up a user
101
+
#### Mandatory: Set up a user
92
102
93
-
Switch to the `Users`{.action} tab. An admin user is preconfigured during the service installation. You can add more users by clicking the `Add user`{.action} button.
103
+
Switch to the `Users`{.action} tab. An admin user name `avnadmin`is preconfigured during the service installation.
94
104
95
-
{.thumbnail}
105
+
{.thumbnail}
96
106
97
-
Enter a username, then click `Create User`{.action}.
107
+
You can add more users by clicking the `Add user`{.action} button.
98
108
99
-
Once the user is created, the password is generated. Please keep it securely as it will not be shown again.
109
+
{.thumbnail}
100
110
101
-
Passwords can be reset for the admin user or changed afterwards for other users in the `Users`{.action} tab.
111
+
Enter a username, then click `Create User`{.action}.
112
+
Passwords need to be reset from the `Users`{.action} tab.
> For security reasons the default network configuration doesn't allow any incoming connections. It is thus critical to authorize the suitable IP addresses in order to successfully access your Kafka cluster.
109
120
110
-
Switch to the `Authorized IPs`{.action} tab. At least one IP address must be authorised here before you can connect to your database.
Clicking on `Add an IP address or IP address block (CIDR)`{.action} opens a new window in which you can add single IP addresses or blocks to allow access to the database.
121
+
If you did not define the authorised IPs during the order you could do it in the `Authorized IPs`{.action} tab. At least one IP address must be authorised here before you can connect to your database.
You can edit and remove database access via the `...`{.action} button in the IP table.
125
+
Add the IP address of your computer by using the `Current IP`{.action} button.
126
+
You will be able to remove IPs from the table afterward.
120
127
121
-
If you don't know how to get your IP, please visit a website like [www.WhatismyIP.com](https://www.whatismyip.com/){.external}.
122
-
Copy the IP address shown on this website and keep it for later.
128
+
{.thumbnail}
123
129
124
130
Your Apache Kafka service is now fully accessible!
125
-
126
131
Optionally, you can configure access control lists (ACL) for granular permissions and create something called topics, as shown below.
127
132
128
133
#### Optional: Create Kafka topics
129
134
130
135
Topics can be seen as categories, allowing you to organize your Kafka records. Producers write to topics, and consumers read from topics.
131
136
132
-
To create Kafka topics, click on the `Add a topic`{.action} button:
137
+
To create Kafka topics, first go to the `Topics`{.action} tab then click on the `Add a topic`{.action} button:
133
138
134
-
{.thumbnail}
139
+
{.thumbnail}
135
140
136
141
In advanced configuration you can change the default value for the following parameters:
137
142
138
-
-Replication (3 brokers by default)
143
+
-Minimum in-sync replica (2 by default)
139
144
- Partitions (1 partition by default)
145
+
- Replication (3 brokers by default)
140
146
- Retention size in bytes (-1: no limitation by default)
141
147
- Retention time in hours (-1: no limitation by default)
142
-
- Minimum in-sync replica (2 by default)
143
148
- Deletion policy
144
149
145
-
{.thumbnail}
150
+
{.thumbnail}
146
151
147
152
#### Optional: Configure ACLs on topics
148
153
149
-
Public Cloud Databases for Kafka supports access control lists (ACLs) to manage permissions on topics. This approach allows you to limit the operations that are available to specific connections and to restrict access to certain data sets, which improves the security of your data.
154
+
Kafka supports access control lists (ACLs) to manage permissions on topics. This approach allows you to limit the operations that are available to specific connections and to restrict access to certain data sets, which improves the security of your data.
150
155
151
-
By default the admin user has access to all topics with admin privileges. You can define some additional ACLs for all users / topics, click on `Add a new entry`{.action} button:
156
+
By default the admin user has access to all topics with admin privileges. You can define some additional ACLs for all users / topics, by clicking on the `Add an ACL`{.action} button from the `ACL`{.action} tab:
As part of the Apache Kafka official installation, you will get different scripts that will also allow you to connect to Kafka in a Java 8+ environment: [Apache Kafka Official Quickstart](https://kafka.apache.org/quickstart){.external}.
201
199
202
-
We propose to use a generic producer and consumer client instead: Kcat (formerly known as kafkacat). Kcat is more lightweight since it does not require a JVM.
200
+
We propose to use a generic and more lightweight (does not require a JVM) producer and consumer client instead: `Kcat` (formerly known as `kafkacat`).
0 commit comments