Skip to content

Commit edc7d3c

Browse files
RoRoJRoRoJ
committed
feat(kafka): finish main doc
1 parent 5298f6a commit edc7d3c

File tree

9 files changed

+235
-62
lines changed

9 files changed

+235
-62
lines changed

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

Lines changed: 0 additions & 5 deletions
This file was deleted.

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

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,36 @@ dates:
77
productIcon: TODO
88
noindex: true
99
---
10-
## Cat 1
1110

12-
### FAQ 1
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>
1314

14-
TODO
15+
## General
1516

16-
### FAQ 2
17+
### What is Clusters for Apache Kafka®?
1718

18-
TODO
19+
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. This product is currently in Private Beta.
20+
21+
### What limitations apply during the Private Beta?
22+
23+
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:
24+
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).
27+
- Clusters can only be provisioned with either one or three nodes (brokers).
28+
- Storage is fixed at 100 GB per node.
29+
- Connectivity to the cluster is facilitated exclusively through Private Networks.
30+
- Only one set of credentials (username and password) can be created per cluster.
31+
32+
We aim to improve and develop the product based on feedback received during the beta stage.
33+
34+
## Billing
35+
36+
### How am I billed for Clusters for Apache Kafka®?
37+
38+
Clusters for Apache Kafka® are free of charge during Private Beta, and you will not be billed.
39+
40+
### How will pricing work in the future?
41+
42+
We anticipate that future pricing will be based on TODO.

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

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: How to connect to a Cluster for Apache Kafka®
3+
description: Learn how to connect to your Scaleway Cluster for Apache Kafka® wih Scaleway, and understand how to securely establish a connection using TLS certificates and credentials.
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+
You can use different frameworks to connect to your Cluster for Apache Kafka®, and integrate it with your applications.
16+
17+
All clients that want to connect to your cluster must:
18+
19+
- Have downloaded the cluster's [TLS certificate](TODO) and configured the client to recognize it
20+
- Be attached to a Private Network in the same VPC as the cluster, or connect via a Public Gateway in the VPC
21+
- Know the cluster's username and password
22+
23+
<Requirements />
24+
25+
- A Scaleway account logged into the [console](https://console.scaleway.com)
26+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
27+
- A Cluster for Apache Kafka®
28+
29+
## How to download the TLS certificate
30+
31+
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.
32+
33+
2. Click the cluster you want to connect to. Its **Overview** page displays.
34+
35+
3. In the **Connectivity** panel, click **Download** next to the TLS certificate.
36+
37+
The TLS certificate is downloaded to your local device. If using Java, import it into a truststore and configure your `client.properties` appropriately. For other types of client (e.g. Python, Go, CLI), you may be able to use the certificate directly by setting its location in your Kafka consumer configuration code (e.g. `'ssl.ca.location': '/path/to/ca.crt'`).
38+
39+
TODO CHECK:
40+
- Check all of the info above
41+
- Add more info for
42+
- Server side TLS only? (no client cert needed?)
43+
- What CA is used? Is it well known or private? Is the TLS cert in crt or pem format?
44+
45+
## How to ensure clients have network access
46+
47+
Any clients wanting to connect to the cluster must either be attached to a Private Network in the same VPC as the cluster, or connect via a Public Gateway in the VPC.
48+
49+
TODO set up static NAT to map ports/IP address?
50+
51+
See the following pages for help:
52+
- [How to attach a resource to a Private Network](/vpc/how-to/attach-resources-to-pn/)
53+
- [How to create a Public Gateway](/public-gateways/how-to/create-a-public-gateway/)
54+
- [Getting the most from Private Networks](/vpc/reference-content/getting-most-private-networks/)
55+
56+
## How to access the username and password
57+
58+
The username and password for a Cluster for Apache Kafka® are defined when [creating the cluster](/clusters-for-kafka/how-to/create-cluster/). During Private Beta, only one user can be created per cluster. The username cannot be modified after creation, but the password can be changed at any time.
59+
60+
If you need a reminder of the username after creating the cluster, follow the steps below. You cannot view the password you set, but you can change it to a new one.
61+
62+
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.
63+
64+
2. Click the cluster you want to connect to. Its **Overview** page displays.
65+
66+
3. Click the **Users** tab.
67+
68+
The username displays in the list of users. Click **Change password** if you have forgotten the password and need to change it to a new one.
69+
70+
## How to connect to the cluster
71+
72+
Once you have ensured that the client in question has the cluster's TLS certificate, appropriate network access and the correct username and password, 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.
73+
74+
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.
75+
76+
2. Click the cluster you want to connect to. Its **Overview** page displays.
77+
78+
3. In the **Connectivity** panel, click **Connect**.
79+
80+
A pop-up displays, with tabs for each sample framework: **Go**, **Python** and **Java**.
81+
82+
4. Click the tab of your choice to view the code sample.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
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.
3+
description: Learn how to create a Cluster for Apache Kafka® with Scaleway, and get your hosted, fully-managed Kafka infrastructure up and running with just a few clicks.
44
dates:
55
validation: 2025-08-20
66
posted: 2025-08-20

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: How to delete to a Cluster for Apache Kafka®
3+
description: Learn how to safely delete your Scaleway Cluster for Apache Kafka® wih Scaleway in 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+
You can delete your cluster at any time by following the steps on this page.
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+
- A Cluster for Apache Kafka®
22+
23+
## How to delete a cluster
24+
25+
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.
26+
27+
2. Click the cluster you want to delete. Its **Overview** page displays.
28+
29+
3. Click the **Settings** tab.
30+
31+
4. Click **Delete cluster**.
32+
33+
A pop-up displays, informing you that this action will permanently delete the cluster, and all data stored on its nodes will be lost.
34+
35+
5. Type **DELETE** in the box, and click **Delete cluster**.
36+
37+
The cluster is deleted, and you are returned to the product page.

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

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: How to manage to a Cluster for Apache Kafka®
3+
description: Learn how to manage to your Scaleway Cluster for Apache Kafka® wih Scaleway, including editing its details, renewing its TLS certificate and more.
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+
After creating your cluster, you can renew its TLS certificate, change the attached Private Network, and change its password.
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+
- A Cluster for Apache Kafka®
22+
23+
## How to renew the TLS certificate
24+
25+
You may want or need to renew the cluster's TLS certificate for reasons of security, compliance or if the certificate expires. Follow the steps below to renew the certificate:
26+
27+
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.
28+
29+
2. Click the cluster whose certificate you want to renew. Its **Overview** page displays.
30+
31+
3. In the **Connectivity** panel, click **Renew** next to the TLS certificate.
32+
33+
A pop-up displays, warning you that you will not be able to connect to your cluster using the previous certificate, and you will need to download the new certificate for all clients.
34+
35+
4. Click **Renew TLS certificate** to confirm.
36+
37+
The certificate is renewed, and you are returned to the cluster's **Overview** page. Remember to download the new certificate for all clients that want to connect to the cluster.
38+
39+
## How to change the attached Private Network
40+
41+
In order to facilitate connectivity to your cluster, it must always be attached to a Private Network. A cluster can only be attached to one Private Network at a time, but you can change the attached Private Network as follows:
42+
43+
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.
44+
45+
2. Click the cluster whose certificate you want to renew. Its **Overview** page displays.
46+
47+
3. In the **Network** panel, click **Detach Private Network**
48+
49+
TODO
50+
51+
## How to change the password
52+
53+
During Private Beta, each cluster can have only one set of user credentials, which are set during cluster creation. You cannot change the username after creating the cluster, but you can change the password at any time:
54+
55+
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.
56+
57+
2. Click the cluster whose password you want to change. Its **Overview** page displays.
58+
59+
3. Click the **Users** tab.
60+
61+
4. Click **Change password** next to the cluster's username credential.
62+
63+
A pop-up displays, prompting you to change the password. Either enter the new password of your choice, or click **Generate password** to generate a new random password.
64+
65+
Ensure that you copy or remember the password, as it will not be displayed again after this screen.
66+
67+
5. Click **Update**.
68+
69+
The password is changed and you are returned to your cluster's **Overview** page.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ noindex: true
55
---
66

77
<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"
8+
productName="Clusters for Apache Kafka®"
9+
productLogo="TODO"
10+
description="Scaleway Clusters for Apache Kafka® provides a secure, fully-managed infrastructure for your Apache Kafka® deployments."
11+
url="/clusters-for-kafka/quickstart/"
12+
label="Clusters for Apache Kafka® Quickstart"
1313
/>
1414

1515
## Getting Started
@@ -18,9 +18,9 @@ noindex: true
1818
<SummaryCard
1919
title="Quickstart"
2020
icon="rocket"
21-
description="Learn how to add and manage your billing information in a few steps."
21+
description="Learn how to add and manage your clusters in a few steps."
2222
label="View Quickstart"
23-
url="/billing/quickstart"
23+
url="/clusters-for-kafka/quickstart/"
2424
/>
2525
<SummaryCard
2626
title="Concepts"

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,14 @@ import Requirements from '@macros/iam/requirements.mdx'
1515
- A Scaleway account logged into the [console](https://console.scaleway.com)
1616
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
1717

18+
## How to create a Cluster for Apache Kafka®
19+
20+
TODO
21+
22+
## How to connect to your cluster
23+
24+
TODO
25+
26+
## How to delete a cluster
27+
1828
TODO

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

Lines changed: 0 additions & 44 deletions
This file was deleted.

0 commit comments

Comments
 (0)