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.

Sign up for GitHub

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

Document how to set Kafka Topic config options #5854

Merged
merged 2 commits into from
Feb 9, 2024
Merged

Document how to set Kafka Topic config options #5854

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97c24ec
doc: documented how to set topic config
Cali0707 Feb 7, 2024
3127b35
doc: add link to allowed kafka topic config options
Cali0707 Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/eventing/brokers/broker-types/kafka-broker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,26 @@ different `name` on your Kafka Broker's `spec.config` field.
!!! note
The `default.topic.replication.factor` value must be less than or equal to the number of Kafka broker instances in your cluster. For example, if you only have one Kafka broker, the `default.topic.replication.factor` value should not be more than `1`.

Knative supports the [full set of topic config options that your version of Kafka supports](https://kafka.apache.org/documentation/#topicconfigs). To set any of these, you need to add a key to the configmap with the `default.topic.config.` prefix.
For example, to set the `retention.ms` value you would modify the `ConfigMap` to look like the following:

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: kafka-broker-config
namespace: knative-eventing
data:
# Number of topic partitions
default.topic.partitions: "10"
# Replication factor of topic messages.
default.topic.replication.factor: "3"
# A comma separated list of bootstrap servers. (It can be in or out the k8s cluster)
bootstrap.servers: "my-cluster-kafka-bootstrap.kafka:9092"
# Here is our retention.ms config
default.topic.config.retention.ms: "3600"
```

Cali0707 marked this conversation as resolved.
Show resolved Hide resolved
## Set as default broker implementation

To set the Kafka broker as the default implementation for all brokers in the Knative deployment,
Expand Down
Loading