Appearance
DevOps & Platform Documentation โ
The single source of truth for the Microtec platform โ architecture, infrastructure, CI/CD, DevSecOps, networking, auth, and the operational runbooks that keep it all running. Imported from the DevopsDocs repository.
Start here based on your role
- New to the platform? โ Onboarding, then the Overview.
- Backend dev? โ Clean Architecture โ Backend Services.
- DevOps / SRE? โ Infrastructure โ CI/CD Pipelines โ Environments.
- Debugging an incident? โ Runbooks โ Incident Response.
Platform at a Glance โ
| Dimension | Value |
|---|---|
| Backend microservices | 13 (.NET 8, Azure Container Apps) |
| Frontend apps | 13 (Angular 17/20, Nx, Module Federation) |
| Mobile apps | 3 (Flutter: BO, ERP, Van Sales) |
| Azure environments | 5 (dev ยท stage ยท preprod ยท uat ยท production) |
| Shared NuGet packages | 16 (private Azure DevOps feed) |
| CI/CD orchestrators | 6 |
| Keycloak realms / custom SPIs | 2 / 7 |
| DevSecOps pipeline stages | 16 |
Platform โ
- Overview โ Platform description, personas, glossary, tech stack, system landscape.
- Architecture โ Clean Architecture, CQRS, multi-tenancy, event-driven design, micro-frontend.
- Backend Services โ All 13 microservices, coding conventions, CQRS patterns, API design.
- Frontend โ Angular MFE roster, Module Federation, auth, state management, builds.
- Mobile โ BO app, ERP app, Van Sales, Flutter workspace setup, releases.
Infrastructure & Delivery โ
- Infrastructure โ Azure resources, Bicep modules, Container Apps, naming conventions, ACR.
- CI/CD Pipelines โ Pipeline orchestrators, stage templates, branch-env mapping, scripts.
- DevSecOps โ SonarCloud, Gitleaks, Trivy, OWASP ZAP, SBOM, AI code review.
- Environments โ Dev, stage, preprod, UAT, production โ config, URLs, promotion.
- Networking โ VNet CIDRs, NSG rules, private endpoints, private DNS, Front Door routing.
- Observability โ Seq, OpenTelemetry, Application Insights, health checks, alerting.
Auth & Services โ
- Keycloak & Auth โ Custom SPIs, realm configuration, flow priorities, session limiting.
- Authentication โ Dual-token design, JWT claims, RBAC, Keycloak realms.
- API Reference โ Gateway routes, endpoint naming, request/response envelope, rate limiting.
- Shared Packages โ NuGet catalog, dependency hierarchy, setup, migration, ZATCA.
Reference โ
- Data & Databases โ SQL Server per-tenant, MongoDB, Redis, EF Core patterns, backup.
- Fooj Project โ Fooj architecture, infrastructure, environments, CI/CD, shared egress.
- Architecture Decisions (ADR) โ ADR-001 through ADR-009 โ key technology choices and rationale.
- Runbooks โ Step-by-step procedures for deployments, incidents, key rotation.
- Onboarding โ New-developer checklist, access matrix, local dev setup per role.
- Technology Catalog โ Full inventory of every tool and library with version and purpose.
- Diagrams โ Service topology, network topology, CI/CD flow, auth flow, data flow.
Environment Quick Reference โ
| Environment | VNet CIDR | Domain | Key Vault |
|---|---|---|---|
| dev | 10.0.0.0/16 | microtec-test.com | mic-erp-be-dev-skv |
| stage | 10.1.0.0/16 | microtecstage.com | mic-erp-stg-kv |
| preprod | 10.6.0.0/16 | (preprod domain) | mic-erp-be-preprod-skv |
| uat | 10.5.0.0/16 | microtec-uat.com | mic-erp-uat-kv |
| production | 10.2.0.0/16 | onlinemicrotec.com.sa | (prod kv) |
Critical gotchas
MonogoDbtypo is INTENTIONAL โ the NuGet package readsMonogoDb__ConnectionString(not MongoDB). Do not "fix" it โ it is a breaking change.- DataProtection keys are machine-specific โ encrypted connection strings cannot be decrypted on a different server.
- NuGet feed auth โ backend builds use
$(System.AccessToken)for the Azure DevOps feed; no manual PAT needed.