How codebleu/gitlab_bm works
Main Components
a. Core GLBM Application
• It as a hexagon or rectangle with rounded corners
• Main modules visible in the src/gitlab_bm directory:
• Backup Manager (backup.py)
• Configuration Manager (config.py)
• S3 Integration (s3_utils.py)
• Notification System (slack.py)
b. External Services
• GitLab Instance (source of backups)
• S3 Storage (destination for backups)
• Slack (notifications)
Component Relationships
• GLBM → GitLab: Backup extraction
• GLBM → S3: Backup storage
• GLBM → Slack: Notifications
Configuration Sources (show as input layers)
• Config files (multiple locations)
• Environment variables
Specific process flows
a. Main backup flow:
• GitLab → GLBM → S3 Storage
b. Configuration backup flow:
• GitLab Config → GLBM → S3 Storage
c. Cleanup flow:
• GLBM → S3 Storage (deletion of old backups)
Important Details to Highlight
• Configuration hierarchy
• Backup types (Main Backup vs. Backup Config)
• Retention policy flow (days_to_keep parameter)
• Skip backup options
Top Layer: Configuration Sources
Middle Layer: GLBM Core Components
Bottom Layer: External Services
Special Considerations:
Error/notification flows to Slack
Keep the abstraction level focused on the system architecture while including enough detail to show the backup management workflow. This will help developers understand both the high-level structure and the specific interactions between components.