How sekoia-io/automation-library works
Major System Components
• Automation Engine/Core Orchestrator – Although there isn’t one single “engine” file at the repository’s root, note that each vendor directory usually contains its own main.py and manifests. These act as orchestrators for their respective integrations.
• Connector/Module Components – Every vendor (e.g., 1Password, AWS, Azure, CrowdStrike, etc.) represents a self-contained module that follows a similar internal design: it has client libraries, configuration, actions/triggers (often in trigger_*.json files), and tests. These modules form the “pluggable” parts that provide automation for specific external products or platforms.
• Shared Utilities and Compliance Validators – The _utils directory (especially _utils/compliance) includes common components – such as validators for manifests, Dockerfiles, and module structure. They ensure that new modules conform to repository standards.
• Documentation/Contributing Guidelines – Represented by the docs folder (with README.md, module.md, organization.md, etc.), these are vital for maintainability and clarity.
• Tests – Each module directory includes its own tests subdirectory. They verify that each module works correctly and remains up-to-date. You may show these as supporting components that interact with every module.
Relationships & Data Flow
• There should be directional flows from the module into external services (like APIs, cloud platforms, etc.) and vice versa. Indicate that the triggers (with filenames trigger_*.json) respond to incoming events or changes.
• Shared utility modules (found under _utils and doc/compliance validators) act as foundational libraries that support all independent modules in terms of compliance and consistency. Show these as a common service connected to every module for validation and configuration.
Emphasizing Architectural Patterns & Technologies
• Test-Driven Architecture: Each module includes a tests directory. Represent testing as a parallel sub-system that verifies the behavior of every component.
• Containerization: Many modules have Dockerfiles, which suggest containerized deployment. Indicate that these components are designed to be developed, deployed, and scaled independently.
• Consistency through Compliance: The existence of _utils/compliance validators suggests that automated checks and quality controls feed into the CI/CD workflow (visible by files like “.github/workflows/*”). You might show a CI/CD pipeline component that validates modules before integration.