-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Added kafka features config map to kafka broker docs #5622
Merged
knative-prow
merged 12 commits into
knative:main
from
Cali0707:document-custom-kafka-topics
Oct 5, 2023
Merged
Changes from 10 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
0b1e7e7
Added kafka features config map to kafka broker docs
Cali0707 d287336
Update docs/eventing/brokers/broker-types/kafka-broker/README.md
Cali0707 ec26be3
Update docs/eventing/brokers/broker-types/kafka-broker/README.md
Cali0707 75c42fe
Update docs/eventing/brokers/broker-types/kafka-broker/README.md
Cali0707 6edda01
Update docs/eventing/brokers/broker-types/kafka-broker/README.md
Cali0707 600c99a
Update docs/eventing/brokers/broker-types/kafka-broker/README.md
Cali0707 ef97b63
Update docs/eventing/brokers/broker-types/kafka-broker/README.md
Cali0707 1b29c60
Moved kafka features config info to new page
Cali0707 9e1b169
Apply suggestions from code review
Cali0707 1cbf666
Follow example from serving for documenting configmap keys
Cali0707 da73284
Merge branch 'main' into document-custom-kafka-topics
Cali0707 9dac7ea
Fix macro
Cali0707 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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
70 changes: 70 additions & 0 deletions
70
docs/eventing/brokers/broker-types/kafka-broker/configuring-kafka-features.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Configuring Kafka Features | ||
|
||
There are many different configuration options for how Knative Eventing and the Knaitve Broker for Apache Kafka interact with the Apache Kafka clusters. | ||
|
||
## Configure Knative Eventing Kafka features | ||
|
||
There are various kafka features/default values the Knative Kafka Broker uses when interacting with Kafka. | ||
|
||
### Consumer Group ID for Triggers | ||
|
||
The `triggers.consumergroup.template` value determines the template used to generate the consumer group ID used by your triggers. | ||
|
||
* **Global key:** `triggers.consumergroup.template` | ||
* **Possible values:**: Any valid [go text/template](https://pkg.go.dev/text/template) | ||
* **Default:** `{% raw %}knative-trigger-{{ .Namespace }}-{{ .Name }}{% endraw %}` | ||
|
||
**Example:** | ||
|
||
=== "Global (ConfigMap)" | ||
```yaml | ||
apiVersion: v1 | ||
kind: ConfigMap | ||
metadata: | ||
name: config-kafka-features | ||
namespace: knative-eventing | ||
data: | ||
triggers.consumergroup.template: {% raw %}"knative-trigger-{{ .Namespace }}-{{ .Name }}"{% endraw %} | ||
``` | ||
|
||
### Broker topic name template | ||
|
||
The `brokers.topic.template` values determines the template used to generate the Kafka topic names used by your brokers. | ||
|
||
* **Global Key:** `brokers.topic.template` | ||
* **Possible values:** Any valid [go text/template](https://pkg.go.dev/text/template) | ||
* **Default:** `{% raw %}knative-broker-{{ .Namespace }}-{{ .Name }}{% endraw %}` | ||
|
||
**Example:** | ||
|
||
=== "Global (ConfigMap)" | ||
```yaml | ||
apiVersion: v1 | ||
kind: ConfigMap | ||
metadata: | ||
name: config-kafka-features | ||
namespace: knative-eventing | ||
data: | ||
brokers.topic.template: {% raw %}"knative-broker-{{ .Namespace }}-{{ .Name }}"(% endraw %} | ||
``` | ||
|
||
## Channel topic name template | ||
|
||
The `channels.topic.template` value determines the template used to generate the kafka topic names used by your channels. | ||
|
||
* **Global Key:** `channels.topic.template` | ||
* **Possible values:** Any valid [go text/template](https://pkg.go.dev/text/template) | ||
* **Default:** `{% raw %}messaging-kafka.{{ .Namespace }}.{{ .Name }}{% endraw %}` | ||
|
||
**Example:** | ||
|
||
=== "Global (ConfigMap)" | ||
```yaml | ||
apiVersion: v1 | ||
kind: ConfigMap | ||
metadata: | ||
name: config-kafka-features | ||
namespace: knative-eventing | ||
data: | ||
channels.topic.template: {% raw %}"messaging-kafka.{{ .Namespace }}.{{ .Name }}"(% endraw %} | ||
``` |
Oops, something went wrong.
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.
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.
I wonder if this breaks existing links to https://knative.dev/docs/eventing/brokers/broker-types/kafka-broker/
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.
When I build these changes locally, it seemed to still work fine
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.
Thanks for double checking