How antar-project/truenas-orchestrator-api-poc works
This is a six-service video ingestion, transcoding, and adaptive-streaming platform backed by TrueNAS. The main workflow authenticates a client, uploads a workspace-scoped video through video-service, encodes it asynchronously, indexes the resulting playlists, and serves playlists and segments. nas-orchestrator is the storage gateway; auth-service supplies JWTs and token validation, while notification-service delivers playlist-ready events. The README documents cross-service protocols and capabilities; unsampled service internals are represented only at the directory level, so some subsystem links are documented rather than source-verified.
Main entry points: AuthService.java Identity service · VideoService.java Upload workflow · EncodingService.java Encoding jobs · PlaylistService.java Playlist index
Components 26
Identity
- Auth endpoints
auth-service/src/main/java/com/tamojit/authservice/controller/AuthController.java - Identity service
auth-service/src/main/java/com/tamojit/authservice/service/AuthService.java - JWT signing
auth-service/src/main/java/com/tamojit/authservice/security/JwtService.java - User records
auth-service/src/main/java/com/tamojit/authservice/model/User.java - Auth PostgreSQL
Ingest and Encode
- Video upload API
video-service/src/main/java/com/tamojit/videoservice/controller/VideoController.java - Upload workflow
video-service/src/main/java/com/tamojit/videoservice/service/VideoService.java - Video gRPC client
video-service/src/main/java/com/tamojit/videoservice/client/NasOrchestratorClient.java - Encoding jobs
encoding-service/src/main/java/com/tamojit/encodingservice/service/EncodingService.java - Encoder gRPC client
encoding-service/src/main/java/com/tamojit/encodingservice/client/NasOrchestratorClient.java
NAS Storage
- File operations
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/service/FileService.java - File API
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/controller/FileController.java - Playlist and segment proxy
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/service/StreamingService.java - SMB storage client
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/client/SmbFileClient.java - TrueNAS provisioning
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/client/TrueNasStorageClient.java - Storage bootstrap
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/service/StorageBoostrapService.java
Streaming
- Stream endpoints
streaming-service/src/main/java/com/tamojit/streamingservice/controller/StreamingController.java - Playlist gRPC proxy
streaming-service/src/main/java/com/tamojit/streamingservice/service/StreamingService.java - Playlist index
streaming-service/src/main/java/com/tamojit/streamingservice/service/PlaylistService.java - Playlist PostgreSQL
Notifications
- WebSocket delivery
notification-service/src/main/java/com/tamojit/notificationservice/websocket/NotificationWebSocketHandler.java - Ready-event consumer
notification-service/src/main/java/com/tamojit/notificationservice/service/PlaylistReadyConsumer.java
Other components
- Client / Player
- Redis
- Kafka
- TrueNAS / SMB
Connections 35
- Client / Player → Auth endpoints: register / login
- Auth endpoints → Identity service: handles auth
auth-service/src/main/java/com/tamojit/authservice/controller/AuthController.java - Identity service → User records: creates users
auth-service/src/main/java/com/tamojit/authservice/service/AuthService.java - Identity service → Auth PostgreSQL: persists identity
- Identity service → JWT signing: issues tokens
auth-service/src/main/java/com/tamojit/authservice/service/AuthService.java - Client / Player → Video upload API: uploads video
- Video upload API → Upload workflow: delegates upload
video-service/src/main/java/com/tamojit/videoservice/controller/VideoController.java - Upload workflow → Video gRPC client: uploads file
video-service/src/main/java/com/tamojit/videoservice/service/VideoService.java - Video gRPC client → File operations: streams file
- Upload workflow → Kafka: publishes uploaded
video-service/src/main/java/com/tamojit/videoservice/service/VideoService.java - Kafka → Encoding jobs: delivers upload event
- Encoding jobs → Encoder gRPC client: downloads / uploads
encoding-service/src/main/java/com/tamojit/encodingservice/service/EncodingService.java - Encoder gRPC client → File operations: transfers encoded files
- Encoding jobs → Kafka: publishes encoded
- File API → File operations: handles file requests
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/controller/FileController.java - File operations → SMB storage client: reads / writes
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/service/FileService.java - SMB storage client → TrueNAS / SMB: transfers files
- Storage bootstrap → TrueNAS provisioning: provisions storage
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/service/StorageBoostrapService.java - TrueNAS provisioning → TrueNAS / SMB: configures pool / share
- Storage bootstrap → SMB storage client: creates shared workspace
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/service/StorageBoostrapService.java - Client / Player → Stream endpoints: requests playback
- Stream endpoints → Redis: resolves playlist path
streaming-service/src/main/java/com/tamojit/streamingservice/controller/StreamingController.java - Stream endpoints → Playlist gRPC proxy: requests playlist
streaming-service/src/main/java/com/tamojit/streamingservice/controller/StreamingController.java - Playlist gRPC proxy → Playlist and segment proxy: gets rewritten playlist
streaming-service/src/main/java/com/tamojit/streamingservice/service/StreamingService.java - Playlist and segment proxy → SMB storage client: reads playlist / segments
nas-orchestrator/src/main/java/com/tamojit/nasorchestrator/service/StreamingService.java - Kafka → Playlist index: delivers encoded event
- Playlist index → Redis: indexes playlist paths
- Playlist index → Playlist PostgreSQL: upserts / queries
streaming-service/src/main/java/com/tamojit/streamingservice/service/PlaylistService.java - Playlist index → Kafka: publishes ready
- Kafka → Ready-event consumer: delivers ready event
- Ready-event consumer → WebSocket delivery: pushes notification
- Client / Player → WebSocket delivery: opens WebSocket
- Client / Player → Playlist and segment proxy: fetches segments directly
- Upload workflow → Auth endpoints: fetches service token
- Encoding jobs → Auth endpoints: fetches service token