Skip to content
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

Add Doc changes for enableTls and saslAuthType for Kafka Scaler ScaledObject #1016

Merged
merged 7 commits into from
Mar 9, 2023

Conversation

dttung2905
Copy link
Contributor

Hi KEDA core dev team,
Please advise me on whether this is the correct place to add changes to the doc, given that version 2.9.0 was released just the day before this MR was made. Thanks alot !

Checklist

  • Commits are signed with Developer Certificate of Origin (DCO)

Fixes #

@dttung2905 dttung2905 requested a review from a team as a code owner December 18, 2022 07:39
@netlify
Copy link

netlify bot commented Dec 18, 2022

Deploy Preview for keda ready!

Name Link
🔨 Latest commit 5587a74
🔍 Latest deploy log https://app.netlify.com/sites/keda/deploys/6409fd97626c350008e960d6
😎 Deploy Preview https://deploy-preview-1016--keda.netlify.app/docs/2.10/scalers/apache-kafka
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Member

@JorTurFer JorTurFer left a comment

Choose a reason for hiding this comment

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

Could you move this from v2.9 to v2.10 (it applies for next version)
Please, update also the parameters list because now they will be read from metadata section and not from authentication section

@tomkerkhove
Copy link
Member

This is outdated as well so let's give @dttung2905 some time to update, let us know when you are ready @dttung2905.

@dttung2905 dttung2905 changed the title Add Doc changes for TLS and SASL being moved to TriggerAuthentication metadata Add Doc changes for enableTls and saslAuthType for Kafka Scaler ScaledObject Mar 8, 2023
Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>
Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>
Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>
Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>
@dttung2905
Copy link
Contributor Author

Hi team,
I just updated the documentation part, not sure its the best way to structure it. Please let me know your thought 🙏


**Credential based authentication:**

**SASL:**

- `sasl` - Kafka SASL auth mode. (Values: `plaintext`, `scram_sha256`, `scram_sha512`, `oauthbearer` or `none`, Default: `none`, Optional)
- `sasl` / `saslAuthType` - Kafka SASL auth mode. (Values: `plaintext`, `scram_sha256`, `scram_sha512`, `oauthbearer` or `none`, Default: `none`, Optional)
Copy link
Member

Choose a reason for hiding this comment

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

I think that we can reuse the same key as it can be recovered from both places

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes thats what I have in mind too as I start writing the doc 😂. Should be good to reuse the same key to avoid further confusion


**TLS:**

- `tls` - To enable SSL auth for Kafka, set this to `enable`. If not set, TLS for Kafka is not used. (Values: `enable`, `disable`, Default: `disable`, Optional)
- `tls` / `enableTls` - To enable SSL auth for Kafka, set this to `enable` / `disable`. If not set, TLS for Kafka is not used. (Values: `enable` / `true`, `disable` / `false`, Default: `disable` / `false`, Optional)
Copy link
Member

Choose a reason for hiding this comment

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

I think that we can reuse the same key as it can be recovered from both places

Copy link
Member

@zroubalik zroubalik left a comment

Choose a reason for hiding this comment

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

agree with @JorTurFer on this

Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>
Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>
Signed-off-by: dttung2905 <ttdao.2015@accountancy.smu.edu.sg>
@zroubalik zroubalik merged commit f161a36 into kedacore:main Mar 9, 2023
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.

4 participants