Skip to content
dfluxdocs
dflux.io

Quickstart

Register UEs against your AMF in five steps, using the community build and the public flow library.

1. Install rk and get the flows

Shell

2. Describe your lab

Save this as lab.yaml, then change the PLMN, the gNB ID, the tracking area and the addresses to match your core:

YAML

Check that rk can reach the AMF:

Shell

3. Create subscribers

Generate ten subscribers, and the same set in your core's import format:

Shell

The first writes subscribers.yaml for rk. The second writes subscribers.json, the same subscribers to import into Open5GS. Use -format core for CSV or -format free5gc for a free5GC script. Provision them in your core.

4. Register

Shell

rk connects to the AMF, runs NG Setup, and registers one UE. The exit code is 0 when it passes. Register all ten, five per second:

Shell

5. Use the result

Shell

That's a CI step: the exit code passes or fails the job, and the JUnit file shows the details. See Use rk in CI.

Next

  • Flows: read and write the procedures.
  • The environment: more NFs, protocols and transports.
  • Load runs: find the rate where your core stops keeping up.
  • Licensing: what the community build covers, and what needs a licence.