Skip to content

Conversation

@jclarysse
Copy link
Contributor

@jclarysse jclarysse commented Nov 23, 2025

Describe your changes

Document Kafka public CA for SASL authentication, change preview:

⚠️ This PR is currently in draft status as we need to wait for some console update before merge.

FLEET-6161

Checklist

  • The first paragraph of the page is on one line.
  • The other lines have a line break at 90 characters.
  • I checked the output.
  • I applied the style guide.
  • My links start with /docs/.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Nov 23, 2025

Deploying aiven-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: c97faef
Status: ✅  Deploy successful!
Preview URL: https://3db49502.aiven-docs.pages.dev
Branch Preview URL: https://jclarysse-public-ca-for-kafk.aiven-docs.pages.dev

View logs

@jclarysse jclarysse marked this pull request as draft November 23, 2025 17:40
@jclarysse jclarysse force-pushed the jclarysse/public-ca-for-kafka-sasl-support branch 3 times, most recently from 25f3d7d to 281f7de Compare November 23, 2025 19:22
@harshini-rangaswamy harshini-rangaswamy self-assigned this Nov 24, 2025
Copilot finished reviewing on behalf of harshini-rangaswamy November 26, 2025 08:57
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR documents the new public CA feature for Kafka SASL authentication, enabling clients to use Let's Encrypt certificates instead of the Aiven project CA when connecting via SASL.

  • Added comprehensive documentation for enabling public CA with SASL authentication via console, CLI, API, and Terraform
  • Documented new configuration parameters letsencrypt_sasl and letsencrypt_sasl_privatelink
  • Updated TLS/SSL certificate requirements to explain both SASL and client certificate authentication methods

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
docs/products/kafka/howto/kafka-sasl-auth.md Added new section "Enable public CA for SASL authentication" with instructions for all configuration methods, plus updated introductory text to clarify SASL over SSL
static/includes/config-kafka.md Added documentation for letsencrypt_sasl, updated letsencrypt_sasl_privatelink description for consistency, and added sasl_oauthbearer_allowed_urls parameter
docs/platform/concepts/tls-ssl-certificates.md Restructured Kafka certificate requirements section to distinguish between client certificate and SASL over SSL authentication methods

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 223 to 233
<tr>
<td>
<div className="param"><p className="name"><Link id="letsencrypt_sasl"/><Link to="#letsencrypt_sasl"><strong>letsencrypt_sasl</strong></Link></p><p><code className="type">boolean,null</code></p></div>
<p className="title">Use Let's Encrypt CA for Kafka SASL</p>
<div className="description"><p>Use a Let's Encrypt certificate authority (CA) for Kafka SASL authentication. (Default: False)</p></div>
<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jclaryssse these parameters are auto-generated. A scheduled job updates them twice a month, and I manually triggered it to fetch the latest service definitions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See - #1196

@harshini-rangaswamy harshini-rangaswamy force-pushed the jclarysse/public-ca-for-kafka-sasl-support branch from a238f88 to c97faef Compare November 26, 2025 09:35
Copy link
Contributor

@harshini-rangaswamy harshini-rangaswamy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jclaryssse thank you for this content ⭐! I made some minor changes to language, voice and tone to align with our style guide. Feel free to merge when this feature is ready.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants