How hamzaken/free5gc-gcp-terraform works
This repository is a Terraform-based lab deployment for free5GC and UERANSIM on GKE. The main workflow is: an operator configures the lab, deploys GCP infrastructure, bootstraps subscriber secrets, deploys the Kubernetes platform, and verifies UE registration and traffic. The graph preserves those stages and the major core, RAN, data, and security capabilities. Relationships for unsampled Terraform subsystems follow README descriptions; the provisioner behavior is grounded in its excerpt. It does not imply detailed network-function call flows.
Main entry points: platform Kubernetes platform stage · deploy.sh Deployment orchestrator · infra GCP infrastructure stage · config Lab configuration
Components 20
Configuration and operations
- Lab configuration
config - Offline validation
scripts/validate.sh - Deployment orchestrator
scripts/deploy.sh - Functional verification
scripts/verify.sh
GCP infrastructure
- GCP infrastructure stage
terraform/infra - VPC and network ranges
terraform/infra/modules/network - Private GKE cluster
terraform/infra/modules/gke - IAM and secret storage
terraform/infra/modules/secrets
5G platform
- Kubernetes platform stage
terraform/platform - free5GC core network
terraform/platform/free5gc.tf - MongoDB subscriber store
terraform/platform/free5gc.tf - UERANSIM gNB and UEs
terraform/platform/ueransim.tf - gtp5g node module
kubernetes/gtp5g/build-and-load.sh - Network policies
terraform/platform/network_policies.tf
Subscriber provisioning
- Secret bootstrap
scripts/bootstrap-secrets.sh - Subscriber provisioner
provisioning/subscribers/provision.js - Provisioning Job
terraform/platform/provisioning.tf
Other components
- Lab operator
- Google Secret Manager
- Internet
Connections 21
- Lab operator → Lab configuration: configures
README.md - Lab configuration → Offline validation: validates
README.md - Lab operator → Deployment orchestrator: runs
README.md - Deployment orchestrator → GCP infrastructure stage: deploys first
README.md - Deployment orchestrator → Secret bootstrap: runs between stages
README.md - Deployment orchestrator → Kubernetes platform stage: deploys second
README.md - GCP infrastructure stage → VPC and network ranges: creates
README.md - GCP infrastructure stage → Private GKE cluster: creates
README.md - GCP infrastructure stage → IAM and secret storage: provisions
README.md - Secret bootstrap → Google Secret Manager: stores credentials
README.md - Kubernetes platform stage → free5GC core network: installs
README.md - Kubernetes platform stage → MongoDB subscriber store: deploys
README.md - Kubernetes platform stage → UERANSIM gNB and UEs: deploys
README.md - Kubernetes platform stage → gtp5g node module: uses node script
README.md - Kubernetes platform stage → Network policies: applies
README.md - Kubernetes platform stage → Provisioning Job: creates
README.md - Provisioning Job → Subscriber provisioner: runs
provisioning/subscribers/provision.js - Subscriber provisioner → MongoDB subscriber store: upserts subscriber data
provisioning/subscribers/provision.js - Google Secret Manager → Kubernetes platform stage: syncs secrets
README.md - Lab operator → Functional verification: checks deployment
README.md - UERANSIM gNB and UEs → Internet: routes UE traffic via UPF
README.md