NEF_emulator

This is a local implentation of the NEF emulator proposed by EVOLVED-5G.

⚙ Setup locally

Docker Compose

Host prerequisites: docker, docker-compose 1.29.2, build-essential*, jq**

After cloning the repository, there are 4 more steps to do. For convinience, we have created a Makefile that contains a command for each step + several common docker-compose tasks which you may find handy in the future.

create your local .env file
build the container images
run the containers
add some test data (optional)

cd NEF_emulator

# 1.
make prepare-dev-env

# 2.
make build

# 3.
make up

# 4.
make db-init

* 💡 Info: To use the make command you need to apt install build-essential first. In case you don't want to proceed with this installation, you can head over to the Makefile and copy/paste the shell commands that are being used for every step.

** 💡 Info: The shell script used at step 4 (for adding test data) uses jq which is a lightweight and flexible command-line JSON processor. You can install it with apt install jq

k8s

Host prerequisites: docker, docker registry*, kubernetes cluster, helm

After cloning the repository, there are more X steps to do. For convinience, we have created a bash script run-helm.sh that automatically builds the docker images, pushes them to the docker registry, and installs the helm chart.

./run-helm.sh -n <namespace> -r <release-name> -d <docker-registry>

docker run -d -p 5000:5000 --name registry registry:2.7

* 💡 Info: The default docker registry used in the helm values is a local docker registry created using docker run -d -p 5000:5000 --name registry registry:2.7.

Try out your setup

After the containers are up and running:

access and start playing with the Swager UI at: localhost:8888/nef/docs
login to the admin dashboard at: localhost:8888/login
- Default credentials: [email protected] / pass
- they can be found/changed inside your .env file

For more in-depth details about the initial NEF emulator configuration, please visit the original repository medianetlab/NEF_emulator.

5GASP guidelines and extensions

A key part of enmpowering the idea-to-market process in 5G Network Applications (NetApps) is to prove their 5G readinees. In 5GASP we propose the use of NEF to test the interaction between NetApps and 5G functionalies. We have tested and extended some capabilities from the NEF emulator prposed by the EVOLVED-5G project. Some quick guidelines for a local deployment are described next:

1. Create access token login:

Super user credentials

Username = [email protected]
Password = pass

curl --location --request POST 'http://{url}/api/v1/login/access-token' \ 
--header 'Accept: application/json' \ 
--header 'Content-Type: application/x-www-form-urlencoded' \ 
--data-raw 'grant_type=&username=admin%40my-email.com&password=pass&scope=&client_id=&client_secret='

please replace {url} with the address where the NEF emulator is running. If the request is successful, you will get an access_token and a token_type.

2. Test access token

curl --location --request POST 'http://{url}/api/v1/login/test-token' \
--header 'Accept: application/json' \ 
--header 'Content-Type: application/x-www-form-urlencoded' \ 
--header 'Authorization: Bearer {access_token}'

replace access_token with the value obtained in the previous step. If the request is successfull, details about the user will be returned.