How grycap/onetrigger works
Main components
• OneTrigger CLI (entry point)
• Configuration Parser
• OneProviderClient (client to Oneprovider API/event stream)
• Event Processor (builds JSON payload)
• Webhook Sender (HTTP POST to user’s endpoint)
• External Systems:
– Oneprovider (Onedata file‐event provider)
– Webhook Receiver (user’s HTTP endpoint)
• Packaging/Deployment:
– Docker container / Kubernetes deployment
Relationships and data flows
• User invokes onetrigger run (CLI)
↓
• CLI module reads arguments & env vars via Config Parser
↓
• OneProviderClient establishes connection (REST or SSE) to Oneprovider
↓
• Onedata file events stream back into OneTrigger
↓
• Event Processor constructs the JSON payload
↓
• Webhook Sender issues HTTP POST to the configured webhook URL
Architectural patterns and design principles
• Separation of concerns:
– configparser.py handles only configuration
– oneproviderclient.py abstracts API communication
– onetrigger.py orchestrates modules and CLI interface
• Dependency inversion: modules depend on abstractions (e.g., pass a session object into the client)
• Single responsibility: each component has one clearly defined role
Call out key technologies and frameworks
• Python 3
• requests or aiohttp (HTTP client in oneproviderclient.py and webhook sender)
• click or argparse (CLI parsing in onetrigger.py)
• Dockerfile (container image)
• Kubernetes YAML (optional deployment)
• PyPI packaging (setup.py)
Detailed component breakdown (to include
– Entry Point: onetrigger/onetrigger.py (CLI)
– Config: onetrigger/configparser.py (env vars & args)
– Client Library: onetrigger/oneproviderclient.py
– Core Logic: onetrigger/onetrigger.py (subscribe loop + dispatch)
– Payload Builder: inline in onetrigger.py or separate utility
– Sender: uses requests.post to WEBHOOK URL
– Packaging: setup.py → PyPI, Dockerfile → grycap/onetrigger
– Deployment: Kubernetes YAML snippet
• Captures all essential modules and their interactions
• Clearly shows external integrations and protocols
• Highlights packaging and deployment options
• Uses consistent notation for easy comprehension
• Is tailored to OneTrigger’s role as an event-forwarding CLI/microservice
This approach ensures maximum clarity for developers and operators alike, while accurately reflecting OneTrigger’s architecture and design principles.