Simplify Kafka API Listener configuration
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- cpp, kafka
- Domain
- api, backend, stream-processing
Research direction
Start by reviewing the CORE-907 proposal and the existing Kafka API listener configuration; no source files or tests are identified in the issue. Define the configuration changes needed to combine listener, advertised-listener, TLS, and SASL settings while preserving existing flexibility, then verify the success criteria and update documentation or tests as appropriate.
Written by the indexing model from the issue text.
Description
Who is this for and what problem do they have today?
Everyone who deploys a Redpanda cluster without having an intermediary config abstraction (e.g. K8s operator / custom resource) has to configure the Kafka API listeners. The configuration is very similar to Apache Kafka's listener configuration. However, I think that the configuration could be easier without giving up on the flexibility.
The full listener configuration is spread across multiple blocks and you have to match these blocks by usign a reference
What are the success criteria?
- Configuration is clearer for user (also easier to document)
- Less error prone to configure
- Same flexibility as before so that all usecases can be covered
Why is solving this problem impactful?
Makes Redpanda easier to configure and use / better developer experience at a relatively low implementation cost :-).
Additional notes
Proposed solution:
kafka_api:
- name: "kubernetes-internal"
socket: "0.0.0.0:9092"
advertised_address: "broker-0.redpanda-headless.svc.cluster.local:9092"
tls:
enabled: false
sasl:
enabled: false
- name: "external"
socket: "0.0.0.0:9093"
advertised_address: "broker-0.redpanda.com"
tls:
enabled: true
cert_filepath: "/etc/certs/cert.pem"
key_filepath: "/etc/certs/key.pem"
sasl:
enabled: true # should be enabled by default
mechanism: "SCRAM-SHA-256" # defaults to SCRAM-SHA-256
This merges several blocks that were required to configure a listener config into a single block. Before you had a block for TLS/SASL config, listener config, advertised listener config which were all separate and had to be correlated via config names (which is error prone and not necessarily idiomatic to configure).
The enabled bool on the TLS and SASL block may seem unnecessary, but it in my opinion it fosters clarity by being more explicit here for a single line that has to be written is a trade-of which I'd always go for - but this is opinionated. I like tuning configurations and code for readers and not for writers.
JIRA Link: CORE-907
- Dominant language
- C++
- Stars
- 12.6k
- Forks
- 792
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from redpanda-data/redpanda
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
redpanda-data/redpanda#31671 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
redpanda-data/redpanda#31667 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
redpanda-data/redpanda#31665 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
redpanda-data/redpanda#31624 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
redpanda-data/redpanda#31596 ·
All issues in redpanda-data/redpanda
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Sensor initialization takes very long when `--initial-sim-time` is set to current UNIX timestamp Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
gazebosim/gz-sensors#662 · 1 comment ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
comp-datalake
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/ClickHouse#121222 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
LadybirdBrowser/ladybird#12123 ·