Hyunsun Moon | d12f32b | 2021-07-30 12:55:00 -0700 | [diff] [blame] | 1 | .. |
| 2 | SPDX-FileCopyrightText: © 2021 Open Networking Foundation <support@opennetworking.org> |
| 3 | SPDX-License-Identifier: Apache-2.0 |
| 4 | |
| 5 | BESS UPF Deployment |
| 6 | =================== |
| 7 | |
| 8 | This section describes how to configure and install BESS UPF. |
| 9 | |
| 10 | |
| 11 | Network Plans |
| 12 | ------------- |
| 13 | |
| 14 | BESS UPF requires three networks, **enb**, **access**, and **core**, and all |
| 15 | three networks must use different subnets. To help your understanding, |
| 16 | the following example ACE environment will be used in the rest of the guide. |
| 17 | |
| 18 | .. image:: images/bess-upf-example-network.png |
| 19 | |
| 20 | +-----------+-----------+------------------------------------+------------+---------------+ |
| 21 | | Network | VLAN | Subnet | Interface | IP address | |
| 22 | +-----------+-----------+------------------------------------+------------+---------------+ |
| 23 | | enb | 2 | 192.168.2.0/24 (gw: 192.168.2.254) | mgmt vlan2 | 192.168.2.254 | |
| 24 | | | | +------------+---------------+ |
| 25 | | | | | enb | 192.168.2.10 | |
| 26 | +-----------+-----------+------------------------------------+------------+---------------+ |
| 27 | | access | 3 | 192.168.3.0/24 (gw: 192.168.3.254) | mgmt vlan3 | 192.168.3.254 | |
| 28 | | | | +------------+---------------+ |
| 29 | | | | | upf access | 192.168.3.1 | |
| 30 | +-----------+-----------+------------------------------------+------------+---------------+ |
| 31 | | core | 4 | 192.168.4.0/24 (gw: 192.168.4.254) | mgmt vlan4 | 192.168.4.254 | |
| 32 | | | | +------------+---------------+ |
| 33 | | | | | upf core | 192.168.4.1 | |
| 34 | +-----------+-----------+------------------------------------+------------+---------------+ |
| 35 | |
| 36 | .. note:: |
| 37 | |
| 38 | Management plane and out-of-band network are not depicted in the diagram. |
| 39 | |
| 40 | |
| 41 | Note that the management server has the only external routable address and acts as a router for |
| 42 | all networks in the Aether pod. |
| 43 | So in order for UE to access the Internet, two things need to be done in the managmenet server. |
| 44 | |
| 45 | * Masquerade UE pool with the external address of the management server. |
| 46 | * For the response traffic to be delivered to UE, forward them to UPF's **core** interface. |
| 47 | |
| 48 | |
| 49 | Check Cluster Resources |
| 50 | ----------------------- |
| 51 | |
| 52 | Before proceeding with the deployment, make sure the cluster has enough resources to run BESS UPF. |
| 53 | |
| 54 | * 2 dedicated cores (``"cpu"``) |
| 55 | * 2 1Gi HugePages (``"hugepages-1Gi"``) |
| 56 | * 2 SRIOV Virtual Functions bound to **vfio-pci** driver (``"intel.com/intel_sriov_vfio"``) |
| 57 | |
| 58 | In fact, these requirements are not mandatory to run BESS UPF, but are recommended for best performance. |
| 59 | You can use the following command to check allocatable resources in the cluster nodes. |
| 60 | |
| 61 | .. code-block:: shell |
| 62 | |
| 63 | $ kubectl get nodes -o json | jq '.items[].status.available' |
| 64 | { |
| 65 | "cpu": "95", |
| 66 | "ephemeral-storage": "1770223432846", |
| 67 | "hugepages-1Gi": "32Gi", |
| 68 | "intel.com/intel_sriov_netdevice": "32", |
| 69 | "intel.com/intel_sriov_vfio": "32", |
| 70 | "memory": "360749956Ki", |
| 71 | "pods": "110" |
| 72 | } |
| 73 | |
| 74 | |
| 75 | Configure BESS UPF |
| 76 | ------------------ |
| 77 | |
| 78 | Download ``aether-app-configs`` if you don't have it already in your development machine. |
| 79 | |
| 80 | .. code-block:: shell |
| 81 | |
| 82 | $ cd $WORKDIR |
| 83 | $ git clone "ssh://[username]@gerrit.opencord.org:29418/aether-app-configs" |
| 84 | |
| 85 | Move the directory to ``apps/bess-upf`` and create Helm values file for the new cluster. |
| 86 | The configuration below is for the example environment. |
| 87 | Don't forget to replace the IP addresses in the example configuration with the addresses of the actual cluster. |
| 88 | |
| 89 | .. code-block:: shell |
| 90 | |
| 91 | $ cd $WORKDIR/aether-app-configs/apps/bess-upf/upf1 |
| 92 | $ mkdir overlays/prd-ace-test |
| 93 | $ vi overlays/prd-ace-test/values.yaml |
| 94 | # SPDX-FileCopyrightText: 2020-present Open Networking Foundation <info@opennetworking.org> |
| 95 | |
| 96 | config: |
| 97 | upf: |
| 98 | enb: |
| 99 | subnet: "192.168.2.0/24" |
| 100 | access: |
| 101 | ip: "192.168.3.1/24" |
| 102 | gateway: "192.168.3.254" |
| 103 | core: |
| 104 | ip: "192.168.4.1/24" |
| 105 | gateway: "192.168.4.254" |
| 106 | # Below is required only when connecting to 5G core |
| 107 | cfgFiles: |
| 108 | upf.json: |
| 109 | cpiface: |
| 110 | dnn: "8internet" |
| 111 | hostname: "upf" |
| 112 | |
| 113 | |
| 114 | Update ``fleet.yaml`` in the same directory to let Fleet know the custom configuration. |
| 115 | |
| 116 | .. code-block:: shell |
| 117 | |
| 118 | $ vi fleet.yaml |
| 119 | # add following block at the end |
| 120 | - name: prd-ace-test |
| 121 | clusterSelector: |
| 122 | matchLabels: |
| 123 | management.cattle.io/cluster-display-name: ace-test |
| 124 | helm: |
| 125 | valuesFiles: |
| 126 | - overlays/prd-ace-test/values.yaml |
| 127 | |
| 128 | |
| 129 | Commit your changes. |
| 130 | |
| 131 | .. code-block:: shell |
| 132 | |
| 133 | $ cd $WORKDIR/aether-app-configs |
| 134 | $ git status |
| 135 | $ git add . |
| 136 | $ git commit -m "Add BESS UPF configs for test ACE" |
| 137 | $ git review |
| 138 | |
| 139 | |
| 140 | Go to Fleet dashboard and wait until the cluster status becomes **Active**. |
| 141 | Note that it can take up to 1 min for Fleet to fetch the configuration updates. |