-
Notifications
You must be signed in to change notification settings - Fork 25
feat: Kafka Public CA for SASL #1191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Deploying aiven-docs with
|
| 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 |
25f3d7d to
281f7de
Compare
There was a problem hiding this 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_saslandletsencrypt_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.
| <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> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See - #1196
a238f88 to
c97faef
Compare
harshini-rangaswamy
left a comment
There was a problem hiding this 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.
Describe your changes
Document Kafka public CA for SASL authentication, change preview:
FLEET-6161
Checklist
/docs/.