๐ TOC¶
Welcome to the Unibeam Platform Technical Documentation!
This comprehensive documentation hub provides guides, diagrams, and reference materials for DevOps, environments, infrastructure, flows, and operational support across all Unibeam deployments.
Documentation Purpose
This site serves as the single source of truth for all Unibeam platform operations, troubleshooting, and best practices. All content is optimized for AWS EKS environments and follows cloud-native deployment patterns.
๐ Quick Start¶
For New Users¶
- Platform Overview - Start here to understand the Unibeam architecture
- Server List - View all available environments
- Getting Started Guide - Initial setup and access
For Operators¶
- Support & Troubleshooting - Common issues and solutions
- How-To Guides - Step-by-step operational procedures
- Kubernetes Tips - Essential kubectl commands
For Developers¶
- CI/CD Workflows - Deployment pipelines
- ArgoCD Repository - GitOps structure
- Authentication Flow - Security implementation
๐ Documentation Sections¶
๐ Environments¶
Complete documentation for all Unibeam deployments across POC, development, and production environments.
- ๐ Server List & Overview - Central directory of all environments
- ๐ณ AWS Account List - AWS account management
POC & Development Environments¶
- ๐งฉ Demo Environment - Internal demonstrations
- ๐ป Dev-US - Development environment
- ๐งช QA Environment - Quality assurance testing
- ๐น๏ธ Simulator - Testing simulators
Client POC Environments¶
- ๐บ๐ธ AT&T POC
- ๐ข MTN POC
- ๐ Omantel POC
- ๐ Orange France POC
- ๐ Orange Spain POC
- ๐ฑ Telcel POC
- ๐ Telefonica POC
- ๐ง๐ท TIM POC
- ๐ฃ Smartfren POC (Decommissioned)
Production Environments¶
- ๐ฎ๐ฑ IL Production
- ๐ง๐ท TIM Production
- ๐บ๐ธ US Production (AT&T)
- ๐ฎ๐ฉ Indosat Production
- ๐ฒ๐ฝ IZZI Production (Campaign)
Specialized Environments¶
- Jio Deployment
- Installation Guide
- Jio Services
- Production Operations
- AT&T Production
- Big-Hen
- TIM Preload
- US Production
SMSC Integrations¶
Supported MNOs¶
โ๏ธ DevOps & Platform Operations¶
Complete guides for infrastructure management, CI/CD, monitoring, and operational procedures.
๐ DevOps Overview - Main DevOps documentation hub
Infrastructure & Architecture¶
- ๐๏ธ Terraform Infrastructure - Complete IaC documentation
- ๐ AWS SSO Mapping - SSO configuration
- ๐๏ธ MongoDB Atlas - Database setup
- ๐ Mikrotik TIM - Network configuration
AWS EKS & Kubernetes¶
- ๐ EKS Authentication - Connect to clusters
- ๐ญ EKS Pod Identity - IAM integration
- ๐พ S3 Pod Mounts - Storage integration
CI/CD & GitOps¶
- ๐ฆ ArgoCD Repository Structure - Complete GitOps guide
- ๐ ArgoCD Operations - Deployment management
- โ Maven CI/CD Flow - Java service pipelines
- โก GitHub Actions Workflows - CI/CD configuration
Monitoring & Observability¶
- ๐ Loki Stack - Log aggregation system
- ๐ Prometheus HA - Metrics collection
- ๐จ Grafana Backup - Dashboard management
- ๐จ Grafana Alerts - Alerting configuration
- ๐ Loki Status - Health checks
- ๐๏ธ Redis Labs Monitoring - Cache monitoring
How-To Guides¶
๐ HOWTO Section - All operational guides
- ๐ How to Deploy Applications
- ๐พ Grafana Backup & Restore
- โ๏ธ Helm Chart Upgrades
- ๐ฆ S3 Pod Mounts
Tips & Tricks¶
- ๐ก Kubernetes Tips - kubectl commands and best practices
๐ Flows & Architecture¶
System flows and architectural patterns for understanding platform operations.
- ๐ Authentication Flow - User authentication and authorization
- ๐น๏ธ Simulator Flow - Testing simulator operations
- โก CI/CD Flow - Build and deployment pipeline
- ๐จ Kafka Flow - Message streaming architecture
- โ Maven Flow - Java build process
๐๏ธ Infrastructure¶
Detailed infrastructure component documentation.
Database¶
- ๐ Atlas AWS Auth - MongoDB authentication
- ๐ Atlas Monitoring - Database metrics
- โฌ๏ธ MongoDB Upgrade - Version upgrades
- ๐๏ธ MongoDB Configuration - Database setup
- โก Redis Configuration - Cache setup
Kafka Message Streaming¶
- ๐ฆ Kafka Standalone - Standalone deployment
- โ๏ธ Kafka Strimzi Optimization - Performance tuning
- ๐ฏ Strimzi Kafka Cluster - Cluster setup
- ๐ TLS Kafka Strimzi - Security configuration
- โ๏ธ Kafka Rebalance - Partition management
- ๐ Unibeam Kafka Topics - Topic configuration
Network¶
- ๐ AWS Network Accelerator
- ๐ก IoT Network
- ๐ Mikrotik AT&T IPSEC POC
- ๐ OXIO Demo
- ๐ SAG-IPSEC
- ๐ก๏ธ STC-IPSEC Production
- ๐ VTC-IPSEC Production
- ๐ Wireguard VPN
๐ Support & Troubleshooting¶
๐ Support Center - Complete troubleshooting hub
Common Operations¶
Troubleshooting Guides¶
Network & VPN¶
๐งช Testing & Load¶
Performance and load testing documentation.
Load Testing¶
WRK Test Scripts¶
Redis User Management¶
๐ผ๏ธ Assets & Resources¶
Visual resources and diagrams for documentation.
- ๐ Diagrams - Architecture and flow diagrams
- ๐จ Icons - Documentation icons
- ๐ธ Screenshots - UI screenshots
- ๐ Memes - Team morale boosters
๐ Search & Navigation¶
Quick Search
Use the search bar at the top of the page (๐) to find specific topics, commands, or error messages across all documentation.
By Role¶
Platform Operators: - DevOps Overview - Support Center - How-To Guides
Developers: - CI/CD Workflows - ArgoCD Repository - Flows Documentation
System Administrators: - Infrastructure Components - Terraform Documentation - Monitoring Stack
Support Engineers: - Troubleshooting Hub - Common Issues - Kubernetes Tips
๐ Platform Statistics¶
Environments¶
- Production: 4 active deployments
- POC/Dev: 12 environments
- Campaigns: 1 active campaign
Infrastructure¶
- Cloud Provider: AWS (Primary)
- Orchestration: Kubernetes (EKS)
- Deployment: GitOps with ArgoCD
- Monitoring: Prometheus + Grafana + Loki
๐ค Contributing¶
This documentation is maintained by the Unibeam DevOps and Engineering teams.
To Contribute:
1. Update documentation in the troubleshooting-docs repository
2. Follow MkDocs Material conventions
3. Use admonitions for notes, warnings, and tips
4. Include code examples with proper syntax highlighting
5. Submit pull requests for review
๐ Getting Help¶
Internal Resources¶
- ๐ Check this documentation - Most answers are here
- ๐ฌ Slack Channels - devops-support, production-alerts
- ๐ซ Create Issues - In relevant GitHub repositories
Escalation¶
For production emergencies: - Post in *production-alerts*{: .hash} Slack channel - Page on-call engineer via PagerDuty - Follow Service Outage Response
Documentation Status
โ Actively Maintained - This documentation is continuously updated to reflect platform changes and improvements.
Last Updated: January 2025
Maintained by: Unibeam DevOps & Engineering Teams
Version: 2.0