Skip to content

Commit fc267b4

Browse files
update: content for style
1 parent c3f1574 commit fc267b4

File tree

2 files changed

+54
-55
lines changed

2 files changed

+54
-55
lines changed

docs/platform/concepts/tls-ssl-certificates.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,20 @@ are exceptions:
3939
information, see the [PostgreSQL
4040
documentation](https://www.postgresql.org/docs/current/ssl-tcp.html)
4141
- **Aiven for Apache Kafka®** supports different authentication methods:
42-
- Client certificate: The client requires the Aiven project CA and
43-
also the client key and certificate.
44-
- SASL over SSL: The client authenticates using a service user name
45-
and password. By default the communication is encrypted using the
46-
project CA certificate. The user configuration `letsencrypt_sasl`
47-
also allows to authenticate using a public CA instead of a project CA.
48-
For more information, see [Enable and configure SASL authentication](/docs/products/kafka/howto/kafka-sasl-auth)
49-
50-
For these services you can
51-
[Download the project CA certificates](/docs/platform/concepts/tls-ssl-certificates#download-ca-certificates)
52-
from **Overview** page of your service.
42+
- **Client certificate**. The client authenticates with a client certificate and key.
43+
This method requires the Aiven project CA certificate, the client certificate, and
44+
the client key.
45+
- **SASL over SSL**. The client authenticates with a service username and password.
46+
Communication is encrypted with the project CA certificate by default. You can
47+
enable the `letsencrypt_sasl` setting to use a public CA instead of the project CA.
48+
For details, see [Enable and configure SASL authentication](/docs/products/kafka/howto/kafka-sasl-auth).
49+
50+
You can download the project CA certificates from the <ConsoleLabel name="overview"/>
51+
page of your service. For steps, see [Download the project CA certificates](/docs/platform/concepts/tls-ssl-certificates#download-ca-certificates).
5352

5453
:::note
55-
Older/existing services may be using the Aiven project's CA, you can
56-
request switching to a browser-recognized certificate by opening support
57-
ticket and letting us know.
54+
Some older services use the Aiven project CA certificate. To switch to a
55+
browser-recognized certificate, [open a support ticket](/docs/platform/howto/support).
5856
:::
5957

6058
## Download CA certificates

docs/products/kafka/howto/kafka-sasl-auth.md

Lines changed: 42 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import ConsoleLabel from "@site/src/components/ConsoleIcons"
88
import ConsoleIcon from "@site/src/components/ConsoleIcons"
99
import RelatedPages from "@site/src/components/RelatedPages";
1010

11-
Aiven for Apache Kafka® provides [multiple authentication methods](/docs/products/kafka/concepts/auth-types) to secure your Apache Kafka® data, including the highly secure Simple Authentication and Security Layer ([SASL](https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer)) over SSL.
11+
Aiven for Apache Kafka® provides [multiple authentication methods](/docs/products/kafka/concepts/auth-types) to secure Kafka data, including Simple Authentication and Security Layer ([SASL](https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer)) over SSL.
1212

1313
## Enable SASL authentication
1414

@@ -19,8 +19,8 @@ Aiven for Apache Kafka® provides [multiple authentication methods](/docs/produc
1919
Aiven for Apache Kafka service.
2020
1. Click <ConsoleLabel name="Service settings"/>.
2121
1. Scroll to **Advanced configuration** and click **Configure**.
22-
In the **Advanced configuration** window, set `kafka_authentication_methods.sasl` to
23-
**Enabled**.
22+
1. Click <ConsoleIcon name="Add config options"/>.
23+
1. Select `kafka_authentication_methods.sasl` from the list and set the value to **Enabled**.
2424
1. Click **Save configurations**.
2525

2626
The **Connection information** in the <ConsoleLabel name="overview"/> page now
@@ -182,40 +182,40 @@ Parameters:
182182

183183
## Enable public CA for SASL authentication
184184

185-
After [enabling SASL authentication](#enable-sasl-authentication), enable
186-
the Public CA for SASL authentication if clients connecting to Kafka can't
187-
install or trust the default Project CA.
185+
After [enabling SASL authentication](#enable-sasl-authentication), enable the public CA
186+
if Kafka clients cannot install or trust the default project CA.
188187

189188
<Tabs groupId="config-methods">
190189
<TabItem value="console" label="Aiven Console" default>
191190

192191
1. Access the [Aiven Console](https://console.aiven.io) and select your
193192
Aiven for Apache Kafka service.
194193
1. Click <ConsoleLabel name="Service settings"/>.
195-
1. Scroll to **Cloud and network**, click **[...]** and select
196-
**More network configurations**.
197-
1. In the **Network configuration** window, click **Add configuration options**
198-
and select `letsencrypt_sasl` for enabling public CA for SASL authentication
199-
via regular routes or `letsencrypt_sasl_privatelink` via PrivateLink connection.
200-
1. Set the configuration value to **Enabled**.
201-
1. Click **Save configurations**.
194+
1. Go to the **Cloud and network** section, click <ConsoleLabel name="actions" /> >
195+
**More network configurations**.
196+
1. In the **Network configuration** dialog:
202197

203-
The **Connection information** in the <ConsoleLabel name="overview"/> page now
204-
allows SASL connections using either **Project CA** or **Public CA**.
198+
1. Click <ConsoleIcon name="Add config options"/>.
199+
1. Find `letsencrypt_sasl` (or `letsencrypt_sasl_privatelink` for PrivateLink).
200+
1. Select the configuration option.
201+
1. Set the value to **Enabled**.
202+
1. Click **Save configurations**.
203+
204+
The Connection information section on the <ConsoleLabel name="overview" /> page now
205+
supports SASL connections using either Project CA or Public CA.
205206

206207
</TabItem>
207208
<TabItem value="cli" label="CLI">
208209

209-
Enable public CA for SASL authentication for your Aiven for Apache Kafka service using
210-
[Aiven CLI](/docs/tools/cli):
210+
Enable the public CA for SASL authentication using the [Aiven CLI](/docs/tools/cli):
211211

212-
1. Get the name of the Aiven for Apache Kafka service:
212+
1. List the services in your project to find the Kafka service name:
213213

214214
```bash
215215
avn service list
216216
```
217217

218-
Note the `SERVICE_NAME` corresponding to your Aiven for Apache Kafka service.
218+
Note the `SERVICE_NAME` for the Kafka service.
219219

220220
1. Enable public CA for SASL authentication:
221221

@@ -242,6 +242,7 @@ curl -X PUT "https://console.aiven.io/v1/project/{project_name}/service/{service
242242
-H "Content-Type: application/json" \
243243
-d '{"user_config": {"letsencrypt_sasl": true}}' # or letsencrypt_sasl_privatelink for PrivateLink
244244
```
245+
245246
</TabItem>
246247
<TabItem value="terraform" label="Terraform">
247248

@@ -259,35 +260,35 @@ resource "aiven_kafka" "example_kafka" {
259260
}
260261
```
261262

262-
2. In order to figure out the right `port` to use for a specific route,
263-
access the [read-only `components`](https://registry.terraform.io/providers/aiven/aiven/latest/docs/data-sources/kafka#components-4)
264-
and specify appropriate filters to the [`aiven_service_component` data source](https://registry.terraform.io/providers/aiven/aiven/latest/docs/data-sources/service_component)
265-
for example:
266-
267-
```hcl
268-
data "aiven_service_component" "sc1" {
269-
project = aiven_kafka.example_project.project
270-
service_name = aiven_kafka.example_kafka.service_name
271-
component = "kafka"
272-
route = "dynamic"
273-
kafka_authentication_method = "sasl"
274-
kafka_ssl_ca = "letsencrypt"
275-
}
276-
```
263+
1. To find the correct `port` to use for a specific route, use the
264+
[read-only `components`](https://registry.terraform.io/providers/aiven/aiven/latest/docs/data-sources/kafka#components-4)
265+
list with appropriate filters in the [`aiven_service_component` data source](https://registry.terraform.io/providers/aiven/aiven/latest/docs/data-sources/service_component)
266+
267+
For example:
268+
269+
```hcl
270+
data "aiven_service_component" "sc1" {
271+
project = aiven_kafka.example_project.project
272+
service_name = aiven_kafka.example_kafka.service_name
273+
component = "kafka"
274+
route = "dynamic"
275+
kafka_authentication_method = "sasl"
276+
kafka_ssl_ca = "letsencrypt"
277+
}
278+
```
277279

278280
</TabItem>
279281
</Tabs>
280282

281283
:::note
282284

283-
- The public certificate is issued and validated by [Let's Encrypt](https://letsencrypt.org)
284-
(a widely trusted Certification Authority) for the service domain.
285-
For more information, see [How It Works](https://letsencrypt.org/how-it-works)
285+
- The public certificate is issued and validated by [Let's Encrypt](https://letsencrypt.org),
286+
widely trusted certification authority. For details, see
287+
[How It Works](https://letsencrypt.org/how-it-works)
286288

287-
- When enabling public CA for SASL authentication via PrivateLink connection, the
288-
network can take several minutes to configure until clients are able to connect.
289-
This is due to the dynamical allocation of a new port, and corresponding update of
290-
the Load Balancer route table.
289+
- When enabling the public CA over a PrivateLink connection, network configuration may
290+
take several minutes before clients can connect. A new port must be allocated and the
291+
load balancer route table updated before clients can connect.
291292

292293
:::
293294

0 commit comments

Comments
 (0)