feat: Adding DPDK support in UPF

README.md

@@ -43,7 +43,23 @@ juju deploy sdcore-upf --trust --channel=edge
 
 ### Exposing the UPF externally
 
-If a load balancer such as `metallb` is present, the charm will configure an externally accessible service port with the load balancer upon install of the charm.
+If a load balancer such as `metallb` is present, the charm will configure an externally accessible 
+service port with the load balancer upon install of the charm.
+
+### Running UPF in DPDK mode
+
+By default, UPF runs in `af_packet` mode. To run UPF in `dpdk` mode, `upf-mode` config option 
+should be used, i.e.:
+
+```shell
+juju deploy sdcore-upf --trust --channel=edge --config upf-mode="dpdk" --config enable-hugepages=True --config access-interface-mac-address="00:b0:d0:63:c2:26" --config core-interface-mac-address="00:b0:d0:63:c2:36"
+```
+
+As shown in the example above, when running UPF in `dpdk` mode, it is necessary to enable
+HugePages and pass the MAC addresses of the `Access` and `Core` interfaces.
+
+For detailed instructions on running UPF in `dpdk` mode please visit 
+[How-to: Running UPF in DPDK mode](https://canonical-charmed-5g.readthedocs-hosted.com/en/latest/how-to/running_upf_in_dpdk_mode/).
 
 ## Image
 

config.yaml

@@ -1,4 +1,10 @@
 options:
+  upf-mode:
+    type: string
+    default: af_packet
+    description: |
+      Either `af_packet` (default) or `dpdk`.
+      Please see README.md to learn about all required parameters.
   dnn:
     type: string
     default: internet
@@ -7,25 +13,14 @@ options:
     type: string
     default: 192.168.251.0/24
     description: gNodeB subnet.
-  core-interface:
-    type: string
-    description: Interface on the host to use for the Core Network.
-  core-ip:
-    type: string
-    default: 192.168.250.3/24
-    description: IP address used by the UPF's Core interface.
-  core-gateway-ip:
-    type: string
-    default: 192.168.250.1
-    description: Gateway IP address to the Core Network.
-  core-interface-mtu-size:
-    type: int
-    description: |
-      MTU for the core interface (1200 <= MTU <= 65535) in bytes.
-      If not specified, Multus will use its default value (typically 1500).
   access-interface:
     type: string
     description: Interface on the host to use for the Access Network.
+  access-interface-mac-address:
+    type: string
+    description: |
+      MAC address of the UPF's Access interface. 
+      Required only if `upf-mode` is `dpdk`.
   access-ip:
     type: string
     default: 192.168.252.3/24
@@ -39,9 +34,30 @@ options:
     description: |
       MTU for the access interface (1200 <= MTU <= 65535) in bytes.
       If not specified, Multus will use its default value (typically 1500).
+  core-interface:
+    type: string
+    description: Interface on the host to use for the Core Network.
+  core-interface-mac-address:
+    type: string
+    description: |
+      MAC address of the UPF's Core interface. 
+      Required only if `upf-mode` is `dpdk`.
+  core-ip:
+    type: string
+    default: 192.168.250.3/24
+    description: IP address used by the UPF's Core interface.
+  core-gateway-ip:
+    type: string
+    default: 192.168.250.1
+    description: Gateway IP address to the Core Network.
+  core-interface-mtu-size:
+    type: int
+    description: |
+      MTU for the core interface (1200 <= MTU <= 65535) in bytes.
+      If not specified, Multus will use its default value (typically 1500).
   external-upf-hostname:
     type: string
-    description: |-
+    description: |
       Externally accessible FQDN for the UPF.
       If not provided, it will default to the LoadBalancer Service hostname. 
       If that is not available, it will default to the internal

lib/charms/kubernetes_charm_libraries/v0/multus.py

@@ -92,9 +92,10 @@ def _on_config_changed(self, event: EventBase):
 
 import json
 import logging
-from dataclasses import asdict, dataclass
+from dataclass_wizard import asdict
+from dataclasses import dataclass
 from json.decoder import JSONDecodeError
-from typing import Callable, Union
+from typing import Callable, List, Optional, Union
 
 import httpx
 from lightkube import Client
@@ -123,7 +124,7 @@ def _on_config_changed(self, event: EventBase):
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 8
+LIBPATCH = 9
 
 
 logger = logging.getLogger(__name__)
@@ -150,8 +151,8 @@ class NetworkAnnotation:
 
     name: str
     interface: str
-
-    dict = asdict
+    mac: Optional[str] = None
+    ips: Optional[List[str]] = None
 
 
 class KubernetesMultusError(Exception):
@@ -353,7 +354,7 @@ def patch_statefulset(
                         annotations={
                             "k8s.v1.cni.cncf.io/networks": json.dumps(
                                 [
-                                    network_annotation.dict()
+                                    asdict(network_annotation, skip_defaults=True)
                                     for network_annotation in network_annotations
                                 ]
                             )
@@ -446,22 +447,24 @@ def _pod_is_patched(
             return False
         return True
 
+    @staticmethod
     def _annotations_contains_multus_networks(
-        self, annotations: dict, network_annotations: list[NetworkAnnotation]
+        annotations: dict, network_annotations: list[NetworkAnnotation]
     ) -> bool:
         if "k8s.v1.cni.cncf.io/networks" not in annotations:
             return False
         try:
             if json.loads(annotations["k8s.v1.cni.cncf.io/networks"]) != [
-                network_annotation.dict() for network_annotation in network_annotations
+                asdict(network_annotation, skip_defaults=True)
+                for network_annotation in network_annotations
             ]:
                 return False
         except JSONDecodeError:
             return False
         return True
 
+    @staticmethod
     def _container_security_context_is_set(
-        self,
         containers: list[Container],
         container_name: str,
         cap_net_admin: bool,

requirements.txt

@@ -1,7 +1,11 @@
+dataclass-wizard
+httpx
+ipaddress
 ops
 jinja2
 lightkube
 lightkube-models
+macaddress
 pydantic
 pytest-interface-tester
 PyYAML>=6.0.1