Rapid deployment model for complete MOSIP platform infrastructure and services
This repository provides a 3-step rapid deployment model for MOSIP (Modular Open Source Identity Platform) that covers infrastructure provisioning, dependency setup, and complete MOSIP service deployment.
Create cloud infrastructure using Terraform
cd terraform/
# Follow the detailed Terraform documentationInfrastructure Components:
- base-infra - Foundation infrastructure (VPC, networking, security)
- observ-infra - Management cluster with Rancher UI (Optional)
- infra - MOSIP application clusters with optional Rancher import
GitHub Actions Integration:
- Automated infrastructure provisioning
- Branch-based environment isolation
- Optional Rancher cluster import automation
Complete Terraform Documentation
Deploy prerequisites and external dependencies using Helmsman
cd Helmsman/
# Follow the detailed Helmsman documentationDeployment Sequence:
- prereq-dsf - Deploy prerequisites (monitoring, Istio, logging)
- external-dsf - Deploy external dependencies (databases, message queues, storage)
What gets deployed:
Prerequisites (prereq-dsf):
- Monitoring stack (Rancher monitoring, Grafana, AlertManager)
- Logging infrastructure (Cattle logging system)
- Service mesh (Istio) and networking components
External Dependencies (external-dsf):
- Databases (PostgreSQL with initialization)
- Identity & Access (Keycloak)
- Security (SoftHSM, ClamAV antivirus)
- Object Storage (MinIO)
- Message Queues (ActiveMQ, Kafka with UI)
- Supporting services (S3, message gateways, CAPTCHA, landing page)
Complete Helmsman Documentation
Deploy MOSIP core services and testing infrastructure
MOSIP Core Deployment:
cd Helmsman/
# Deploy MOSIP core services- mosip-dsf - Deploy MOSIP core services (Identity, Authentication, etc.)
Testing Infrastructure (GitHub Actions):
- testrigs-dsf - Automated deployment of testing suite:
- API Test Rig - API testing automation
- DSL Test Rig - Domain-specific language testing
- UI Test Rig - User interface testing automation
graph TD
A[1. Terraform Infrastructure] --> B[2. Helmsman Prerequisites]
B --> C[3. External Dependencies]
C --> D[4. MOSIP Core Services]
D --> E[5. Testing Infrastructure]
A1[base-infra<br/>Foundation] --> A2[observ-infra<br/>Rancher - Optional]
A1 --> A3[infra<br/>MOSIP Clusters]
A2 -.->|Import| A3
B1[prereq-dsf<br/>Monitoring, Istio, Logging] --> C1[external-dsf<br/>External Dependencies]
C1 --> D1[mosip-dsf<br/>Core Services]
D1 --> E1[testrigs-dsf<br/>Testing Suite]
A --> A1
B --> B1
style A fill:#e1f5fe,stroke:#01579b,color:#000000
style B fill:#fff3e0,stroke:#f57c00,color:#000000
style C fill:#fff3e0,stroke:#f57c00,color:#000000
style D fill:#f3e5f5,stroke:#4a148c,color:#000000
style E fill:#e8f5e8,stroke:#1b5e20,color:#000000
- terraform.yml - Automated infrastructure provisioning
- terraform-destroy.yml - Infrastructure cleanup automation
- helmsman_external.yml - External dependencies deployment
- helmsman_mosip.yml - MOSIP core services deployment
- helmsman_testrigs.yml - Testing infrastructure deployment
terraform/
├── base-infra/ # Foundation infrastructure (VPC, networking, security)
├── observ-infra/ # Management cluster with Rancher UI (Optional)
├── infra/ # MOSIP Kubernetes clusters
├── modules/ # Reusable Terraform modules
│ ├── aws/ # AWS-specific modules
│ ├── azure/ # Azure-specific modules
│ └── gcp/ # GCP-specific modules
└── implementations/ # Cloud-specific implementations
├── aws/ # AWS deployment configurations
├── azure/ # Azure deployment configurations
└── gcp/ # GCP deployment configurations
Helmsman/
├── dsf/ # Desired State Files for deployments
│ ├── prereq-dsf.yaml # Prerequisites (monitoring, Istio, logging)
│ ├── external-dsf.yaml # External dependencies (PostgreSQL, Keycloak, MinIO, ActiveMQ, Kafka)
│ ├── mosip-dsf.yaml # MOSIP core services (Identity, Auth, Registration)
│ └── testrigs-dsf.yaml # Testing suite (API, DSL, UI test rigs)
├── hooks/ # Deployment automation scripts
└── utils/ # Utilities and configurations
├── istio-addons/ # Service mesh components
├── logging/ # Logging stack configurations
└── monitoring/ # Monitoring and alerting setup
.github/workflows/
├── terraform.yml # Infrastructure provisioning workflow
├── terraform-destroy.yml # Infrastructure cleanup workflow
├── helmsman_external.yml # External dependencies deployment
├── helmsman_mosip.yml # MOSIP core services deployment
└── helmsman_testrigs.yml # Testing infrastructure deployment
- Cloud Account - AWS, Azure, or GCP with appropriate permissions
- Domain Name - Registered domain for MOSIP services
- GitHub Repository - Forked repository with secrets configured
- SSH Keys - Key pair for infrastructure access
# Cloud provider credentials
AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY
# OR
AZURE_CREDENTIALS
# OR
GCP_SERVICE_ACCOUNT_KEY
# Infrastructure access
SSH_PRIVATE_KEY # Private key for server access
MOSIP_EMAIL_ID # Email for SSL certificate notifications# Fork this repository to your GitHub account
# Configure required GitHub secrets
# Create environment-specific branch (optional)# Navigate to GitHub Actions
# Run "terraform plan / apply" workflow
# Select target cloud provider and environment
# Monitor deployment progress# Run "helmsman external" workflow (prerequisites + monitoring)
# Run "helmsman mosip" workflow (core MOSIP services)
# Run "helmsman testrigs" workflow (testing infrastructure)# Access Rancher UI (if observ-infra deployed)
# Access MOSIP services via configured domain
# Run automated tests via deployed test rigs| Component | Purpose | Documentation |
|---|---|---|
| Terraform | Infrastructure provisioning | terraform/README.md |
| Helmsman | Application deployment | Helmsman/README.md |
| GitHub Actions | CI/CD automation | .github/workflows/README.md |
| Architecture | Visual diagrams | docs/_images/ARCHITECTURE_DIAGRAMS.md |
- Purpose: Centralized Kubernetes cluster management
- Features: Multi-cluster UI, RBAC, monitoring dashboards
- Deployment: Optional during infrastructure provisioning
- Import: MOSIP clusters can be optionally imported to Rancher
- Infrastructure monitoring via cloud-native tools
- Application monitoring via Prometheus/Grafana
- Log aggregation via ELK/EFK stack
- Alerting via AlertManager integration
- Infrastructure failures: Check Terraform logs in GitHub Actions
- Deployment failures: Review Helmsman logs and Kubernetes events
- Access issues: Verify DNS configuration and SSL certificates
- Test failures: Check test rig logs and service dependencies
- GitHub Issues: Report bugs and request features
- Documentation: Comprehensive guides in component directories
- Community: MOSIP community support channels
This project is licensed under the Mozilla Public License 2.0.
For detailed technical documentation, refer to the component-specific README files linked above.
