feat: add essential Kafka client security config #174
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit updates the generated markdown so that it includes the essential Kafka config required for clients. This makes it easier for someone using the markdown doc from an AsyncAPI doc to get started with creating a Kafka client. Signed-off-by: Dale Lane <dale.lane@uk.ibm.com>
|
inspired by a discussion on Slack |
|
Example output: AsyncAPI: asyncapi: '2.2.0'
info:
title: Streetlights Kafka API
version: '1.0.0'
description: |
The Smartylighting Streetlights API allows you to remotely manage the city lights.
servers:
test:
url: test.mykafkacluster.org:8092
protocol: kafka
description: Test brokerwill generate: # Streetlights Kafka API 1.0.0 documentation
The Smartylighting Streetlights API allows you to remotely manage the city lights.
## Table of Contents
* [Servers](#servers)
* [Channels](#channels)
## Servers
### **test** Server
| URL | Protocol | Description |
|---|---|---|
| test.mykafkacluster.org:8092 | kafka | Test broker |
#### Security Requirements
| Type | Description | security.protocol | sasl.mechanism |
|---|---|---|---|
| - | - | PLAINTEXT | - |rendered as: Streetlights Kafka API 1.0.0 documentationThe Smartylighting Streetlights API allows you to remotely manage the city lights. Table of ContentsServerstest Server
Security Requirements
|
|
Example output: AsyncAPI: asyncapi: '2.2.0'
info:
title: Streetlights Kafka API
version: '1.0.0'
description: |
The Smartylighting Streetlights API allows you to remotely manage the city lights.
servers:
test:
url: test.mykafkacluster.org:8092
protocol: kafka-secure
description: Test brokerwill generate: # Streetlights Kafka API 1.0.0 documentation
The Smartylighting Streetlights API allows you to remotely manage the city lights.
## Table of Contents
* [Servers](#servers)
* [Channels](#channels)
## Servers
### **test** Server
| URL | Protocol | Description |
|---|---|---|
| test.mykafkacluster.org:8092 | kafka | Test broker |
#### Security Requirements
| Type | Description | security.protocol | sasl.mechanism |
|---|---|---|---|
| - | - | SSL | - |rendered as: Streetlights Kafka API 1.0.0 documentationThe Smartylighting Streetlights API allows you to remotely manage the city lights. Table of ContentsServerstest Server
Security Requirements
|
|
Example output: AsyncAPI: asyncapi: '2.2.0'
info:
title: Streetlights Kafka API
version: '1.0.0'
description: |
The Smartylighting Streetlights API allows you to remotely manage the city lights.
servers:
test:
url: test.mykafkacluster.org:8092
protocol: kafka-secure
description: Test broker
security:
- saslScram: []
components:
securitySchemes:
saslScram:
type: scramSha512
description: create credentials in the dev portalwill generate: # Streetlights Kafka API 1.0.0 documentation
The Smartylighting Streetlights API allows you to remotely manage the city lights.
## Table of Contents
* [Servers](#servers)
* [Channels](#channels)
## Servers
### **test** Server
| URL | Protocol | Description |
|---|---|---|
| test.mykafkacluster.org:8092 | kafka-secure | Test broker |
#### Security Requirements
| Type | Description | security.protocol | sasl.mechanism |
|---|---|---|---|
| scramSha512 | create credentials in the dev portal | SASL_SSL | SCRAM-SHA-512 |rendered as: Streetlights Kafka API 1.0.0 documentationThe Smartylighting Streetlights API allows you to remotely manage the city lights. Table of ContentsServerstest Server
Security Requirements
|
magicmatatjahu
requested changes
Oct 4, 2021
There was a problem hiding this comment.
@dalelane Thanks for another contribution! :) Only some small suggestions, overall good 👍🏼
A few minor fixes Signed-off-by: Dale Lane <dale.lane@uk.ibm.com>
|
Thanks for the review! I've added a commit to address the bits you caught. |
magicmatatjahu
approved these changes
Oct 6, 2021
There was a problem hiding this comment.
@dalelane Thanks! I don't have any comments to code, it's great :)
|
Kudos, SonarCloud Quality Gate passed!
|
|
🎉 This PR is included in version 0.15.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
@all-contributors please add @dalelane for code, ideas |
|
I've put up a pull request to add @dalelane! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit updates the generated markdown so that it includes
the essential Kafka config required for clients.
This makes it easier for someone using the markdown doc from an
AsyncAPI doc to get started with creating a Kafka client.
Signed-off-by: Dale Lane dale.lane@uk.ibm.com