louisroyer/dev-nextmn-upf repository overview

WARNING: The following image is NOT an official build of NextMN, in the future it may include beta-functionalities.

By default, configuration file from templating is used if no --config or -c is passed as argument. To start without argument, use:

command: [" "]

⁠License

Please note that even if this software is not yet properly packaged using .deb, the generated binary file /usr/local/bin/upf is provided to you under MIT License. A copy of the source code is available at in the repository nextmn/upf⁠.

⁠Configuration

Environment variable used to select templating system:

environment:
  ROUTING_SCRIPT: "docker-setup"
  TEMPLATE_SCRIPT: "template-script.sh"
  TEMPLATE_SCRIPT_ARGS: ""
  CONFIG_FILE: "/etc/nextmn/upf.yaml"
  CONFIG_TEMPLATE: "/usr/local/share/nextmn/template-upf.yaml"

Environment variables for templating:

environment:
  N4: "203.0.113.2"
  DNN_LIST: |-
    - dnn: "sliceA"
      cidr: "10.0.111.0./24"
  GTPU_ENTITIES_LIST: |-
    - "10.0.201.5"
    - "10.0.215.4"
  LOG_LEVEL: "info"

⁠Routing

If you choose to configure the container using docker-setup (default), please refer to docker-setup's documentation⁠. The environment variable ONESHOT is set to "true".

⁠Container deployment

• The container requires the NET_ADMIN capability;
• The container requires the forwarding to be enabled (not enabled by the container itself);
• The tun interface (/dev/net/tun) must be available in the container. This can be done in docker-compose.yaml by defining the following for the service:

cap_add:
    - NET_ADMIN
devices:
    - "/dev/net/tun"
sysctls:
    - net.ipv4.ip_forward=1

This image is automatically built weekly based on latest version of louisroyer/base-irit.

Dockerfile⁠ is available on Github.