ryerraguntla commented on code in PR #3519:
URL: https://github.com/apache/iggy/pull/3519#discussion_r3812676745


##########
gateways/kafka/README.md:
##########
@@ -0,0 +1,63 @@
+# Kafka gateway (`iggy-gateway-kafka`)
+
+Foundation layer for 
[apache/iggy#3421](https://github.com/apache/iggy/issues/3421): a TCP listener 
on the Kafka wire port that decodes requests, validates scoped API keys and 
versions, and returns stub responses.
+
+> **Stub warning:** no API persists or reads real data yet. Produce, Fetch, 
and ListOffsets return retriable `NOT_LEADER_OR_FOLLOWER` (6) so clients keep 
data locally / retry elsewhere instead of trusting a fake success. CreateTopics 
does **not** create topics; valid requests return `NOT_CONTROLLER` (41). 
Metadata still reports requested topics as unknown. Persistence lands with the 
Iggy bridge (see [docs/SCOPE.md](docs/SCOPE.md)).
+
+## Run
+
+```bash
+cargo run -p iggy-gateway-kafka
+```
+
+Default bind: `127.0.0.1:9093`. Environment variables:
+
+| Variable | Default | Description |
+| --- | --- | --- |
+| `IGGY_KAFKA_BIND_ADDR` | `127.0.0.1:9093` | TCP address to listen on |
+| `IGGY_KAFKA_ADVERTISED_HOST` | bind IP | Hostname/IP clients use to reach 
this broker (required when binding to `0.0.0.0`/`::`) |
+| `IGGY_KAFKA_ADVERTISED_PORT` | bind port | Port advertised in Metadata 
responses |
+| `IGGY_KAFKA_MAX_CONNECTIONS` | `1024` | Maximum concurrent connections 
before new ones are rejected |
+| `IGGY_KAFKA_MAX_FRAME_SIZE` | `8388608` | Maximum accepted request frame 
size in bytes |
+| `IGGY_KAFKA_IDLE_TIMEOUT_SECS` | `600` | Seconds a connection may sit idle 
before the next frame's length prefix arrives |
+| `IGGY_KAFKA_READ_TIMEOUT_SECS` | `15` | Seconds allowed to read a frame body 
once its length prefix arrives |
+| `IGGY_KAFKA_WRITE_TIMEOUT_SECS` | `10` | Seconds allowed to write a response 
frame |
+| `IGGY_KAFKA_SHUTDOWN_DRAIN_TIMEOUT_SECS` | `25` | Seconds graceful shutdown 
waits for in-flight connections before abandoning them |
+
+## Test
+
+```bash
+cargo test -p iggy-gateway-kafka
+```
+
+259 regression tests across 12 suites — see 
[docs/TEST_SUITE.md](docs/TEST_SUITE.md) for the full catalog.

Review Comment:
   README.md and MANUAL_TESTING.md no longer state hard counts.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to