docs consolidation work
This commit is contained in:
49
docs/modules/gateway/README.md
Normal file
49
docs/modules/gateway/README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Gateway
|
||||
|
||||
**Status:** Implemented
|
||||
**Source:** `src/Gateway/`
|
||||
**Owner:** Platform Team
|
||||
|
||||
## Purpose
|
||||
|
||||
Gateway provides API routing, authentication enforcement, and transport abstraction for StellaOps services. Acts as the single entry point for external clients with support for HTTP/HTTPS and transport-agnostic messaging via Router module.
|
||||
|
||||
## Components
|
||||
|
||||
**Services:**
|
||||
- `StellaOps.Gateway.WebService` - API gateway with routing, middleware, and security
|
||||
|
||||
**Key Features:**
|
||||
- Route configuration and service discovery
|
||||
- Authorization middleware (Authority integration)
|
||||
- Request/response transformation
|
||||
- Rate limiting and throttling
|
||||
- Transport abstraction (HTTP, TCP/TLS, UDP, RabbitMQ, Valkey)
|
||||
|
||||
## Configuration
|
||||
|
||||
See `etc/policy-gateway.yaml.sample` for gateway configuration examples.
|
||||
|
||||
Key settings:
|
||||
- Service route mappings
|
||||
- Authority issuer and audience configuration
|
||||
- Transport protocols and endpoints
|
||||
- Security policies and CORS settings
|
||||
- Rate limiting rules
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Authority (authentication and authorization)
|
||||
- Router (transport-agnostic messaging)
|
||||
- All backend services (routing targets)
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- Architecture: `./architecture.md`
|
||||
- Router Module: `../router/`
|
||||
- Authority Module: `../authority/`
|
||||
- API Reference: `../../09_API_CLI_REFERENCE.md`
|
||||
|
||||
## Current Status
|
||||
|
||||
Implemented with HTTP/HTTPS support. Integrated with Authority for token validation and authorization. Supports service routing and middleware composition.
|
||||
Reference in New Issue
Block a user