How inseefrlab/onyxia works
Main Components
• Backend/API: There is an “api” directory (even though its internal structure is not expanded in the file tree, it is presumed to represent the API server that supports the UI). Represent this as a separate “Onyxia API Backend” component.
• External Services & Integrations:
○ Authentication: Integration with Keycloak for user authentication is evident from the Keycloak theme in the frontend.
○ Secret Management: Integration with Vault is highlighted (through the SecretManager adapter).
○ Storage: The project integrates S3 (or S3-compatible storage) managed via several S3 adapter files.
• Web Frontend communicating with the API Backend through RESTful calls or WebSocket connections.
– Keycloak for authentication
– Vault for secret management
– S3 storage for data persistence and operations
Architectural Patterns and Techniques
• Use of Adapter patterns on the frontend (the “core/adapters” directories for OIDC, Onyxia API, etc.)—this allows the UI to remain decoupled from the underlying backend implementations.
• The separation of concerns is clearly defined between use cases (domain logic) and presentation (UI pages).
• The Helm chart encapsulates the deployment logic (configuration as code) for the entire system.
• It is a microservice-ish design where the UI (client-side) and the API backend are separately deployable components within a managed Kubernetes infrastructure.
Relevant Technologies and Frameworks
• Frontend: React, TypeScript, and supporting libraries (e.g., Storybook, ESLint, Prettier) as seen in the file names.
• Backend: The “api” is likely built using Node.js/TypeScript or another backend framework (even if not immediately clear from the file tree, this is common in full-stack JavaScript projects).
• Containerization: Docker (Dockerfiles are provided, e.g., in the web directory).
• Deployment: Kubernetes and Helm for orchestration and deployment.
• Security and Authentication: Keycloak for authentication and Vault for secrets.
• Storage: S3-compatible storage integration.
Final Advice
• Detail is key: do not hesitate to break the components further (e.g., represent the internal modularity within the frontend’s use cases and adapters if needed).