| Scott Baker | b260e92 | 2022-02-22 16:30:58 -0800 | [diff] [blame] | 1 | .. |
| 2 | SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org> |
| 3 | SPDX-License-Identifier: Apache-2.0 |
| 4 | |
| 5 | Subscriber Proxy |
| 6 | ================ |
| 7 | |
| 8 | The Aether subscriber proxy is a component that sits between the SD-Core's simapp |
| 9 | SIM card management subsystem and the SD-Core's configuration service, and communicates |
| 10 | newly provisioned SIM cards to the ROC. |
| 11 | |
| 12 | .. image:: images/subproxy.svg |
| 13 | :width: 400 |
| 14 | |
| 15 | How Subscriber Proxy Works |
| Scott Baker | a70016d | 2022-02-23 10:46:28 -0800 | [diff] [blame] | 16 | -------------------------- |
| Scott Baker | b260e92 | 2022-02-22 16:30:58 -0800 | [diff] [blame] | 17 | |
| 18 | The subscriber proxy transparently intercepts simapp traffic and inspects each message for |
| 19 | the IMSI that is contained in that message. If the IMSI is a new one that is not |
| 20 | already present in the ROC, then the subscriber proxy will contact the ROC to insert a |
| 21 | Sim-Card object with that IMSI. |
| 22 | |
| 23 | The subscriber proxy will attempt to insert the SIM Card into the appropriate site. It does |
| 24 | this by examining the `imsi-definition` for each site, until subscriber proxy finds a |
| 25 | site whose `mcc`, `mnc`, and `enterprise` match the IMSI that has been intercepted |
| 26 | from simapp. For this to work, the `imsi-format` must be set appropriately, for example |
| 27 | to `CCCNNEESSSSSSSS`. Setting the `imsi-format` to `SSSSSSSSSSSSSSS` will not allow the |
| 28 | subscriber-proxy to automatically determine the site. If no matching site exists, then |
| 29 | the subscriber proxy will attempt to add the Sim-Card to a site whose identifier is |
| 30 | `defaultent-defaultsite`. |
| 31 | |
| 32 | If no appropriate site can be determined, then the subscriber proxy will not add the |
| 33 | sim-card to the ROC, but the request will still be passed to SD-Core. |
| 34 | |
| 35 | Configuring simapp |
| Scott Baker | a70016d | 2022-02-23 10:46:28 -0800 | [diff] [blame] | 36 | ------------------ |
| Scott Baker | b260e92 | 2022-02-22 16:30:58 -0800 | [diff] [blame] | 37 | |
| 38 | To configure simapp to send messages to the subscriber proxy, edit simapp's configuration |
| 39 | file as follows:: |
| 40 | |
| 41 | simapp.yaml: |
| 42 | configuration: |
| 43 | sub-proxy-endpt: |
| 44 | addr: subscriber-proxy.aether-roc.svc.cluster.local |
| 45 | port: 5000 |
| 46 | |
| 47 | In the above example, `subscriber-proxy.aether-roc.svc.cluster.local` is the address of the |
| 48 | subscriber proxy. Do not remove the existing `sub-provision-endpt` as that setting contains |
| 49 | the address of the SD-Core, and will be passed through the proxy, so the proxy knows which |
| 50 | core to connect to. |