Skip to content

Commit c3117a3

Browse files
committed
fix(kafka): final modifs
1 parent 40726d9 commit c3117a3

File tree

4 files changed

+127
-15
lines changed

4 files changed

+127
-15
lines changed

pages/clusters-for-kafka/faq.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: Clusters for Apache Kafka® FAQ
3-
description: Discover Clusters for Apache Kafka® TODO
3+
description: Get answers to all your questions about Scaleway Clusters for Apache Kafka®
44
dates:
55
validation: 2025-08-20
66
posted: 2025-08-20
7-
productIcon: TODO
7+
productIcon: KafkaProductIcon
88
noindex: true
99
---
1010

@@ -22,8 +22,8 @@ Clusters for Apache Kafka® is Scaleway's product to provide a secure, fully-man
2222

2323
Private Beta is aimed at providing an early version of a future product, to allow users to test and validate it during its development. The following limitations apply to Clusters for Apache Kafka® in its current Private Beta phase:
2424

25-
- Only selected users can test the product ([request an invitation](https://www.scaleway.com/en/betas/))
26-
- Only one Kafka version is supported (TODO).
25+
- Only selected users can test the product ([request an invitation](https://www.scaleway.com/en/betas/)).
26+
- Only one Kafka version is supported.
2727
- Clusters can only be provisioned with either one or three nodes (brokers).
2828
- The number of nodes cannot be modified after creation of the cluster.
2929
- Storage is fixed at 100 GB per node.

pages/clusters-for-kafka/how-to/manage-cluster.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Clusters for Apache Kafka® is currently in [Private Beta](https://www.scaleway.
1414

1515
After creating your cluster, you can renew its TLS certificate, change the attached Private Network, and change its password.
1616

17+
Other management actions, such as creating topics and events, and configuring partitions and replication factors, must be carried out via TODO HOW.
18+
1719
<Requirements />
1820

1921
- A Scaleway account logged into the [console](https://console.scaleway.com)
@@ -46,7 +48,11 @@ In order to facilitate connectivity to your cluster, it must always be attached
4648

4749
3. In the **Network** panel, click **Detach Private Network**
4850

49-
TODO
51+
A pop-up displays, asking you to confirm the action.
52+
53+
4. Click **Detach resource** to confirm.
54+
55+
The cluster is detached, and you are returned to its **Overview** page. Click **Attach Private Network** to choose a new Private Network to attach it to. Remember that the cluster is not accessible unless it is attached to a Private Network.
5056

5157
## How to change the password
5258

pages/clusters-for-kafka/index.mdx

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,18 @@ noindex: true
66

77
<ProductHeader
88
productName="Clusters for Apache Kafka®"
9-
productLogo="TODO"
9+
productLogo="kafka"
1010
description="Scaleway Clusters for Apache Kafka® provides a secure, fully-managed infrastructure for your Apache Kafka® deployments."
1111
url="/clusters-for-kafka/quickstart/"
1212
label="Clusters for Apache Kafka® Quickstart"
1313
/>
1414

15+
<Message
16+
type="note"
17+
title="Clusters for Apache Kafka® is now in Public Beta">
18+
This product is currently in [Private Beta](https://www.scaleway.com/en/betas/) and available to selected testers only. Watch this space to see how the product develops, or ask to join the beta for early access.
19+
</Message>
20+
1521
## Getting Started
1622

1723
<Grid>
@@ -30,11 +36,44 @@ noindex: true
3036
url="/clusters-for-kafka/concepts"
3137
/>
3238
<SummaryCard
33-
title="How-tos"
39+
title="FAQ"
40+
icon="help-circle-outline"
41+
description="Find answers to common questions"
42+
label="View FAQ"
43+
url="/clusters-for-kafka/faq/"
44+
/>
45+
</Grid>
46+
47+
## How-to guides
48+
49+
<Grid>
50+
<SummaryCard
51+
title="How to create a cluster"
52+
icon="help-circle-outline"
53+
description="Learn how to create your first cluster."
54+
label="View How-to"
55+
url="/clusters-for-kafka/how-to/create-cluster/"
56+
/>
57+
<SummaryCard
58+
title="How to connect to a cluster"
59+
icon="help-circle-outline"
60+
description="Find out how to connect your Kafka cluster."
61+
label="View How-to"
62+
url="/clusters-for-kafka/how-to/connect-to-cluster/"
63+
/>
64+
<SummaryCard
65+
title="How to manage a cluster"
66+
icon="help-circle-outline"
67+
description="Info on managing your Kafka cluster."
68+
label="View How-to"
69+
url="/clusters-for-kafka/how-to/manage-cluster/"
70+
/>
71+
<SummaryCard
72+
title="How to delete a cluster"
3473
icon="help-circle-outline"
35-
description="Check our guides to add and manage your clusters"
36-
label="View How-tos"
37-
url="/clusters-for-kafka/how-to/"
74+
description="Learn how to delete your cluster when you no longer need it"
75+
label="View How-to"
76+
url="/clusters-for-kafka/how-to/delete-cluster/"
3877
/>
3978

4079
</Grid>
@@ -43,13 +82,13 @@ noindex: true
4382
productLogo="cli"
4483
title="Clusters for Apache Kafka® API"
4584
description="Learn how to manage your clusters through the API."
46-
url="https://www.scaleway.com/en/developers/api/TODO/"
85+
url="https://www.scaleway.com/en/developers/api/clusters-for-kafka/"
4786
label="Go to Clusters for Apache Kafka® API"
4887
/>
4988

5089
## Changelog
5190

5291
<ChangelogList
53-
productName="TODO"
92+
productName="clusters-for-kafka"
5493
numberOfChanges={3}
5594
/>

pages/clusters-for-kafka/quickstart.mdx

Lines changed: 70 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ noindex: true
99
---
1010
import Requirements from '@macros/iam/requirements.mdx'
1111

12+
<Message type="note">
13+
Clusters for Apache Kafka® is currently in [Private Beta](https://www.scaleway.com/en/betas/) and available to selected testers only.
14+
</Message>
15+
16+
Clusters for Apache Kafka® is Scaleway's product to provide a secure, fully-managed infrastructure for your Apache Kafka® deployments. With our clusters, you can create data pipelines and event-driven architectures that run natively on Apache Kafka®, without having to manage the underlying infrastructure.
17+
18+
Follow our quickstart guide to get your first cluster up and running efficiently, and know how to delete it when you no longer need it.
1219

1320
<Requirements />
1421

@@ -17,12 +24,72 @@ import Requirements from '@macros/iam/requirements.mdx'
1724

1825
## How to create a Cluster for Apache Kafka®
1926

20-
TODO
27+
1. Click **Apache Kafka®** in the **Data and Analytics** section of the [console](https://console.scaleway.com/) side menu. The **Clusters for Apache Kafka®a** product page displays.
28+
29+
2. Click **Create cluster**. The creation wizard displays.
30+
31+
3. Select a **region** for the cluster. During Private Beta, clusters are only available in the Paris region.
32+
33+
4. Select a **Kafka® version** to run on the cluster. Only one pre-selected Kafka® version is available during Private Beta.
34+
35+
5. Select the **number of nodes** (brokers) you want in the cluster, either **3 nodes** for a highly-available cluster enabling data replication, or **1 node** for a cluster suitable for testing and development. During Private Beta, the number of nodes cannot be changed after cluster creation.
36+
37+
6. Select a **node type**. Choose between [dedicated or shared nodes](/clusters-for-kafka/concepts/#node), depending on your workload requirements and use case. For shared nodes, various types are available, each offering different cost-performance ratios.
38+
39+
7. Configure **network connectivity**. During Private Beta, connectivity to clusters is facilitated exclusively through **Private Networks**. Select a Private Network from the dropdown list to attach your cluster to.
40+
41+
8. Create **credentials** by defining a username and password. These will be used when connecting to your cluster. During Private Beta, only one user can be created per cluster, and the username is not modifiable after creation (though the password can be changed).
42+
43+
9. Enter a **name**, and (optionally), **tags** to identify your cluster.
44+
45+
10. Check the estimated cost summary, then click **Create cluster**.
46+
47+
Your cluster is created, and you are taken to its **Overview** page in the console.
2148

2249
## How to connect to your cluster
2350

24-
TODO
51+
All clients that want to connect to your cluster must:
52+
53+
- Have downloaded the cluster's [TLS certificate](/clusters-for-kafka/how-to/manage-cluster/) and configured the client to recognize it.
54+
- Be [attached to a Private Network](/vpc/how-to/attach-resources-to-pn/) in the same VPC as the cluster, or connect via a [Public Gateway](/public-gateways/how-to/create-a-public-gateway/) in the VPC
55+
- Know the cluster's [username and password](/clusters-for-kafka/how-to/connect-to-cluster/#how-to-access-the-username-and-password)
56+
57+
Once you have ensured the client satisfies the conditions above, you can facilitate connection via the framework of your choice. Code snippets are provided for Go, Python and Java; access them by following the steps below.
58+
59+
1. Click **Apache Kafka®** in the **Data and Analytics** section of the [console](https://console.scaleway.com/) side menu. A list of your clusters displays.
60+
61+
2. Click the cluster you want to connect to. Its **Overview** page displays.
62+
63+
3. In the **Connectivity** panel, click **Connect**.
64+
65+
A pop-up displays, with tabs for each sample framework: **Go**, **Python** and **Java**.
66+
67+
4. Click the tab of your choice to view the code sample.
68+
69+
## How to configure your cluster
70+
71+
Configuration actions that cannot currently be carried out via the Scaleway console, API or devtools include:
72+
73+
- Creating topics, events and streams
74+
- Configuring cluster parameters, such as replication factors, retention policies, and partitions
75+
- Integrating clients and consumers
76+
77+
These actions can be done via TODO HOW?
2578

2679
## How to delete a cluster
2780

28-
TODO
81+
You can delete your cluster when you no longer need it.
82+
83+
1. Click **Apache Kafka®** in the **Data and Analytics** section of the [console](https://console.scaleway.com/) side menu. A list of your clusters displays.
84+
85+
2. Click the cluster you want to delete. Its **Overview** page displays.
86+
87+
3. Click the **Settings** tab.
88+
89+
4. Click **Delete cluster**.
90+
91+
A pop-up displays, informing you that this action will permanently delete the cluster, and all data stored on its nodes will be lost.
92+
93+
5. Type **DELETE** in the box, and click **Delete cluster**.
94+
95+
The cluster is deleted, and you are returned to the product page.

0 commit comments

Comments
 (0)