- Setup locally
- How to work with a specific tag / release
- NetApp communication options
- Integration with CAPIF
Host prerequisites: Docker version 23.0.1
, Docker Compose v2
, 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 toapt install build-essential
first. In case you don't want to proceed with this installation, you can head over to theMakefile
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 withapt install jq
After the containers are up and running:
- access and start playing with the Swager UI at: http://localhost:8090/nef/docs or https://localhost:4443/nef/docs
- login to the admin dashboard at: http://localhost:8090/login or https://localhost:4443/login
- Default credentials:
admin@my-email.com
/pass
- they can be found/changed inside your
.env
file
- Default credentials:
After git clone
or git pull
you can specify the release you want to work on by just using its tag
in the following command:
git switch --detach tag_here
You will get into a detached HEAD state in Git, but this is perfectly fine, you can go back anytime by just using git switch main
.
Short reasoning on why we choose tags over branches:
A tag is immutable.
source
To be updated...
In order to integrate NEF Emulator with CAPIF you should perform the following steps:
- Ensure that all CAPIF services are up and running. Clone the code from the official Github repository https://github.com/EVOLVED-5G/CAPIF_API_Services, navigate to the
services/
directory and execute the following commands:
cd services/
sudo ./run.sh
./check_services_are_running.sh
These commands will start the CAPIF services and ensure that they are running correctly.
- Configure the NEF Emulator project to join the CAPIF network by following one of the below steps based on your deployment requirements:
- For local deployment:
Update the
EXTERNAL_NET
environment variable totrue
in the.env
file of the NEF Emulator project. This will allow NEF containers to join CAPIF's pre-existing network calledservices_default
. If you do not want to use NEF Emulator with CAPIF, change theEXTERNAL_NET
environment variable back to false in the.env
file. Add the following entry to the/etc/hosts
file of the host machine:
127.0.0.1 capifcore
This entry maps the hostname "capifcore" to the IP address
127.0.0.1
, which is the loopback address of the local network interface.
- For deployment in separate VMs:
Update the
EXTERNAL_NET
environment variable tofalse
in the.env
file of the NEF Emulator project. Add the following entry to the/etc/hosts
file of the host machine:
<ip-of-capif> capifcore
This entry maps the hostname "capifcore" to the IP address of the machine that CAPIF is running on.
- Start the NEF services by executing either the make up or make debug-up command in the NEF Emulator project directory.
💡 Once you have completed these steps, NEF should be successfully onboarded to the CAPIF Core Function. To confirm this, check that 12 files have been created in the
app/core/certificates/
folder.