Skip to content

Commit 5298f6a

Browse files
RoRoJRoRoJ
committed
feat(kafka): start doc
1 parent b3eabc3 commit 5298f6a

File tree

8 files changed

+269
-0
lines changed

8 files changed

+269
-0
lines changed

‎pages/clusters-for-kafka/additional-content/index.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Clusters for Apache Kafka® - Additional content
3+
description: Clusters for Apache Kafka® Additional content
4+
noindex: true
5+
---

‎pages/clusters-for-kafka/concepts.mdx‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Clusters for Apache Kafka® - Concepts
3+
description: Understand the key concepts for Clusters for Apache Kafka®.
4+
tags: billing account pricing payment
5+
dates:
6+
posted: 2025-08-20
7+
validation: 2025-08-20
8+
noindex: true
9+
---
10+
11+
<Message type="note">
12+
Clusters for Apache Kafka® is currently in [Private Beta](https://www.scaleway.com/en/betas/) and available to selected testers only.
13+
</Message>
14+
15+
## Cluster
16+
17+
A cluster is a deployment of Apache Kafka®. It consists of one or more nodes (called **brokers**) that work together to store, manage and distribute event streams. [Data replication](#data-replication) across the cluster ensures high availability and robustness.
18+
19+
## Clusters for Apache Kafka®
20+
21+
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.
22+
23+
## Credentials
24+
25+
Credentials consist of a username and password that allow you to connect to your cluster. These are defined during cluster creation. During Private Beta, a limit of one user (ie one set of credentials) per cluster is applied.
26+
27+
## Data replication
28+
29+
Data replication is the mechanism that ensures event data is copied across multiple brokers in a cluster, for fault tolerance and high availability. If a node fails, data replication means Apache Kafka® can keep serving data without downtime or data loss.
30+
31+
## Endpoint
32+
33+
During Private Beta, access to your Cluster for Apache Kafka® is via private endpoints only. When creating your cluster, you must attach it to a [Private Network](/vpc/concepts/#private-networks), and all nodes in the cluster receive a private IPv4 endpoint on this network. Endpoints are in a format similar to `bf610fb0-f7eb-4ec3-a893...634aea.Kafka.fr-par.scw.cloud`.
34+
35+
## Event streaming
36+
37+
Clusters for Apache Kafka® is specifically designed for implementing event streaming at scale. Event streaming is the process of capturing, storing and processing a continuous flow of events in real time. Each event represents something that happened,e.g.`User added item to cart`, `User clicked 'Pay now'`, `Payment was rejected by bank`. Events are stored in topics, e.g. `Inventory`, `Payment`, `Orders`. Typically, programs and microservices subscribe to these topics to consume their events and take action in relation to them, e.g. `Generate invoice`, `Check for fraud`, `Program delivery`.
38+
39+
## Node
40+
41+
A Cluster for Apache Kafka® consists of one or more nodes, also called **brokers**. Nodes work together to store, manage and distribute event streams. When creating a cluster, you can choose between **dedicated** nodes or **shared** nodes, based on your workload requirements, budget and use case:
42+
43+
- **Dedicated node**: Runs only your cluster, with no other customers sharing the broker's resources.
44+
- **Shared node**: Runs your cluster along with other customers', on the same broker.
45+
46+
## Storage
47+
48+
A cluster's storage is used to persist events, so they can be reliably consumed by services and applications. During Private Beta, each Cluster for Cluster for Apache Kafka® has a fixed amount of 100 GB of storage per node.
49+
50+
## TLS certificate
51+
52+
A TLS certificate (aka SSL certificate) is a digital credential that encrypts data in transit and verifies the identity of a server or client. Scaleway generates a TLS certificate for each Cluster for Apache Kafka®, and all clients connecting to the cluster must install this certificate in order to be authenticated. This ensures secure and encrypted communication between nodes (brokers) and clients.
53+
54+
## Users
55+
56+
See [credentials](#credentials).
57+

‎pages/clusters-for-kafka/faq.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Clusters for Apache Kafka® FAQ
3+
description: Discover Clusters for Apache Kafka® TODO
4+
dates:
5+
validation: 2025-08-20
6+
posted: 2025-08-20
7+
productIcon: TODO
8+
noindex: true
9+
---
10+
## Cat 1
11+
12+
### FAQ 1
13+
14+
TODO
15+
16+
### FAQ 2
17+
18+
TODO

‎pages/clusters-for-kafka/how-to/create-cluster.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: How to create a Cluster for Apache Kafka®
3+
description: Learn how to create a Cluster for Apache Kafka® wih Scaleway, and get your hosted, fully-managed Kafka infrastructure up and running with just a few clicks.
4+
dates:
5+
validation: 2025-08-20
6+
posted: 2025-08-20
7+
noindex: true
8+
---
9+
import Requirements from '@macros/iam/requirements.mdx'
10+
11+
<Message type="note">
12+
Clusters for Apache Kafka® is currently in [Private Beta](https://www.scaleway.com/en/betas/) and available to selected testers only.
13+
</Message>
14+
15+
This page shows you how to create a Cluster for Apache Kafka® via the Scaleway console.
16+
17+
<Requirements />
18+
19+
- A Scaleway account logged into the [console](https://console.scaleway.com)
20+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
21+
22+
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.
23+
24+
2. Click **Create cluster**. The creation wizard displays.
25+
26+
3. Select a **region** for the cluster. During Private Beta, clusters are only available in the Paris region.
27+
28+
4. Select a **Kafka® version** to run on the cluster. Only one pre-selected Kafka® version is available during Private Beta.
29+
30+
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.
31+
32+
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.
33+
34+
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.
35+
36+
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).
37+
38+
9. Enter a **name**, and (optionally), **tags** to identify your cluster.
39+
40+
10. Check the estimated cost summary, then click **Create cluster**.
41+
42+
Your cluster is created, and you are taken to its **Overview** page in the console.

‎pages/clusters-for-kafka/how-to/index.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Clusters for Apache Kafka® - How Tos
3+
description: Clusters for Apache Kafka® How Tos
4+
noindex: true
5+
---

‎pages/clusters-for-kafka/index.mdx‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: Clusters for Apache Kafka® Documentation
3+
description: Dive into Scaleway Clusters for Apache Kafka® with our quickstart guides, how-tos and more.
4+
noindex: true
5+
---
6+
7+
<ProductHeader
8+
productName="Billing"
9+
productLogo="accountBilling"
10+
description="Billing management features provide a comprehensive overview of our billing features that help you monitor and understand your Scaleway cloud expenditure, pay your invoice, and effectively manage your budget."
11+
url="/billing/quickstart"
12+
label="Billing Quickstart"
13+
/>
14+
15+
## Getting Started
16+
17+
<Grid>
18+
<SummaryCard
19+
title="Quickstart"
20+
icon="rocket"
21+
description="Learn how to add and manage your billing information in a few steps."
22+
label="View Quickstart"
23+
url="/billing/quickstart"
24+
/>
25+
<SummaryCard
26+
title="Concepts"
27+
icon="info"
28+
description="Core concepts that give you a better understanding of Scaleway billing."
29+
label="View Concepts"
30+
url="/billing/concepts"
31+
/>
32+
<SummaryCard
33+
title="How-tos"
34+
icon="help-circle-outline"
35+
description="Check our guides to add and manage billing information"
36+
label="View How-tos"
37+
url="/billing/how-to/"
38+
/>
39+
40+
</Grid>
41+
42+
## FAQ
43+
44+
<Grid>
45+
<Card
46+
title="How am I billed for Scaleway services?"
47+
url="/billing/faq/#how-am-i-billed-for-scaleway-services"
48+
label="Read more"
49+
/>
50+
<Card
51+
title="When are invoices issued?"
52+
url="/billing/faq/#when-are-invoices-issued"
53+
label="Read more"
54+
/>
55+
<Card
56+
title="Which payment methods does Scaleway accept?"
57+
url="/billing/faq/#which-payment-methods-does-scaleway-accept"
58+
label="Read more"
59+
/>
60+
<Card
61+
title="How can I pay my invoice?"
62+
url="/billing/faq/#how-can-i-pay-my-invoice"
63+
label="Read more"
64+
/>
65+
</Grid>
66+
67+
<ClickableBanner
68+
productLogo="cli"
69+
title="Billing API"
70+
description="Learn how to manage your Scaleway billing through the API."
71+
url="https://www.scaleway.com/en/developers/api/billing/"
72+
label="Go to billing API"
73+
/>
74+
75+
## Changelog
76+
77+
<ChangelogList
78+
productName="billing"
79+
numberOfChanges={3}
80+
/>

‎pages/clusters-for-kafka/quickstart.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Clusters for Apache Kafka® - Quickstart
3+
description: Quickstart guide to setting up and managing Scaleway Clusters for Apache Kafka®.
4+
tags: cluster apache kafka
5+
dates:
6+
validation: 2025-08-20
7+
posted: 2025-08-20
8+
noindex: true
9+
---
10+
import Requirements from '@macros/iam/requirements.mdx'
11+
12+
13+
<Requirements />
14+
15+
- A Scaleway account logged into the [console](https://console.scaleway.com)
16+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
17+
18+
TODO

‎pages/clusters-for-kafka/troubleshooting/index.mdx‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Clusters for Apache Kafka®
3+
description: Find troubleshooting resources for resolving issues with Scaleway Clusters for Apache Kafka®.
4+
dates:
5+
posted: 2025-08-20
6+
productIcon: TODO
7+
noindex: true
8+
---
9+
10+
<ProductHeader
11+
productName="Clusters for Apache Kafka® troubleshooting"
12+
productLogo="TODO"
13+
description="Discover how to solve the most common issues with Scaleway Clusters for Apache Kafka®"
14+
/>
15+
16+
## Featured Pages
17+
18+
<Grid>
19+
<Card
20+
title="Clusters for Apache Kafka® FAQ"
21+
description="General info on Scaleway Clusters for Apache Kafka®."
22+
url="/clusters-for-kafka/faq"
23+
label="See more"
24+
/>
25+
<Card
26+
title="TODO"
27+
description="TODO"
28+
url="TODO"
29+
label="See more"
30+
/>
31+
<Card
32+
title="TODO"
33+
description="TODO"
34+
url="TODO"
35+
label="See more"
36+
/>
37+
</Grid>
38+
39+
## Clusters for Apache Kafka® troubleshooting pages
40+
41+
<LinksList>
42+
- TODO
43+
- TODO
44+
</LinksList>

0 commit comments

Comments
 (0)