# scality/osis architecture

> Architecture diagram of the GitHub repository scality/osis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/scality/osis
- Repository: https://github.com/scality/osis

## Overview

##### 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.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External["External Systems"]
        OSE[VMware Cloud Director OSE]
        RING[Scality RING]:::storage
        REDIS_SERVER[Redis Server]:::cache
        VAULT[Vault Service]:::vault
    end

    subgraph API["API Layer"]
        OSIS_API[ScalityOsisController]:::api
    end

    subgraph Security["Security Layer"]
        JWT[JWT Authentication]:::security
        BASIC[Basic Authentication]:::security
        CRYPTO[AES256GCM Encryption]:::security
    end

    subgraph Core["Core Service Layer"]
        OSIS_SERVICE[ScalityOsisService]:::service
        REDIS_CACHE[Redis Cache Layer]:::cache
    end

    subgraph Clients["Storage Platform Clients"]
        S3_CLIENT[S3 Client]:::client
        VAULT_CLIENT[Vault Admin Client]:::client
        UTAPI_CLIENT[Utapi Client]:::client
    end

    OSE --> OSIS_API
    OSIS_API --> |Authentication| JWT
    OSIS_API --> |Authentication| BASIC
    JWT --> OSIS_SERVICE
    BASIC --> OSIS_SERVICE
    CRYPTO --> OSIS_SERVICE
    OSIS_SERVICE --> REDIS_CACHE
    OSIS_SERVICE --> S3_CLIENT
    OSIS_SERVICE --> VAULT_CLIENT
    OSIS_SERVICE --> UTAPI_CLIENT
    REDIS_CACHE --> REDIS_SERVER
    S3_CLIENT --> RING
    VAULT_CLIENT --> VAULT
    
    %% Click events for component mapping
    click OSIS_API "https://github.com/scality/osis/blob/main/osis-app/src/main/java/com/scality/osis/resource/ScalityOsisController.java"
    click JWT "https://github.com/scality/osis/tree/main/osis-core/src/main/java/com/scality/osis/security/jwt/"
    click BASIC "https://github.com/scality/osis/blob/main/osis-core/src/main/java/com/scality/osis/security/basic/ScalityBasicAuthentication.java"
    click OSIS_SERVICE "https://github.com/scality/osis/blob/main/osis-core/src/main/java/com/scality/osis/service/ScalityOsisService.java"
    click REDIS_CACHE "https://github.com/scality/osis/blob/main/osis-core/src/main/java/com/scality/osis/redis/service/ScalityRedisRepository.java"
    click S3_CLIENT "https://github.com/scality/osis/blob/main/storage-platform-clients/src/main/java/com/scality/osis/s3/S3.java"
    click VAULT_CLIENT "https://github.com/scality/osis/blob/main/storage-platform-clients/src/main/java/com/scality/osis/vaultadmin/impl/VaultAdminImpl.java"
    click UTAPI_CLIENT "https://github.com/scality/osis/blob/main/storage-platform-clients/src/main/java/com/scality/osis/utapi/impl/UtapiImpl.java"
    click CRYPTO "https://github.com/scality/osis/blob/main/storage-platform-clients/src/main/java/com/scality/osis/security/crypto/AES256GCM.java"

    %% Styling
    classDef api fill:#9cf,stroke:#333,stroke-width:2px
    classDef security fill:#ff9,stroke:#333,stroke-width:2px
    classDef service fill:#9f9,stroke:#333,stroke-width:2px
    classDef cache fill:#f9f,stroke:#333,stroke-width:2px
    classDef client fill:#fc9,stroke:#333,stroke-width:2px
    classDef storage fill:#99f,stroke:#333,stroke-width:2px
    classDef vault fill:#c9f,stroke:#333,stroke-width:2px
```
