admin/cloud-services
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: serve index.html for docs directory, update README with testing instructions

Browse Source
This commit is contained in:
Chris Rai
2026-01-31 14:34:45 -05:00
parent 5e2c13c57e
commit a0ec642ca1
2 changed files with 61 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
services/gateway/README.md
View File

@@ -7,7 +7,7 @@ WebSocket API gateway for vehicle (TRex), HMI, and mobile app connections.
- Authenticates WebSocket connections via JWT
- Routes messages to Kafka topics
- Manages connection state in Redis
- Serves Swagger docs
- Serves AsyncAPI docs
## Ports
@@ -18,37 +18,56 @@ WebSocket API gateway for vehicle (TRex), HMI, and mobile app connections.
## WebSocket Endpoints
- `/ws/trex` - Vehicle connections
- `/ws/hmi` - HMI connections
- `/ws/mobile` - Mobile app connections
| Endpoint | Purpose | User-Agent |
|----------|---------|------------|
| `/session` | Vehicle (TRex) and HMI connections | `Fisker Ocean T.Rex x.x.x.x` or `HMI x.x.x.x` |
| `/secret_mobile` | Mobile app connections | `Mobile x.x.x` or `iOS x.x.x` or `Android x.x.x` |
## API Documentation
AsyncAPI specs available at `/docs/`:
- `/docs/asyncapi_mobile.yaml` - Mobile API
- `/docs/asyncapi_hmi.yaml` - HMI API
- `/docs/asyncapi_trex.yaml` - T-Rex API
- `/docs/index.html` - Interactive UI
## Testing WebSocket Connections
Install websocat:
```bash
brew install websocat
```
Test mobile endpoint:
```bash
# Connect to mobile websocket
websocat -H="User-Agent: Mobile 1.0.0" wss://gateway.mini.cloud.fiskerinc.com/secret_mobile
# Send verify message (after connecting)
{"handler":"verify","data":{"token":"<jwt_token>"}}
```
Test vehicle endpoint (requires VIN in SSL cert or header):
```bash
websocat -H="User-Agent: Fisker Ocean T.Rex 1.0.0.0 ABC123" \
-H="X-VIN: YH7DR1EA1PA000001" \
wss://gateway.mini.cloud.fiskerinc.com/session
```
## Build
```bash
# Local
go build .
# Docker
docker build -t gateway -f Dockerfile ../..
```
## Run
```bash
# Required env vars
export KAFKA_HOSTS=localhost:9092
export REDIS_HOST=localhost
export JWK_URL=https://keycloak.example.com/realms/consumer/protocol/openid-connect/certs
./gateway
# From cloud-services root
docker build --platform linux/arm64 -t gateway:latest -f services/gateway/Dockerfile .
```
## Configuration
See `deploy/base/configmap-common.yaml` for all options.
See `deploy/base/config.env` for all environment variables.
Key settings:
- `KAFKA_HOSTS` - Kafka bootstrap servers
- `REDIS_HOST/PORT` - Redis for session state
- `JWK_URL` - JWKS endpoint for JWT validation
- `DOCS` - Path to docs directory (default: `/docs`)
- `LOG_LEVEL` - debug, info, warn, error