Getting started¶
In this tutorial, we will deploy and run Charmed OAI RAN (Radio Access Network) using Juju and Terraform. The Charmed OAI RAN consists of two Juju charms representing the CU (Central Unit) and the DU (Distributed Unit).
As part of this tutorial, we will also deploy additional components:
Charmed Aether SD-Core: A 5G core network which will manage our RAN network
SD-Core Router: a software router facilitating communication between the 5G Core and the RAN
User Equipment (UE) simulator: A simulated cellphone which will allow us to validate the correctness of the entire deployment
To complete this tutorial, you will need a machine which meets the following requirements:
A recent
x86_64CPU (Intel 4ᵗʰ generation or newer, or AMD Ryzen or newer)At least 4 cores (8 recommended)
At least 8 GB of RAM (16 GB recommended)
50GB of free disk space
1. Deploy Charmed Aether SD-Core¶
Install MicroK8s¶
From your terminal, install MicroK8s:
sudo snap install microk8s --channel=1.31-strict/stable
Add your user to the microk8s group:
sudo usermod -a -G snap_microk8s $USER
newgrp snap_microk8s
Add the community repository MicroK8s addon:
microk8s addons repo add community https://github.com/canonical/microk8s-community-addons --reference feat/strict-fix-multus
Enable the following MicroK8s addons. We must give MetalLB an address range that has at least 3 IP addresses for Charmed Aether SD-Core.
sudo microk8s enable hostpath-storage
sudo microk8s enable multus
sudo microk8s enable metallb:10.0.0.2-10.0.0.4
Bootstrap a Juju controller¶
From your terminal, install Juju:
sudo snap install juju --channel=3.6/stable
Bootstrap a Juju controller:
juju bootstrap microk8s
Note
There is a bug in Juju that occurs when
bootstrapping a controller on a new machine. If you encounter it, create the following
directory:
mkdir -p /home/ubuntu/.local/share
Install Terraform¶
From your terminal, install Terraform:
sudo snap install terraform --classic
Create Terraform module¶
On the host machine create a new directory called terraform:
mkdir terraform
Inside newly created terraform directory create a terraform.tf file:
cd terraform
cat << EOF > versions.tf
terraform {
required_providers {
juju = {
source = "juju/juju"
version = ">= 0.12.0"
}
}
}
EOF
Create a Terraform module containing the Charmed Aether SD-Core and a router:
cat << EOF > core.tf
resource "juju_model" "sdcore" {
name = "sdcore"
}
module "sdcore-router" {
source = "git::https://github.com/canonical/sdcore-router-k8s-operator//terraform"
model = juju_model.sdcore.name
depends_on = [juju_model.sdcore]
}
module "sdcore" {
source = "git::https://github.com/canonical/terraform-juju-sdcore//modules/sdcore-k8s"
model = juju_model.sdcore.name
depends_on = [module.sdcore-router]
traefik_config = {
routing_mode = "subdomain"
}
}
EOF
Note
You can get a ready example by cloning this Git repository.
All necessary files are in the examples/terraform/getting_started directory.
Deploy 5G Core network¶
Initialize Juju Terraform provider:
terraform init
Deploy SD-Core by applying your Terraform configuration:
terraform apply -auto-approve
The deployment process should take approximately 10-15 minutes.
Monitor the status of the deployment:
juju switch sdcore
juju status --watch 1s --relations
The deployment is ready when all the charms are in the active/idle state.
It is normal for grafana-agent to remain in waiting state.
It is also expected that traefik goes to the error state (related Traefik bug).
Example:
ubuntu@host:~/terraform $ juju status
Model Controller Cloud/Region Version SLA Timestamp
sdcore microk8s-localhost microk8s/localhost 3.6.1 unsupported 09:10:50+01:00
App Version Status Scale Charm Channel Rev Address Exposed Message
amf 1.6.1 active 1 sdcore-amf-k8s 1.6/edge 863 10.152.183.24 no
ausf 1.5.1 active 1 sdcore-ausf-k8s 1.6/edge 676 10.152.183.54 no
grafana-agent 0.40.4 blocked 1 grafana-agent-k8s latest/stable 80 10.152.183.247 no Missing ['grafana-cloud-config']|['logging-consumer'] for logging-provider; ['grafana-cloud-config']|['send-remote-wr...
mongodb active 1 mongodb-k8s 6/stable 61 10.152.183.233 no
nms 1.1.0 active 1 sdcore-nms-k8s 1.6/edge 799 10.152.183.107 no
nrf 1.6.1 active 1 sdcore-nrf-k8s 1.6/edge 748 10.152.183.179 no
nssf 1.5.1 active 1 sdcore-nssf-k8s 1.6/edge 631 10.152.183.133 no
pcf 1.5.2 active 1 sdcore-pcf-k8s 1.6/edge 670 10.152.183.21 no
router active 1 sdcore-router-k8s 1.6/edge 437 10.152.183.203 no
self-signed-certificates active 1 self-signed-certificates latest/stable 155 10.152.183.201 no
smf 1.6.2 active 1 sdcore-smf-k8s 1.6/edge 765 10.152.183.172 no
traefik 2.11.0 error 1 traefik-k8s latest/stable 203 10.152.183.128 no hook failed: "ingress-relation-created"
udm 1.5.1 active 1 sdcore-udm-k8s 1.6/edge 626 10.152.183.52 no
udr 1.6.1 active 1 sdcore-udr-k8s 1.6/edge 613 10.152.183.236 no
upf 1.4.0 active 1 sdcore-upf-k8s 1.6/edge 678 10.152.183.34 no
Unit Workload Agent Address Ports Message
amf/0* active idle 10.1.194.224
ausf/0* active idle 10.1.194.212
grafana-agent/0* blocked idle 10.1.194.214 Missing ['grafana-cloud-config']|['logging-consumer'] for logging-provider; ['grafana-cloud-config']|['send-remote-wr...
mongodb/0* active idle 10.1.194.193
nms/0* active idle 10.1.194.217
nrf/0* active idle 10.1.194.241
nssf/0* active idle 10.1.194.249
pcf/0* active idle 10.1.194.201
router/0* active idle 10.1.194.255
self-signed-certificates/0* active idle 10.1.194.219
smf/0* active idle 10.1.194.223
traefik/0* error idle 10.1.194.251 hook failed: "ingress-relation-created"
udm/0* active idle 10.1.194.199
udr/0* active idle 10.1.194.231
upf/0* active idle 10.1.194.240
Offer Application Charm Rev Connected Endpoint Interface Role
amf amf sdcore-amf-k8s 863 0/0 fiveg-n2 fiveg_n2 provider
nms nms sdcore-nms-k8s 799 0/0 fiveg_core_gnb fiveg_core_gnb provider
upf upf sdcore-upf-k8s 678 0/0 fiveg_n3 fiveg_n3 provider
Configure the ingress¶
Get the external IP address of Traefik’s traefik-lb LoadBalancer service:
microk8s.kubectl -n sdcore get svc | grep "traefik-lb"
The output should look similar to below:
ubuntu@host:~/terraform $ microk8s.kubectl -n sdcore get svc | grep "traefik-lb"
traefik-lb LoadBalancer 10.152.183.142 10.0.0.2 80:32435/TCP,443:32483/TCP 11m
In this tutorial, the IP is 10.0.0.2. Please note it, as we will need it in the next step.
Configure Traefik to use an external hostname. To do that, edit traefik_config in the core.tf file:
:caption: core.tf
(...)
module "sdcore" {
(...)
traefik_config = {
routing_mode = "subdomain"
external_hostname = "10.0.0.2.nip.io"
}
(...)
}
(...)
Apply new configuration:
terraform apply -auto-approve
2. Deploy Charmed OAI RAN CU and DU¶
Create a Terraform module for the Radio Access Network and add Charmed OAI RAN CU and Charmed OAI RAN DU to it:
cat << EOF > ran.tf
resource "juju_model" "oai-ran" {
name = "ran"
}
module "cu" {
source = "git::https://github.com/canonical/oai-ran-cu-k8s-operator//terraform"
model = juju_model.oai-ran.name
config = {
"n3-interface-name": "ran"
}
}
module "du" {
source = "git::https://github.com/canonical/oai-ran-du-k8s-operator//terraform"
model = juju_model.oai-ran.name
config = {
"simulation-mode": true,
"bandwidth": 40,
"frequency-band": 77,
"sub-carrier-spacing": 30,
"center-frequency": "4060",
}
}
resource "juju_integration" "cu-amf" {
model = juju_model.oai-ran.name
application {
name = module.cu.app_name
endpoint = module.cu.requires.fiveg_n2
}
application {
offer_url = module.sdcore.amf_fiveg_n2_offer_url
}
}
resource "juju_integration" "cu-nms" {
model = juju_model.oai-ran.name
application {
name = module.cu.app_name
endpoint = module.cu.requires.fiveg_core_gnb
}
application {
offer_url = module.sdcore.nms_fiveg_core_gnb_offer_url
}
}
resource "juju_integration" "du-cu" {
model = juju_model.oai-ran.name
application {
name = module.du.app_name
endpoint = module.du.requires.fiveg_f1
}
application {
name = module.cu.app_name
endpoint = module.cu.provides.fiveg_f1
}
}
EOF
Update Juju Terraform provider:
terraform init
Deploy Charmed OAI RAN CU and DU:
terraform apply -auto-approve
Monitor the status of the deployment:
juju switch ran
juju status --watch 1s --relations
At this stage both the cu and the du applications are expected to be in the waiting/idle state and the messages should indicate they’re waiting for network configuration.
3. Configure the 5G core network through the Network Management System¶
Retrieve the NMS credentials (username and password):
juju switch sdcore
juju show-secret NMS_LOGIN --reveal
The output looks like this:
csurgu7mp25c761k2oe0:
revision: 1
owner: nms
label: NMS_LOGIN
created: 2024-11-20T10:22:49Z
updated: 2024-11-20T10:22:49Z
content:
password: ',u7=VEE3XK%t'
token: ""
username: charm-admin-SOOO
Retrieve the NMS address:
juju run traefik/0 show-proxied-endpoints
The output should be http://sdcore-nms.10.0.0.2.nip.io/.
Navigate to this address in your browser and use the username and password to login.
In the Network Management System (NMS), create a network slice with the following attributes:
Name:
defaultMCC:
001MNC:
01UPF:
upf-external.sdcore.svc.cluster.local:8805gNodeB:
ran-cu-cu (tac:1)
You should see the following network slice created:
Navigate to the Device Groups page and create a new device group with the following attributes:
Name:
device-groupNetwork Slice:
defaultSubscriber IP pool:
172.250.1.0/16DNS:
8.8.8.8MTU (bytes):
1456Maximum bitrate (Mbps):
Downstream:
200Upstream:
20
QoS:
5QI:
1: GBR - Conversational VoiceARP:
6
You should see the following device group created:
Navigate to Subscribers and create a new subscriber with the following attributes:
Network Slice:
defaultDevice Group:
device-group
Click on the two Generate buttons to automatically fill in the values in the form. Note the IMSI, OPC and Key, we are going to use them in the next step.
After clicking on the Submit button you should see the subscriber created:
Note
Due to current limitations in the network configuration procedure, it is required to restart the CU Pod after configuring the network.
This limitation will be addressed in the future.
To restart the CU Pod execute:
microk8s.kubectl -n ran delete pod cu-0
After adding the network configuration the CU and the DU should change their state to active/idle.
To verify that run:
juju switch ran
juju status
Output should be similar to:
ubuntu@host:~/terraform $ juju status
Model Controller Cloud/Region Version SLA Timestamp
ran microk8s-localhost microk8s/localhost 3.6.1 unsupported 09:29:04+01:00
SAAS Status Store URL
amf active local admin/sdcore.amf
nms active local admin/sdcore.nms
App Version Status Scale Charm Channel Rev Address Exposed Message
cu active 1 oai-ran-cu-k8s 2.2/edge 55 10.152.183.152 no
du active 1 oai-ran-du-k8s 2.2/edge 64 10.152.183.80 no
Unit Workload Agent Address Ports Message
cu/0* active idle 10.1.194.205
du/0* active idle 10.1.194.250
5. Deploy Charmed OAI RAN UE Simulator¶
Add Charmed OAI RAN UE Terraform module to ran.tf. Please replace the imsi, key and opc with the subscriber values from previous step:
cat << EOF >> ran.tf
module "ue" {
source = "git::https://github.com/canonical/oai-ran-ue-k8s-operator//terraform"
model = juju_model.oai-ran.name
config = {
imsi = "001010100007487" # Use the IMSI generated in the previous step
key = "5122250214c33e723a5dd523fc145fc0" # Use the Key generated in the previous step
opc = "981d464c7c52eb6e5036234984ad0bcf" # Use the OPC generated in the previous step
}
}
resource "juju_integration" "ue-du" {
model = juju_model.oai-ran.name
application {
name = module.ue.app_name
endpoint = module.ue.requires.fiveg_rfsim
}
application {
name = module.du.app_name
endpoint = module.du.provides.fiveg_rfsim
}
}
EOF
Update Juju Terraform provider:
terraform init
Deploy the UE simulator:
terraform apply -auto-approve
Monitor the status of the deployment:
juju status --watch 1s --relations
The deployment is ready when the ue application is in the active/idle state.
6. Run 5G network traffic simulation¶
Run the simulation:
juju run ue/leader ping
The simulation executed successfully if you see success: "true" as one of the output messages:
ubuntu@host:~$ juju run ue/leader ping
Running operation 1 with 1 task
- task 2 on unit-ue-0
Waiting for task 2...
result: |
PING 8.8.8.8 (8.8.8.8) from 172.250.0.2 oaitun_ue1: 56(84) bytes of data.
64 bytes from 8.8.8.8: icmp_seq=1 ttl=116 time=13.2 ms
64 bytes from 8.8.8.8: icmp_seq=2 ttl=116 time=15.3 ms
64 bytes from 8.8.8.8: icmp_seq=3 ttl=116 time=13.8 ms
64 bytes from 8.8.8.8: icmp_seq=4 ttl=116 time=12.6 ms
64 bytes from 8.8.8.8: icmp_seq=5 ttl=116 time=14.1 ms
64 bytes from 8.8.8.8: icmp_seq=6 ttl=116 time=14.8 ms
64 bytes from 8.8.8.8: icmp_seq=7 ttl=116 time=14.6 ms
64 bytes from 8.8.8.8: icmp_seq=8 ttl=116 time=14.6 ms
64 bytes from 8.8.8.8: icmp_seq=9 ttl=116 time=14.6 ms
64 bytes from 8.8.8.8: icmp_seq=10 ttl=116 time=14.5 ms
--- 8.8.8.8 ping statistics ---
10 packets transmitted, 10 received, 0% packet loss, time 9010ms
rtt min/avg/max/mdev = 12.561/14.217/15.294/0.772 ms
success: "true"
7. Destroy the environment¶
Destroy Terraform deployment:
terraform destroy -auto-approve
Note
Terraform does not remove anything from the working directory. If needed, please clean up
the terraform directory manually by removing everything except for the core.tf
and terraform.tf files.
Destroy the Juju controller and all its models:
juju kill-controller microk8s-localhost