blob: d0b5429c9930d783f3682469cbc0e701b506a246 [file] [log] [blame]
Hyunsun Moon6338f3a2020-11-01 00:29:23 -07001..
2 SPDX-FileCopyrightText: © 2020 Open Networking Foundation <support@opennetworking.org>
3 SPDX-License-Identifier: Apache-2.0
4
5===========================
6Connectivity Control Update
7===========================
Scott Baker8d830a52021-09-16 16:45:37 -07008At this point, the Aether runtime should be ready.
9In order to make Aether connectivity control to serve the new ACE,
10we need to provision the subscriber and configure the connectivity service.
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070011
12Before you begin
13================
14Make sure you have the edge pod checklist ready.
15Specifically, the following information is required in this section.
16
Scott Baker8d830a52021-09-16 16:45:37 -070017* `Enterprise Name`. Choose a concise text identifier for the enterprise.
18* `MCC`. Mobile country code. Consult Aether PMFE for assignment.
19* `MNC`. Mobile network code. Consult Aether PMFE for assignment.
20* `Enterprise ID`. A numeric ID that uniquely identifies each enterprise
21 within Aether. Consult Aether PMFE for assignment.
22* List of small cell `addresses` and their `TAC` assignments.
23* Address of `BESS UPF`. See the previous section on setting up the BESS UPF.
24* Subscriber `IMSI list`. A list of IMSIs for SIMs that the Enterprise will
25 be provided with. New IMSIs can always be added later.
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070026
Scott Baker8d830a52021-09-16 16:45:37 -070027Download aether-app-configs repository
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070028======================================
Scott Baker8d830a52021-09-16 16:45:37 -070029First, download the aether-app-configs repository to your development machine.
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070030
31.. code-block:: shell
32
33 $ cd $WORKDIR
Scott Baker8d830a52021-09-16 16:45:37 -070034 $ git clone "ssh://[username]@gerrit.opencord.org:29418/aether-app-configs"
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070035
Scott Baker8d830a52021-09-16 16:45:37 -070036Update simapp settings
37======================
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070038
Scott Baker8d830a52021-09-16 16:45:37 -070039Edit the simapp configuration and add the new IMSIs to sim management. The
40file to edit depends on which Aether Connectivity Cluster serves the Enterprise
41site. The appropriate file for standard Aether production is
Andy Bavier212f6402021-09-30 17:27:34 -070042`aether-app-configs/apps/sd-core-4g/overlays/prd-acc-gcp1/values.yaml`. Other
Scott Baker8d830a52021-09-16 16:45:37 -070043clusters will be located in similar directories.
44
45The following example demonstrates adding IMSIs 123456789123460-123456789123465:
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070046
47.. code-block:: diff
48
Scott Baker8d830a52021-09-16 16:45:37 -070049 simapp.yaml:
50 info:
51 version: 1.0.0
52 description: SIMAPP initial local configuration
53 logger:
54 # network function
55 APP:
56 debugLevel: info
57 ReportCaller: false
58 configuration:
59 provision-network-slice: false
60 subscribers:
61 - ueId-start: 123456789123458
62 ueId-end: 123456789123458
63 plmnId: 20893
64 opc: 8e27b6af0e692e750f32667a3b14605d
65 key: 8baf473f2f8fd09487cccbd7097c6862
66 sequenceNumber: 16f3b3f70fc2
67 + - ueId-start: 123456789123460
68 + ueId-end: 123456789123465
69 + plmnId: 20893
70 + opc: 8e27b6af0e692e750f32667a3b14605d
71 + key: 8baf473f2f8fd09487cccbd7097c6862
72 + sequenceNumber: 16f3b3f70fc2
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070073
Scott Baker8d830a52021-09-16 16:45:37 -070074Commit your change back to the aether-app-configs repository when you are
75finished.
Hyunsun Moon6338f3a2020-11-01 00:29:23 -070076
Hyunsun Moona79c7422020-11-18 04:52:56 -080077
Scott Baker8d830a52021-09-16 16:45:37 -070078Configure Connectivity
79======================
80Once the SIMs are provisioned in `simapp`, the next step is to provision the customer in the ROC.
81All of these steps are done using the Portal.
Hyunsun Moona79c7422020-11-18 04:52:56 -080082
Scott Baker8d830a52021-09-16 16:45:37 -070083#. Create a new Enterprise. Link a Connectivity Service to the Enterprise.
Hyunsun Moona79c7422020-11-18 04:52:56 -080084
Scott Baker8d830a52021-09-16 16:45:37 -070085#. Create an AP-List. Enter all of the small cells and their TACs into the AP-List.
Hyunsun Moona79c7422020-11-18 04:52:56 -080086
Scott Baker8d830a52021-09-16 16:45:37 -070087#. Create a Site for the Enterprise. Each site should represent one geographical
88 point of presence where the Enterprise expects to have an Aether installation. Each site
89 will need the `MNC`, `MCC`, and `Enterprise ID`. Enter these parameters into the
90 `IMSI Format` together with a mask. Using a mask that is 15 "S" characters
91 (`SSSSSSSSSSSSSSS`) would allow arbitrary IMSIs to be associated with the Site. Add the
92 AP-List you created previously to the Site.
93
94#. Create an IP-Domain for the Enterprise. The IP-Domain should contain the DNS servers
95 and a subnet that can be assigned to the connected devices.
96
97#. Create a UPF object. Populate the UPF object with the address and port of the UPF.
98
99#. Create a Device-Group. Populate the Device-Group with the list of IMSIs that have
100 been assigned to the Enterprise. Link in the IP-Domain that was created previously, and
101 attach it to the site.
102
103#. Create a VCS. Select an appropriate template for the VCS. Link in the Device-Group,
104 AP-List, and UPF that was created previously.
105
106#. Repeat the steps above as necessary for each VCS and for each Site that belongs to
107 the enterprise.
108
109.. note:: This workflow does not address creating applications, as application filtering is
110 not part of the Aether-1.5 feature set.
111
112.. note:: This workflow does not address creating default sites, default device groups, or
113 default VCSes, as subscriber-proxy based subscriber-learning is not enabled at this time.