How scality/cosi-driver works
Main Components
a. Core Driver Components:
• COSI Driver Service (Main component)
• Identity Server
• Provisioner Server
• gRPC Server/Client Layer
b. External Systems:
• Kubernetes API Server
• Scality S3 Storage
• IAM Service
• COSI Controller (External component that interacts with the driver)
• COSI Driver Pod(s)
• COSI Controller
• Kubernetes API Server
External Services (Separate Boundary)
• Scality S3 Storage
• IAM Service
Component Details
• Identity Server (handles identity operations)
• Provisioner Server (manages bucket provisioning)
• gRPC Server (handles communication)
• Client Libraries (S3 and IAM clients)
b. Connection Points:
• GRPC communication channels
• API calls to external services
• Kubernetes API interactions
Specific Elements
• Rectangles: Main services and components
• Hexagons: External services
• Blue: Control flow
• Green: Data flow
• Red: Authentication/Authorization flow
Implementation Details
Technical annotations for:
• gRPC endpoints (from proto/cosi.proto)
• Storage client interfaces
• Authentication flows
• Kubernetes resource interactions (BucketClaim, BucketClass, etc.)
Deployment Context
Deployment-related components:
• Helm deployment options
• Kustomize overlay configurations
• Container runtime context
Notes for Different Environments
Small annotations for:
• Development setup
• Production configuration
• Debug mode specifics
Key Considerations:
Separation between
• Control plane (COSI driver operations)
• Data plane (S3 storage operations)
• Authentication plane (IAM operations)
Clear boundaries between
• Kubernetes cluster components
• External services
• Driver internals
Security boundaries
• RBAC configurations
• Service account permissions
• IAM authentication flows
Configuration paths
• Helm values
• Kustomize overlays
• Environment-specific settings
This system design should help developers understand both the high-level architecture and the detailed interactions between components while maintaining clarity about the project's scope and boundaries.