Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
niloysh committed Oct 14, 2023
1 parent e510f7d commit 7976d11
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,43 @@
# free5gc-k8s

## How to Run

1. **Set Up OVS Bridges:**
- On each K8s cluster node, add the OVS bridges: n2br, n3br, and n4br.
- Connect nodes using these bridges and OVS-based VXLAN tunnels.

Example command:
```bash
sudo ovs-vsctl add-port n2br vxlan_nuc1_n2 -- set Interface vxlan_nuc1_n2 type=vxlan options:remote_ip=129.97.168.40 options:key=1002
```
<details>
<summary>Sample OVS Configuration</summary>

![](images/ovs-bridges.png)

</details>

2. **Install gtp5g v0.8.2:**
- Install gtp5g v0.8.2 on nodes where UPF should run.

3. **Update UPF NodeSelector:**
- Update the nodeSelector field in UPF deployment YAML files.

4. **Insert UE Subscriber Information:**
- Ensure correct UE subscriber information is inserted via the web UI. Subscriber details are found in UE config files.

5. **Deployment Order:**
1. Run MongoDB
2. Run free5gc-webui
3. Run free5gc
4. Run ueransim-gnb
5. Run ueransim-ue

## Convenience Scripts

Use the following scripts in the `bin` folder:

- **k8s-log.sh:**
```bash
./k8s-log.sh amf free5gc
Ensure the K8s namespace is specified (e.g., free5gc).
Binary file added images/ovs-bridges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7976d11

Please sign in to comment.