How port-labs/ocean works
Main Components
a. Core Framework Components:
• Ocean Framework Core (port_ocean/core/)
• Event Listeners System (port_ocean/core/event_listener/)
• Entity Processors (port_ocean/core/handlers/entity_processor/)
• Integration Base System (port_ocean/core/integrations/)
• Port Client (port_ocean/clients/port/)
b. Integration Layer:
• Individual Integration Modules (in integrations/ directory)
• Integration Configuration Management
• Integration Event Handlers
c. External Systems:
• Port API
• Third-party Systems (AWS, Azure, GitLab, etc.)
• Message Brokers (Kafka)
Integration Lifecycle
For each flow, include:
a. Export Architecture:
• Data flow from third-party systems
• Entity processing pipeline
• State management
• Port API communication
b. Real-Time Updates:
• Event listeners (Kafka/Webhook)
• Event processing pipeline
• Real-time state updates
c. Integration Lifecycle:
• Integration initialization
• Configuration loading
• Event handling
• Resource synchronization
Key Relationships
• Event flow from third-party systems through event listeners
• Data transformation through entity processors
• State management and synchronization with Port API
• Integration configuration management
• Error handling and retry mechanisms
Component Details
[Third-Party Systems] → [Event Listeners]
• ↓
[Ocean Framework Core] ← [Integration Modules]
• ↓
[Entity Processors] → [State Management]
• ↓
[Port Client] → [Port API]
Implementation Notes
• Use different line styles for different types of communication (REST, Event-based, etc.)
• Version management aspects
• Integration points with CI/CD systems
• Monitoring and logging points
Remember to include the integration lifecycle stages:
Error Handling
This will provide a complete picture of how the Ocean framework operates while maintaining clarity and usefulness for the principal software engineer.