blob: 519785afb677076741e5d93f42df626a2b63c921 [file] [log] [blame]
Scott Bakeraf71a722021-12-15 16:30:01 -08001Aether 1.6 Release
2==================
3
4Highlights
5----------
6
7The focus of this release of Aether is expanding the Quality of Service (QoS)
8feature to include the ability to have per-Slice and per-Device-by-Application
9QoS settings, as well as to add a new Application Filtering feature. Aether
10modeling continues to be improved as documented below, and many additional
11reliability improvements have been made to the underlying subsystems.
12
13New Features & Improvements
14---------------------------
15
16Three Levels of Quality of Service (QoS) Control
17""""""""""""""""""""""""""""""""""""""""""""""""
18
19Aether now supports Maximum Bitrate Quality of Service (MBR QoS) settings at
20three different levels:
21
22* Per-Device. Configured as part of the Device-Group abstraction. Each slice may
23 contain multiple device groups, and therefore configure a heterogeneous set of
24 devices. These settings are mandatory.
25
26* Per-Device by Application. These allow the MBR to be limited for the flow
27 between a pair of Device and Application. These QoS settings are optional and
28 are specified as part of Application Filtering.
29
30* Per-Slice. The per-Slice settings allow the aggregate bandwidth of all devices
31 in a slice to be limited. This is enforced as part of the User Plane Function
32 (UPF). These QoS settings are optional.
33
34In addition to MBR, Aether also allows a Traffic Class to be specified at the
35Per-Device (Device-Group) and Application contexts. The Traffic Class further
36defines the QCI and ARP used for 5G.
37
38Application Filtering
39"""""""""""""""""""""
40
41Aether supports application filtering performed by the User Plane Function
42(UPF). The application filtering feature allows devices in a slice to have
43access to only those applications allocated to the slice, and vice-versa,
44thereby extending the isolation capabilities of a slice to the
45edge-applications. Some applications (such as public Internet access) can also
46be shared across slices.
47
48Aether allows a total of five user-defined application endpoint filtering
49rules, plus one default rule that may be set to either Allow-All or Deny-All.
50The application endpoint filtering rules allow the filter to be composed of
51application IP address, protocol (TCP, UDP, etc), and port. Each rule is
52assigned a priority, and the rules are executed in priority order until a match
53is found. The default rule (for example Deny-All), is assigned the least
54priority and is executed last.
55
56UPF Pools
57"""""""""
58
59Aether allows a set of UPFs to be created at customer onboarding, and those
60UPFs may later be associated with Slices as the customer creates additional
61slices. Additional UPFs may be added to the pool at any time by the operator.
62The GUI maintains the invariant that a UPF may only be assigned to one Slice at
63a time, that the UPF must be located at the same Site as the VCS, and assists
64the user in filtering out in-use UPFs when a VCS is created.
65
66Monitoring Support
67""""""""""""""""""
68
69The Aether GUI now displays site health statistics. These statistics are
70collected by Aether using the Prometheus tool set, and are fetched on demand by
71the GUI. Aether can display metrics such as the number of nodes and number of
72healthy edge monitoring devices at a site.
73
74Modeling Updates
75""""""""""""""""
76
77The following other miscellaneous modeling updates have been added:
78
79* Standardized all bitrates to be specified as bits per second (bps).
80
81* Several models have been updated to make it so that their names may be easily
82 changed, without requiring the model to be deleted and re-created.
83
84* The AP-List model has been renamed to Small-Cell and has been merged into the
85 Site model.
86
87Testing
88-------
89
90Aether uses automated testing based on Jenkins and Robot Framework. The tests
91performed are described below.
92
Scott Bakeraf71a722021-12-15 16:30:01 -080093ROC
94"""
95
96* Functional API and GUI test coverages
97
98Jenkins jobs: `Aether Jenkins - ROC System Tests
99<https://jenkins.aetherproject.org/view/ROC%20System%20Tests/>`_
100
101System Tests
102""""""""""""
103
104* 4G
105
106 * Functional testing includes multiple slice creations, enable/disable of device
107 groups, add/update IMSI ranges, QoS validations, rate limiting tests (at UE,
108 slice, application), application filtering tests, container restart tests
109
110Jenkins Jobs: `Aether Jenkins - Aether System Tests
111<https://jenkins.aetherproject.org/view/Aether%20System%20Tests/>`_
112
113Documentation
114-------------
115
116Aether documentation is available at `docs.aetherproject.org
117<https://docs.aetherproject.org>`_
118
119Known Issues and Limitations
120----------------------------
121
122* An individual Device may participate in a 4G core or a 5G core, but not both.
123
124* 4G Devices may each participate in a single DeviceGroup, and 4G DeviceGroups
125 may each participate in a single VCS.
126
127* Application endpoints may only specify an IPv4 address, and may not specify
128 ports (either a single one or a range). As a consequence, we support the
129 definition of only one application per IPv4 address. This limitation will
130 be removed in Aether 2.0.
131
132* When ROC’s sdcore-adapter-v4 pod restarts, its cached internal state must be
133 manually refreshed.
134
135* If ConfigPod is crashed/restarted then we need a manual restart of simapp pod.
136
137* UPFs listed in the ROC should all be reachable, cannot include an unreachable
138 UPF which may keep the existing UPFs to not function properly.
139
Scott Baker8ca82322022-01-26 09:19:31 -0800140Limitations on modifying objects by Enterprise Administrators
141-------------------------------------------------------------
142
143The following models and fields contain information that is configured by ONF
144Operations and should not be edited by an Enterprise Administrator. The GUI does
145not currently prevent editing these fields.
146
147* `Connectivity Service`. This object is fully managed by ONF. Do not add or edit.
148
149
150* `Enterprise`. This object is fully managed by ONF. Do not add or edit.
151
152* `IP Domain`.
153
154 * `Subnet` must match the deployed UPF associated with the VCS that this
155 IP Domain is used from. Do not change the subnet once it has been set. Do
156 not attempt to share a Subnet or a DNN across multiple VCSes.
157
158 * `DNN` must be unique per VCS that uses this IP Domain.
159
160* `Site`. New sites should not be added by the enterprise, but limited editing
161 of the site can take place, for example to change the `Display Name` or the
162 `Description`.
163
164 * `Small Cells` are preconfigured by ONF, but an enterprise may
165 add additional small cells over time with assistance from ONF for
166 configuration.
167
168 * `Monitoring` URLs should not be changed.
169
170 * `Edge Devices` are preconfigured by ONF, but an enterprise may add additional
171 edge devices over time. These devices are specifically Aether Edge Monitoring
172 Devices. Do not add non-Monitoring edge devices.
173
174 * The `IMSI` (`MCC`, `MNC`, `Enterprise`, and `Format`) should not be
175 changed without consultation with ONF.
176
177* `Template`. These are fully managed by ONF. Do not add or edit.
178
179* `Traffic Class`. These are fully managed by ONF. Do not add or edit.
180
181* `UPF`. UPFs are created at enterprise onboarding time and made available by a
182 pool. There are no enterprise-modifiable attributes within the UPF object. If
183 the Enterprise needs to create an additional VCS and there are no available
184 UPFs, then please contact ONF and additional UPFs will be provisioned and added
185 to the pool.
186
187* `VCS`. VCSes may be added by the enterprise, up to the number of available UPFs.
188
189 * `Device Groups`. It is recommended that only one device group be added per VCS at this time.
190
Scott Bakeraf71a722021-12-15 16:30:01 -0800191Component Versions
192------------------
193
194ROC:
195
196* atomix-controller: 0.6.8
197
198* atomix-raft-storage: 0.1.15
199
200* onos-operator: v0.4.14
201
202* aether-roc-umbrella: 1.4.64
203
Zack Williams44faef92022-03-08 22:07:49 -0700204:doc:`SD-Core 1.0 <sdcore:release/1.0>`
Scott Bakeraf71a722021-12-15 16:30:01 -0800205
Scott Baker1b05dc82021-12-16 14:25:03 -0800206* sdcore-helm-chart: 0.9.17
Scott Bakeraf71a722021-12-15 16:30:01 -0800207
Zack Williams44faef92022-03-08 22:07:49 -0700208:doc:`SD-Fabric 1.0.1 <sdfabric:release/1.0.1>`
Scott Bakeraf71a722021-12-15 16:30:01 -0800209
210* sdfabric: 1.0.10
211
212* onos-classic chart: 0.1.26
213
214* stratum chart: 0.1.18
215
216* pfcp-agent chart: 0.0.1
217
218* dbuf chart: 0.0.1
219
220* int-host-reporter chart: 0.0.1
221
222Sercomm eNB
223
224* Firmware version: TEST3918@210224
225
226* Configuration file version: 0.1.0