roryfig/api-gateway-control-plane

By roryfig

•Updated 8 months ago

API Gateway control-plane - High-performance Rust API Gateway

Helm

Image

2.7K

Overview Tags

roryfig/api-gateway-control-plane repository overview

⁠API Gateway Control Plane

The Control Plane is the administrative API server that manages gateway configuration (routes, upstreams, services, plugins) stored in PostgreSQL.

⁠Quick Start

docker run -d \
  --name api-gateway-control-plane \
  -p 8080:8080 \
  -e APP__DATABASE__URL=postgres://user:pass@host:5432/api_gateway \
  roryfig/api-gateway-control-plane:latest

⁠Image Tags

Tag	Description
`latest`	Latest stable release
`vX.Y.Z`	Specific version (e.g., `v1.0.0`)
`vX.Y`	Latest patch of minor version
`vX`	Latest minor of major version

⁠Dependencies

Required:

PostgreSQL 15+

Optional:

Redis (distributed rate limiting, plugin storage)
RabbitMQ (real-time config propagation)

⁠Environment Variables

⁠Required

Variable	Description
`APP__DATABASE__URL`	PostgreSQL connection string

⁠Server

Variable	Default	Description
`APP__SERVER__HOST`	`0.0.0.0`	Bind address
`APP__SERVER__PORT`	`8080`	HTTP port

⁠Database

Variable	Default	Description
`APP__DATABASE__MAX_CONNECTIONS`	`10`	Max pool size
`APP__DATABASE__MIN_CONNECTIONS`	`2`	Min pool size

⁠Authentication

Variable	Default	Description
`APP__AUTH__JWT_SECRET`	-	JWT signing secret
`APP__AUTH__JWT_ENABLED`	`true`	Enable JWT auth
`APP__AUTH__API_KEY_ENABLED`	`true`	Enable API key auth

⁠Logging

Variable	Default	Description
`APP__LOGGING__LEVEL`	`info`	Log level
`APP__LOGGING__FORMAT`	`json`	Output format

⁠Redis (Optional)

Variable	Default	Description
`APP__REDIS__URL`	-	Redis URL
`APP__REDIS__POOL_SIZE`	`10`	Pool size

⁠RabbitMQ (Optional)

Variable	Default	Description
`APP__RABBITMQ__URL`	-	RabbitMQ URL

⁠YAML Configuration

Mount configuration files for complex setups:

# config/default.yaml
server:
  host: 0.0.0.0
  port: 8080

database:
  max_connections: 20
  min_connections: 5

logging:
  level: info
  format: json

auth:
  jwt_enabled: true
  api_key_enabled: true

rate_limit:
  requests_per_window: 1000
  window_seconds: 60
  distributed: true

redis:
  url: redis://redis:6379

rabbitmq:
  url: amqp://guest:guest@rabbitmq:5672

docker run -d \
  -v $(pwd)/config:/app/config:ro \
  -e APP__DATABASE__URL=postgres://user:pass@host:5432/api_gateway \
  -e APP__AUTH__JWT_SECRET=your-secret \
  -e APP_ENV=production \
  roryfig/api-gateway-control-plane:latest

⁠Docker Compose

version: '3.8'
services:
  postgres:
    image: postgres:15-alpine
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: api_gateway

  control-plane:
    image: roryfig/api-gateway-control-plane:latest
    ports:
      - "8080:8080"
    environment:
      APP__DATABASE__URL: postgres://postgres:postgres@postgres:5432/api_gateway
      APP__AUTH__JWT_SECRET: ${JWT_SECRET}
    depends_on:
      - postgres

⁠Health Check

curl http://localhost:8080/health

⁠API Endpoints

# List upstreams
curl http://localhost:8080/api/v1/upstreams

# Create route
curl -X POST http://localhost:8080/api/v1/routes \
  -H "Content-Type: application/json" \
  -d '{"name": "my-route", "path": "/api/*"}'

⁠Links

Tag summary

Recent tags

Content type