How scality/osis works
Main Components
a. Core Components:
• OSIS REST API Layer (ScalityOsisController)
• Security Layer (JWT and Basic Authentication)
• Core Service Layer (ScalityOsisService)
• Redis Cache Layer
• Storage Platform Clients
b. External Systems:
• VMware Cloud Director OSE
• Scality RING Storage
• Redis Cache Server
• Vault Admin Service
• Utapi Service (Usage metrics)
Architecture Patterns to Highlight
• Layered Architecture:
• API Layer (osis-app module)
• Core Business Logic (osis-core module)
• Storage Platform Integration (storage-platform-clients module)
• Security Layer (JWT/Basic Auth)
• Caching Layer (Redis)
┌─────────────────────────────────────────────────────────────┐
• VMware Cloud Director OSE │
• ┬─────────────────────────────┘
┌───────────────────────────────▼─────────────────────────────┐
• OSIS REST API │
• (ScalityOsisController - HTTPS/8443) │
• ┬─────────────────────────────┘
┌───────────────────────────────▼─────────────────────────────┐
• Security Layer │
• (JWT/Basic Auth + Encryption Services) │
• ┬─────────────────────────────┘
┌───────────────────────────────▼─────────────────────────────┐
• Core Service Layer │
• (ScalityOsisService Implementation) │
• ┬─────────────────────┬────────────────┬───────────┘
┌─────────▼──────────┐ ┌───────▼─────────┐ ┌───▼─────────────┐
• Redis Cache │ │ Storage Client │ │ Vault Admin │
• Layer │ │ Layer │ │ Client │
• ┬─────────┘ └───────┬─────────┘ └───┬─────────────┘
┌─────────▼──────────┐ ┌─────▼───────────┐ ┌─▼───────────────┐
• Redis Server │ │ Scality RING │ │ Vault Service │
• ┘ └─────────────────┘ └─────────────────┘
Additional Details
• SSL/TLS termination at 8443
• Authentication flow paths
• Cache interaction patterns
• Encryption/Decryption points
• Health check endpoints
• Metrics collection points
Important Relationships to Highlight
• OSE to OSIS API communication
• Security layer intercepting all requests
• Service layer orchestrating between different clients
• Cache interaction patterns
• Storage platform integration points
Technical Specifications to Note
• Java Spring Boot Application
• HTTPS endpoints
• Redis caching
• JWT/Basic Authentication
• AES256GCM encryption
• Docker containerization
Remember to include version information and any relevant configuration dependencies in supplementary documentation.