Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 1 | .. |
| 2 | SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org> |
| 3 | SPDX-License-Identifier: Apache-2.0 |
| 4 | |
| 5 | Subscriber and Connectivity Management |
| 6 | ====================================== |
| 7 | |
| 8 | Subscriber management includes workflows associated with provisioning new subscribers, removing |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 9 | existing subscribers, and associating subscribers with Virtual Connectivity Services (VCS). |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 10 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 11 | .. note:: |
| 12 | This section refers to a fully installed ROC GUI, properly secured and with Enterprises, Connectivity Services |
| 13 | and Sites already configured by a ROC Administrator. The examples shown below are taken from an example |
| 14 | configuration shipped with the ROC - the "MEGA Patch" (see :ref:`posting-the-mega-patch`) |
| 15 | |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 16 | Provisioning a new UE |
| 17 | --------------------- |
| 18 | |
| 19 | Before a UE can be granted connectivity service, it must first be provisioned. This step is normally |
| 20 | performed by Aether Operations. |
| 21 | |
| 22 | Each UE is assigned a PLMN and a set of security keys. Depending on the deployment scenario, these |
| 23 | keys might be shared by several UEs, or they might be unique to each UE. The allocation of PLMNs and |
| 24 | keys is currently performed manually by the Aether Operations team. This subscriber-related |
Andy Bavier | 212f640 | 2021-09-30 17:27:34 -0700 | [diff] [blame] | 25 | detail is configured via the SIM Management application, ``simapp``. |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 26 | |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 27 | ``simapp.yaml`` needs to be adjusted to include the new UE IMSIs to the subscriber list. For example:: |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 28 | |
| 29 | # simapp.yaml |
| 30 | # ... |
| 31 | simapp.yaml: |
| 32 | info: |
| 33 | version: 1.0.0 |
| 34 | description: SIMAPP initial local configuration |
| 35 | logger: |
| 36 | # network function |
| 37 | APP: |
| 38 | debugLevel: info |
| 39 | ReportCaller: false |
| 40 | configuration: |
| 41 | provision-network-slice: false |
| 42 | subscribers: |
| 43 | - ueId-start: 123456789123458 |
| 44 | ueId-end: 123456789123458 |
| 45 | plmnId: 20893 |
| 46 | opc: 8e27b6af0e692e750f32667a3b14605d |
| 47 | key: 8baf473f2f8fd09487cccbd7097c6862 |
| 48 | sequenceNumber: 16f3b3f70fc2 |
| 49 | - ueId-start: 123456789123460 |
| 50 | ueId-end: 123456789123465 |
| 51 | plmnId: 20893 |
| 52 | opc: 8e27b6af0e692e750f32667a3b14605d |
| 53 | key: 8baf473f2f8fd09487cccbd7097c6862 |
| 54 | sequenceNumber: 16f3b3f70fc2 |
| 55 | |
Andy Bavier | 212f640 | 2021-09-30 17:27:34 -0700 | [diff] [blame] | 56 | The simapp configurations for all deployments are stored in the ``aether-app-configs`` repository: |
| 57 | |
| 58 | * Production deployment: ``apps/sd-core-4g/overlays/prd-acc-gcp1/values.yaml`` |
| 59 | * Staging deployment: ``apps/sd-core-4g/overlays/stg-acc-aws/values.yaml`` |
| 60 | |
| 61 | Fleet will automatically deploy changes to these files once they are merged. |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 62 | |
Sean Condon | 435be9a | 2021-08-06 14:28:37 +0100 | [diff] [blame] | 63 | .. _configure_device_group: |
| 64 | |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 65 | Configure Connectivity Service for a new UE |
| 66 | ------------------------------------------- |
| 67 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 68 | To receive connectivity service, a UE must be added to a DeviceGroup. An Enterprise is typically |
| 69 | organized into one or more Sites, each Site which may contain one or more DeviceGroups. Navigate |
| 70 | to the appropriate DeviceGroup which is associated with the Site you wish to deploy on, and add |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 71 | the UE's IMSI to the DeviceGroup. |
| 72 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 73 | The Site details can be seen by navigating to the Site list view. |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 74 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 75 | |SITE-LIST| |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 76 | |
| 77 | In the ROC GUI, navigate to the Device Groups list view, to see the list of |
| 78 | Device Groups and their association to Sites. |
| 79 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 80 | |DEVICEGROUP-LIST| |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 81 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 82 | In the DeviceGroup *New York POS* example above an UE ID Range **store** of |
| 83 | **70-73** will mean the set of UE IDs (when the *format* specifier of the |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 84 | *starbucks-newyork* Site are applied to its *MCC*, *MNC* and *Enterprise*) of |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 85 | |
| 86 | * 021032002000070 (021-032-002-000070) |
| 87 | * 021032002000071 |
| 88 | * 021032002000072 |
| 89 | * 021032002000073 |
| 90 | |
| 91 | .. note:: |
| 92 | For 4G service, a UE may participate in at most one DeviceGroup, and that DeviceGroup may |
| 93 | participate in at most one VCS. For 5G service, a UE can participate in many DeviceGroups, and each |
| 94 | DeviceGroup may participate in many VCSes. |
| 95 | |
| 96 | Editing |
| 97 | ******* |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 98 | Edit the DeviceGroup by clicking on the Edit icon, and in the List page, |
| 99 | adjust an existing UE ID range or create a new range (by clicking on the `+` icon). |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 100 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 101 | |DEVICEGROUP-EDIT| |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 102 | |
| 103 | The following restrictions apply |
| 104 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 105 | #. The "end" value must be greater than or equal to the "start" value. If the 2 are equal then this constitutes |
| 106 | a range of size 1. |
| 107 | #. The IMSI ID specified in "start" or "end" is relative to *MCC*, *MNC* and *Enterprise* of the Site. |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 108 | #. The maximum value of an IMSI ID is defined by the number of **S** characters in the `format` specifier of the Site. |
| 109 | #. IMSI Ranges are contiguous ranges of IMSI IDs. To accommodate non contiguous IMSI IDs, add extra Ranges. |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 110 | #. IMSI Ranges can have a maximum span of 100 between "start" and "end" IMSI IDs. Break bigger spans in to many ranges. |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 111 | #. IMSI ranges within a DeviceGroup cannot not overlap. |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 112 | |
| 113 | When the entries on the DeviceGroup edit page are valid the **Update** will become available |
| 114 | |
| 115 | * Click this to add the changes to the **Basket** of configuration changes |
| 116 | * Observe that the **Basket** icon (2nd icon from top right) displays the number of changes |
| 117 | |
| 118 | .. note:: |
| 119 | The changes are not committed to **aether-config** until the **Basket** is committed. |
| 120 | This allows several changes to be gathered together in one transaction and checked before committing. |
| 121 | |
Sean Condon | 435be9a | 2021-08-06 14:28:37 +0100 | [diff] [blame] | 122 | .. _committing: |
| 123 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 124 | Committing |
| 125 | ********** |
| 126 | To commit the changes |
| 127 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 128 | #. Click on the **Basket** icon (2nd icon from top right) to see the Basket view |
| 129 | #. Inspect the changes to be committed (optional) |
| 130 | #. Click **Commit** to perform the commit |
| 131 | #. Observe the response that's temporarily displayed that shows the success or failure of the commit |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 132 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 133 | |BASKETVIEW-NEWRANGE| |
| 134 | |
| 135 | History |
| 136 | ******* |
| 137 | If you are an Aether ROC Administrator, you will be able to see the History of changes, from the *Basket View* by |
| 138 | clicking on the **History** button. |
| 139 | |
| 140 | |BASKETVIEW-HISTORY| |
| 141 | |
| 142 | .. note:: The *History* button will only be visible if you are in the **AetherROCAdmin** group. |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 143 | |
| 144 | Remove Connectivity Service from an existing UE |
| 145 | ----------------------------------------------- |
| 146 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 147 | Using the ROC GUI, navigate to the DeviceGroup that contains the UE, |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 148 | then remove that UE's IMSI from the list. If you are removing a single UE, and the |
| 149 | DeviceGroup is configured with a range specifier that includes several IMSIs, |
| 150 | then it might be necessary to split that range into multiple ranges. |
| 151 | |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 152 | * If the UE to be removed has an IMSI ID in the middle of an existing IMSI Range: |
| 153 | click the *trash can* icon next to that *IMSI Range* and |
| 154 | use the *+* icon to add new Ranges for the remaining IMSI IDs. |
| 155 | * Alternatively if the UE to be removed has an IMSI ID at the start or end of an existing IMSI Range: |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 156 | then adjust the **start** or **end** value accordingly. |
| 157 | * Once finished editing, proceed to the *Basket View*, inspect the changes and Commit. |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 158 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 159 | |DEVICEGROUP-EDIT| |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 160 | |
| 161 | .. note:: |
| 162 | The UE may continue to have connectivity until its next detach/attach cycle. |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 163 | |
| 164 | Create a new DeviceGroup |
| 165 | ------------------------ |
| 166 | |
| 167 | DeviceGroups allow UEs to be grouped and configured together. Each site comes preconfigured with |
| 168 | a default DeviceGroup, but additional DeviceGroups may be created. For example, placing all IP |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 169 | Cameras in an "my-site-ip-cameras" DeviceGroup would allow you to group IP Cameras together. |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 170 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 171 | To add a DeviceGroup, navigate to the list of DeviceGroups and click `Add` in the upper right. |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 172 | (This may be grayed out if you do not have appropriate permissions). |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 173 | |
| 174 | * Specify a unique **id** for the DeviceGroup |
| 175 | 40 characters max and only alphanumeric and `-`, `_` and `.` allowed |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 176 | * Choose a *Site* from the preconfigured list |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 177 | It will not be possible to add IMSI Ranges until the Site is chosen |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 178 | * UE ID Ranges can be added at this stage or later |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 179 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 180 | |DEVICEGROUP-ADD| |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 181 | |
| 182 | Delete a DeviceGroup |
| 183 | -------------------- |
| 184 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 185 | If a DeviceGroup is no longer needed, it can be deleted. Deleting a DeviceGroup will not cause |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 186 | the UEs participating in the group to automatically be moved elsewhere. |
| 187 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 188 | .. note:: |
| 189 | If a Device Group is being used by an existing VCS, then it cannot be removed. |
| 190 | Delete the VCS first, and then the DeviceGroup. |
| 191 | |
| 192 | A DeviceGroup can be deleted from the DeviceGroup list view, by clicking the *trash can* icon |
| 193 | next to it. The deletion is added to the **Basket** directly. Navigate to the *Basket View* |
| 194 | to commit the change. |
| 195 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 196 | |DEVICEGROUP-LIST| |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 197 | |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 198 | |
| 199 | Add a DeviceGroup to a Virtual Connectivity Service (VCS) |
| 200 | --------------------------------------------------------- |
| 201 | |
| 202 | In order to participate in the connectivity service, a DeviceGroup must be associated with |
| 203 | a Virtual Connectivity Service (VCS). |
| 204 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 205 | Navigate to the *VCS* list view to see the list of VCS's and their associations to DeviceGroups. |
| 206 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 207 | |VCS-LIST| |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 208 | |
| 209 | To edit a *VCS* click on the *edit* button next to it in this list. |
| 210 | |
| 211 | This brings up the VCS edit page where (among many other things) zero, one or many |
| 212 | DeviceGroups can be associated with it. |
| 213 | |
| 214 | * Click the *trash can* symbol to remove a DeviceGroup from the VCS |
| 215 | * Click the *+* icon to add a DeviceGroup |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 216 | * Click the *Enable* slider to Enable or Disable the DeviceGroup |
| 217 | * This is a way of disabling or reenabling the DeviceGroup within a VCS without having to remove it |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 218 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 219 | |VCS-EDIT| |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 220 | |
| 221 | Remove a DeviceGroup from a Virtual Connectivity Service (VCS) |
| 222 | -------------------------------------------------------------- |
| 223 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 224 | The procedure is covered in the above section. |
Scott Baker | e59540c | 2021-08-02 11:51:54 -0700 | [diff] [blame] | 225 | |
Sean Condon | 435be9a | 2021-08-06 14:28:37 +0100 | [diff] [blame] | 226 | .. _monitor_device_group: |
| 227 | |
| 228 | Monitoring a DeviceGroup |
| 229 | ------------------------ |
| 230 | |
| 231 | The performance of a Device Group can be monitored in many ways, by clicking its |monitor| (**monitor**) icon: |
| 232 | |
| 233 | * From the *VCS Monitor* page, which shows all DeviceGroup's belonging to an VCS. |
| 234 | * From the DeviceGroup List Page - click the |monitor| icon for the DeviceGroup. |
| 235 | * When editing an existing DeviceGroup - in the Edit page, the |monitor| is next to the *id* |
| 236 | |
| 237 | The *monitor* page itself shows: |
| 238 | |
| 239 | * An information Panel for each *IMSI Range* in the *DeviceGroup* |
| 240 | |
| 241 | * Each UE has a |monitor| button that allows further drill down |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 242 | * Each UE is shown with its fully expanded IMSI number (a combination of *IMSI ID* and *Site* parameters) |
Sean Condon | 435be9a | 2021-08-06 14:28:37 +0100 | [diff] [blame] | 243 | * An information panel for the *Site* and *IP Domain* of the *DeviceGroup* |
| 244 | |
| 245 | * Clicking on the down arrow expands each panel |
| 246 | |
| 247 | .. image:: images/aether-roc-gui-devicegroup-monitor.png |
| 248 | :width: 600 |
| 249 | :alt: DeviceGroup Monitor View with UE links and information panels |
| 250 | |
| 251 | The per UE Monitor panel contains: |
| 252 | |
| 253 | * a graph of the UE's Throughput and Latency over the last 15 minutes |
| 254 | * a graph of the UE's connectivity over the last 15 minutes |
| 255 | |
| 256 | .. image:: images/aether-roc-gui-ue-monitor.png |
| 257 | :width: 600 |
| 258 | :alt: DeviceGroup Monitor View with UE links and information panels |
| 259 | |
| 260 | |
| 261 | .. |monitor| image:: images/monitor-icon.png |
| 262 | :width: 28 |
| 263 | :alt: Monitor icon |
| 264 | |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 265 | .. |DEVICEGROUP-ADD| image:: images/aether-roc-gui-devicegroup-add.png |
| 266 | :width: 490 |
| 267 | :alt: Adding a new Device Group requires an *id* and choosing a Site |
| 268 | |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 269 | .. |DEVICEGROUP-LIST| image:: images/aether-roc-gui-devicegroups-list.png |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 270 | :width: 1000 |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 271 | :alt: Device Groups List View in Aether ROC GUI showing Site association and IMSI Range of all DeviceGroups |
Sean Condon | f918f64 | 2021-08-04 14:32:53 +0100 | [diff] [blame] | 272 | |
| 273 | .. |DEVICEGROUP-EDIT| image:: images/aether-roc-gui-devicegroup-edit.png |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 274 | :width: 700 |
Zack Williams | 1ae109e | 2021-07-27 11:17:04 -0700 | [diff] [blame] | 275 | :alt: Device Groups Edit View in Aether ROC GUI showing IMSI Range |
Sean Condon | 435be9a | 2021-08-06 14:28:37 +0100 | [diff] [blame] | 276 | |
| 277 | .. |VCS-LIST| image:: images/aether-roc-gui-vcs-list.png |
| 278 | :width: 920 |
| 279 | :alt: VCS List View in Aether ROC GUI showing DeviceGroup association |
Sean Condon | 3727474 | 2022-01-26 09:52:45 +0000 | [diff] [blame] | 280 | |
| 281 | .. |VCS-EDIT| image:: images/aether-roc-gui-vcs-edit.png |
| 282 | :width: 700 |
| 283 | :alt: VCS Edit View in Aether ROC GUI showing DeviceGroup association editing |
| 284 | |
| 285 | .. |BASKETVIEW-NEWRANGE| image:: images/aether-roc-gui-basket-view-new-range.png |
| 286 | :width: 635 |
| 287 | :alt: Basket View with some changes ready to be committed |
| 288 | |
| 289 | .. |BASKETVIEW-HISTORY| image:: images/aether-roc-gui-basket-view-history.png |
| 290 | :width: 800 |
| 291 | :alt: Basket View with history of last changes |
| 292 | |
| 293 | .. |SITE-LIST| image:: images/aether-roc-gui-sites-list.png |
| 294 | :width: 755 |
| 295 | :alt: Sites List View in Aether ROC GUI showing site details |