blob: f2f5186bf7f06efc096ee69fdf24b53da6871f09 [file] [log] [blame]
Zack Williams1ae109e2021-07-27 11:17:04 -07001Aether 1.5 Release
2==================
3
4Highlights
5----------
6
Zack Williams9e6c2722021-09-20 16:38:32 -07007The focus of this release is an update of Aether to support the 5G SD-Core.
8This included a redesign of Aether modeling and workflows, integration of the
95G SD-Core into Aether, and an update of the 4G SD-Core to be compliant with
10the 5G Aether API. 4G Small Cells are readily available and deployed at
11multiple Aether installations. The 5G Core is part of a Deutsche Telekom SD-RAN
12trial and is being used with 5G-SA disaggregated RAN components (CU/DU/RU).
13
14Deployment of Aether has been demonstrated on Anthos and on Elastic Kubernetes
15Service. Persistent test deployments are now maintained by ONF to further
16evaluate Aether functionality on those platforms.
17
Zack Williams1ae109e2021-07-27 11:17:04 -070018
19New Features and Improvements
20-----------------------------
21
Zack Williams9e6c2722021-09-20 16:38:32 -0700224G and 5G Connectivity Service
23""""""""""""""""""""""""""""""
Zack Williams1ae109e2021-07-27 11:17:04 -070024
Zack Williams9e6c2722021-09-20 16:38:32 -070025Aether supports mobile/cellular connectivity using both the 4G and the 5G
26SD-Core. The Aether ROC may be used with both cores simultaneously. The 4G
27modeling used by Aether-1.0 has been replaced with newer modeling that unifies
28the 4G and 5G cores in a single modeling abstraction.
Zack Williams1ae109e2021-07-27 11:17:04 -070029
Zack Williams9e6c2722021-09-20 16:38:32 -070030Device Grouping and Network Slicing
31"""""""""""""""""""""""""""""""""""
32
33Aether supports a Network Slicing abstraction where similar connected devices
34can be aggregated together into a Device-Group, and different Device Groups can
35be allocated to different network slices (Virtual Connectivity Service - VCS).
36
37Grouping connected devices affords ease of management - devices in the same
38group are configured together and afforded the same treatment in the network.
39Separating device-groups into different slices affords isolation between
40groups. The data plane connectivity for different slices are realized through
41different User Plane Functions (UPFs).
42
43Furthermore, Aether supports Access Control - devices not part of any
44Device-Group are rejected by the network.
45
46Aether Portal
47"""""""""""""
48
49The Aether Portal is a modern secure Single Page Application implemented in
50Angular. The portal integrates both control of the Aether Network and metrics
51reported by Aether components in a single pane of glass with multi-tenancy
52separation. The portal allows complex control operations to be batched together
53as one transaction into a convenient basket and then atomically committed to
54the configuration. All of the functions of the Portal are also available on a
55secure REST API, with an OpenAPI 3 schema.
56
57Role-Based Access Control
58"""""""""""""""""""""""""
59
60The Aether control API supports role-based access control, together with
61external authentication using OpenID Connect. These access controls are used in
62the Aether Portal to limit which enterprises a portal user is allowed to view
63or modify. The Aether Portal supports multiple enterprises simultaneously.
64
65Flexible Kubernetes Deployment Options
66""""""""""""""""""""""""""""""""""""""
67
68Fully managed Aether deployment using Rancher is officially supported. Together
69with Rancher, Aether allows configuration, management, and monitoring of
70Kubernetes clusters. These clusters can be used to host the Aether Connectivity
71Service as well as customer edge applications. Support for other managed
72Kubernetes services such as Google Anthos or Amazon Elastic Kubernetes Service
73should be considered beta and not officially supported.
74
75Testing
76-------
77
78Aether uses automated testing based on Jenkins and Robot Framework. The tests
79performed are described below.
80
81SD-Core Tests
82"""""""""""""
83
84* 4G
85
86 * Functional Coverage: Attach,detach, dataplane traffic, handover, TAU,
87 paging, error scenarios, few failure/restart of network functions
88
89 * Scale and Performance tests utilizing BESS
90
91* 5G
92
93 * Functional Coverage: register, deregister, dataplane traffic scenarios,
94 handover, TAU, DDN, few error scenarios, few failure/restart of network
95 functions
96
97 * Scale tests (BESS)
98
99Jenkins jobs for functional and scale tests can be found on `Aether Jenkins -
100SD-Core System Tests
101<https://jenkins.aetherproject.org/view/SD%20Core%20System%20Tests/>`_
102
103ROC
104"""
105
106 * Functional API and GUI test coverage
107
108Jenkins jobs: `Aether Jenkins - ROC System Tests
109<https://jenkins.aetherproject.org/view/ROC%20System%20Tests/>`_
Zack Williams1ae109e2021-07-27 11:17:04 -0700110
111
Zack Williams9e6c2722021-09-20 16:38:32 -0700112System Tests
113""""""""""""
Zack Williams1ae109e2021-07-27 11:17:04 -0700114
Zack Williams9e6c2722021-09-20 16:38:32 -0700115* 4G and 5G Sanity Test coverage:
Zack Williams1ae109e2021-07-27 11:17:04 -0700116
Zack Williams9e6c2722021-09-20 16:38:32 -0700117 * Configure ROC with related models for 4G and 5G
118 * Validate for attach/register UE, pings, detach/degister UE
119
120Jenkins Jobs: `Aether Jenkins - Aether System Tests
121<https://jenkins.aetherproject.org/view/Aether%20System%20Tests/>`_
122
123Documentation
124-------------
125
126Aether documentation is available at `docs.aetherproject.org
127<https://docs.aetherproject.org>`_
Zack Williams1ae109e2021-07-27 11:17:04 -0700128
129
130Known Issues and Limitations
131----------------------------
132
Zack Williams9e6c2722021-09-20 16:38:32 -0700133* A given UE may participate in a 4G core or a 5G core, but not both.
Zack Williams1ae109e2021-07-27 11:17:04 -0700134
Zack Williams9e6c2722021-09-20 16:38:32 -0700135* 4G UEs may each participate in a single DeviceGroup, and 4G DeviceGroups may
136 each participate in a single VCS. This restriction does not apply to 5G UEs.
137
138* Application filtering is modeled in the API and the GUI, but application
139 filtering is not active in the data plane.
140
141* Disabling/deleting a device group from a VCS does not restrict UE from
142 getting attached to the network [SDCORE-467]
Zack Williams1ae109e2021-07-27 11:17:04 -0700143
144Component Versions in the 1.5 Release
145-------------------------------------
146
Scott Bakeraf8641d2021-09-20 20:48:09 -0700147Helm Chart Versions and their component charts and containers:
Zack Williams1ae109e2021-07-27 11:17:04 -0700148
Scott Bakeraf8641d2021-09-20 20:48:09 -0700149* atomix-controller: ``0.6.8``
Zack Williams1ae109e2021-07-27 11:17:04 -0700150
Scott Bakeraf8641d2021-09-20 20:48:09 -0700151 * atomix-controller: ``v0.6.1``
Zack Williams1ae109e2021-07-27 11:17:04 -0700152
Scott Bakeraf8641d2021-09-20 20:48:09 -0700153* atomix-raft: ``0.1.9``
Zack Williams1ae109e2021-07-27 11:17:04 -0700154
Scott Bakeraf8641d2021-09-20 20:48:09 -0700155 * atomix-raft-storage-controller: ``v0.9.2``
Zack Williams1ae109e2021-07-27 11:17:04 -0700156
Scott Bakeraf8641d2021-09-20 20:48:09 -0700157* aether-roc-umbrella: ``1.3.9``
Zack Williams9e6c2722021-09-20 16:38:32 -0700158
Scott Bakeraf8641d2021-09-20 20:48:09 -0700159 * config-models/aether-3.x: ``3.0.13``
Zack Williams9e6c2722021-09-20 16:38:32 -0700160
Scott Bakeraf8641d2021-09-20 20:48:09 -0700161 * aether-roc-api: ``v0.7.14``
Zack Williams9e6c2722021-09-20 16:38:32 -0700162
Scott Bakeraf8641d2021-09-20 20:48:09 -0700163 * aether-roc-gui: ``v0.7.22``
Zack Williams9e6c2722021-09-20 16:38:32 -0700164
Scott Bakeraf8641d2021-09-20 20:48:09 -0700165 * onos-config: ``v0.9.2``
Zack Williams9e6c2722021-09-20 16:38:32 -0700166
Scott Bakeraf8641d2021-09-20 20:48:09 -0700167 * onos-topo: ``v0.8.3``
Zack Williams9e6c2722021-09-20 16:38:32 -0700168
Scott Bakeraf8641d2021-09-20 20:48:09 -0700169 * sdcore-adapter: ``v0.1.36``
Zack Williams9e6c2722021-09-20 16:38:32 -0700170
Scott Bakeraf8641d2021-09-20 20:48:09 -0700171* sdcore-helm-chart: ``0.6.2``
Zack Williams9e6c2722021-09-20 16:38:32 -0700172
Scott Bakeraf8641d2021-09-20 20:48:09 -0700173 * omec-control-plane: ``0.6.25``
Zack Williams9e6c2722021-09-20 16:38:32 -0700174
Scott Bakeraf8641d2021-09-20 20:48:09 -0700175 * hssdb: ``c3po-hssdb:master-9a5f565``
176 * hss: ``c3po-hss:master-9a5f565``
177 * mme: ``nucleus:master-86d2678``
178 * spgwc: ``spgw:master-6aad2f2``
179 * pcrf: ``c3po-pcrf:pcrf-b29af70``
180 * pcrfdb: ``c3po-pcrfdb:pcrf-b29af70``
181 * config4g: ``5gc-webui:onf-release3.0.5-bf0b54f``
Zack Williams9e6c2722021-09-20 16:38:32 -0700182
Scott Bakeraf8641d2021-09-20 20:48:09 -0700183 * omec-sub-provision: ``0.0.6``
Zack Williams9e6c2722021-09-20 16:38:32 -0700184
Scott Bakeraf8641d2021-09-20 20:48:09 -0700185 * simapp: ``simapp:main-7d20738``
Zack Williams9e6c2722021-09-20 16:38:32 -0700186
Scott Bakeraf8641d2021-09-20 20:48:09 -0700187 * 5g-control-plane: ``0.2.21``
Zack Williams9e6c2722021-09-20 16:38:32 -0700188
Scott Bakeraf8641d2021-09-20 20:48:09 -0700189 * amf: ``5gc-amf:onf-release3.0.5-921b890``
190 * nrf: ``5gc-nrf:onf-release3.0.5-3471442``
191 * smf: ``5gc-smf:onf-release3.0.5-e991983``
192 * ausf: ``5gc-ausf:onf-release3.0.5-85ea075``
193 * nssf: ``5gc-nssf:onf-release3.0.5-c372b24``
194 * pcf: ``5gc-pcf:onf-release3.0.5-95ae49f``
195 * udr: ``5gc-udr:onf-release3.0.5-bc3b287``
196 * udm: ``5gc-udm:onf-release3.0.5-40055e8``
197 * webui: ``5gc-webui:onf-release3.0.5-bf0b54f``
Zack Williams9e6c2722021-09-20 16:38:32 -0700198
Scott Bakeraf8641d2021-09-20 20:48:09 -0700199 * omec-user-plane: ``0.3.36``
Zack Williams9e6c2722021-09-20 16:38:32 -0700200
Scott Bakeraf8641d2021-09-20 20:48:09 -0700201 * bess: ``upf-epc-bess:master-fcdbc95``
202 * pfcpiface: ``upf-epc-pfcpiface:master-fcdbc95``