Skip to content

📝 CodeRabbit Chat: Implement requested code changes #1763

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

Open
coderabbitai wants to merge 1 commit into
base: event-gateway-v2
Choose a base branch
from
Open

📝 CodeRabbit Chat: Implement requested code changes #1763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 8 additions & 5 deletions event-gateway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,9 @@ The event gateway is configured via [`gateway-runtime/configs/config.toml`](gate

| Section | Key | Default | Description |
|---------|-----|---------|-------------|
| `server` | `websub_port` | `8080` | WebSub listener port |
| `server` | `websub_enabled` | `true` | Enable the WebSub HTTP/HTTPS listener |
| `server` | `websub_http_port` | `8080` | WebSub HTTP listener port |
| `server` | `websub_https_port` | `8443` | WebSub HTTPS listener port (used when TLS is enabled) |
| `server` | `websub_tls_enabled` | `false` | Serve the WebSub listener with HTTPS |
| `server` | `websub_tls_cert_file` | `""` | PEM certificate path for the WebSub HTTPS listener |
| `server` | `websub_tls_key_file` | `""` | PEM private key path for the WebSub HTTPS listener |
Expand All @@ -258,15 +260,16 @@ The event gateway is configured via [`gateway-runtime/configs/config.toml`](gate
All settings can be overridden via environment variables with the prefix `APIP_EGW_`:

```bash
APIP_EGW_SERVER_WEBSUB_PORT=8080
APIP_EGW_SERVER_WEBSUB_HTTP_PORT=8080
APIP_EGW_SERVER_WEBSUB_HTTPS_PORT=8443
APIP_EGW_SERVER_WEBSUB_TLS_ENABLED=true
APIP_EGW_SERVER_WEBSUB_TLS_CERT_FILE=/etc/event-gateway/tls/tls.crt
APIP_EGW_SERVER_WEBSUB_TLS_KEY_FILE=/etc/event-gateway/tls/tls.key
APIP_EGW_KAFKA_BROKERS=broker1:9092,broker2:9092
APIP_EGW_CONTROLPLANE_ENABLED=true
```

When `websub_tls_enabled=true`, the event gateway serves `https://` on `websub_port`. If the gateway controller or router points at the event gateway directly, update `router.event_gateway.websub_hub_url` to use an `https://` URL.
When `websub_tls_enabled=true`, the event gateway serves `https://` on `websub_https_port`. If the gateway controller or router points at the event gateway directly, update `router.event_gateway.websub_hub_url` to use an `https://` URL.

### Channel Bindings (`channels.yaml`)

Expand Down Expand Up @@ -341,8 +344,8 @@ docker compose build event-gateway
|----------|------|-------------|
| `GET /health` | 9002 | Liveness probe — always returns `{"status":"UP"}` |
| `GET /ready` | 9002 | Readiness probe — `{"status":"READY"}` or 503 |
| `POST /{context}/{version}/hub` | 8080 | WebSub subscribe/unsubscribe over HTTP or HTTPS |
| `POST /{context}/{version}/webhook-receiver?topic=X` | 8080 | WebSub event ingress over HTTP or HTTPS |
| `POST /{context}/{version}/hub` | 8080 / 8443 | WebSub subscribe/unsubscribe over HTTP or HTTPS |
| `POST /{context}/{version}/webhook-receiver?topic=X` | 8080 / 8443 | WebSub event ingress over HTTP or HTTPS |
| `ws://localhost:8081/{path}` | 8081 | WebSocket connection (protocol mediation) |
| Kafka UI | 7080 | Kafka topic browser at `http://localhost:7080` |

Expand Down
6 changes: 3 additions & 3 deletions event-gateway/gateway-runtime/configs/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ websub_http_port = 8080
# HTTPS port for WebSub server (used when TLS is enabled)
websub_https_port = 8443
# Set to true to serve the WebSub hub and webhook receiver over HTTPS.
websub_tls_enabled = true
websub_tls_cert_file = "/etc/event-gateway/tls/default-listener.crt"
websub_tls_key_file = "/etc/event-gateway/tls/default-listener.key"
websub_tls_enabled = false
# websub_tls_cert_file = "/etc/event-gateway/tls/default-listener.crt"
# websub_tls_key_file = "/etc/event-gateway/tls/default-listener.key"
websocket_port = 8081
admin_port = 9002
metrics_port = 9003
Expand Down