| 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 |
| 9 | existing subscribers, and associating subscribers with virtual connectivity services. |
| 10 | |
| 11 | Provisioning a new UE |
| 12 | --------------------- |
| 13 | |
| 14 | Before a UE can be granted connectivity service, it must first be provisioned. This step is normally |
| 15 | performed by Aether Operations. |
| 16 | |
| 17 | Each UE is assigned a PLMN and a set of security keys. Depending on the deployment scenario, these |
| 18 | keys might be shared by several UEs, or they might be unique to each UE. The allocation of PLMNs and |
| 19 | keys is currently performed manually by the Aether Operations team. This subscriber-related |
| 20 | detail is configured via the SIM Management application, Simapp. |
| 21 | |
| 22 | `simapp.yaml` needs to be adjusted to include the new UE IMSIs to the subscriber list. For example:: |
| 23 | |
| 24 | # simapp.yaml |
| 25 | # ... |
| 26 | simapp.yaml: |
| 27 | info: |
| 28 | version: 1.0.0 |
| 29 | description: SIMAPP initial local configuration |
| 30 | logger: |
| 31 | # network function |
| 32 | APP: |
| 33 | debugLevel: info |
| 34 | ReportCaller: false |
| 35 | configuration: |
| 36 | provision-network-slice: false |
| 37 | subscribers: |
| 38 | - ueId-start: 123456789123458 |
| 39 | ueId-end: 123456789123458 |
| 40 | plmnId: 20893 |
| 41 | opc: 8e27b6af0e692e750f32667a3b14605d |
| 42 | key: 8baf473f2f8fd09487cccbd7097c6862 |
| 43 | sequenceNumber: 16f3b3f70fc2 |
| 44 | - ueId-start: 123456789123460 |
| 45 | ueId-end: 123456789123465 |
| 46 | plmnId: 20893 |
| 47 | opc: 8e27b6af0e692e750f32667a3b14605d |
| 48 | key: 8baf473f2f8fd09487cccbd7097c6862 |
| 49 | sequenceNumber: 16f3b3f70fc2 |
| 50 | |
| 51 | TODO: This file will probably be placed under gitops control once the 5G ROC is deployed. Document |
| 52 | the new location of the file. |
| 53 | |
| 54 | Configure Connectivity Service for a new UE |
| 55 | ------------------------------------------- |
| 56 | |
| 57 | To receive connectivity service, a UE must be added to a DeviceGroup. An enterprise is typically |
| 58 | organized into one or more sites, each site which may contain one or more DeviceGroups. Navigate |
| 59 | to the site you where the device will be deployed, find the appropriate device group, and add |
| 60 | the UE's IMSI to the DeviceGroup. |
| 61 | |
| 62 | TODO: Describe GUI process and add Picture |
| 63 | |
| 64 | Note: For 4G service, a UE may participate in at most one DeviceGroup, and that DeviceGroup may |
| 65 | participate in at most one VCS. For 5G service, a UE can participate in many DeviceGroups, and each |
| 66 | DeviceGroup may participate in many VCSes. |
| 67 | |
| 68 | Remove Connectivity Service from an existing UE |
| 69 | ----------------------------------------------- |
| 70 | |
| 71 | Using the ROC GUI, navigate to the Device Group that contains the UE, |
| 72 | then remove that UE's IMSI from the list. If you are removing a single UE, and the |
| 73 | DeviceGroup is configured with a range specifier that includes several IMSIs, |
| 74 | then it might be necessary to split that range into multiple ranges. |
| 75 | |
| 76 | TODO: Describe GUI process and add Picture |
| 77 | |
| 78 | Note: The UE may continue to have connectivity until its next detach/attach cycle. |
| 79 | |
| 80 | Create a new DeviceGroup |
| 81 | ------------------------ |
| 82 | |
| 83 | DeviceGroups allow UEs to be grouped and configured together. Each site comes preconfigured with |
| 84 | a default DeviceGroup, but additional DeviceGroups may be created. For example, placing all IP |
| 85 | Cameras in an my-site-ip-cameras DeviceGroup would allow you to group IP Cameras together. |
| 86 | |
| 87 | TODO: Describe GUI process and add Picture |
| 88 | |
| 89 | Delete a DeviceGroup |
| 90 | -------------------- |
| 91 | |
| 92 | IF a DeviceGroup is no longer needed, it can be deleted. Deleting a DeviceGroup will not cause |
| 93 | the UEs participating in the group to automatically be moved elsewhere. |
| 94 | |
| 95 | TODO: Describe GUI process and add Picture |
| 96 | |
| 97 | Add a DeviceGroup to a Virtual Connectivity Service (VCS) |
| 98 | --------------------------------------------------------- |
| 99 | |
| 100 | In order to participate in the connectivity service, a DeviceGroup must be associated with |
| 101 | a Virtual Connectivity Service (VCS). |
| 102 | |
| 103 | TODO: Describe GUI process and add Picture |
| 104 | |
| 105 | Remove a DeviceGroup from a Virtual Connectivity Service (VCS) |
| 106 | -------------------------------------------------------------- |
| 107 | |
| 108 | TODO: Describe GUI process and add Picture |
| 109 | |