Skip to content

Releases: magma/magma

Magma v1.8.0 (Newberry)

22 Sep 20:14
49ed2e6
Compare
Choose a tag to compare

Introduction
The 1.8.0 release supports AGW on Arm architecture, adds new features and fixes some of the known issues with previous releases. Please see the test report for more information. Note that new features follow these maturity definitions as it pertains to alpha, beta, or GA.

Key Features and Improvements

Containerized AGW enablement on Arm architecture (Alpha)

Containerized AGW docker image build is enabled on aarch64.

Containerized AGW build job is added in Magma CI.

Documented the steps to bring up containerized AGW https://github.com/magma/magma/blob/v1.8/docs/readmes/lte/deploy_install_docker.md

Documented the steps to build containerized AGW
https://github.com/magma/magma/blob/v1.8/lte/gateway/docker/README.md

AWS Arm Graviton2 LTE test with srsRAN: Performed LTE traffic test from UE to Internet using srsRAN UE/eNodeb. Ran containerized AGW image on AWS graviton2 instance with kernel 5.4.0-1017-aws.

Sercomm Real Radio LTE test: UE Attach/Detach, data service (speedtest, iperf tcp/udp) is performed using Sercomm Englewood Radio with containerized AGW image running on Sercomm Bridgecolumn (NXP Arm LS1046 based device) with kernel 5.4.47-rt.

Connect 5G's LTE and 5G SA tests on Nexcom DTA 1376 systems (NXP Arm LS1046A 4-core Cortex-A72 based device):

  1. 5G SA Live radio test: Tested 5G SA with a T1 radio and BEC 8230 CPE using v1.8 image.
    Note: 1.8 image required additional fixes due to the known issue #12846. After a workaround for the defect was applied, the CPE attached successfully. Traffic flow was verified with ping to gtp_br0 (192.168.128.1) and to Cloudfire (1.1.1.1).
  2. 5G SA test using UERANSIM: Ping test to gtp_br0 (192.168.128.1) and to Cloudfire (1.1.1.1) passed with workarounds.
    Note: To pass the test, a series of restarts of the containers is needed to update the configurations, followed by a reboot of the device. In addition, due to the defect #12846 the gNB should not populate the time stamp field.
  3. LTE test using srsRAN: Tested 1.8 AGW docker image on Nexcom DTA1376 with kernel 5.4.47 (Based on Ubuntu 20.04 LSDK image). Ping test with srsRAN UE/eNodeb simulator worked for 24 hours, both on internal interfaces and to internet site.

Connect 5G's LTE and 5G SA tests on Mac Mini Apple M1 with Parallels VM:

  1. LTE test passed with srsRAN, UE attached successfully. Ping to internal gtp_br0 (192.168.128.1) and to Cloudfire (1.1.1.1) passed successfully.
  2. UERANSIM based 5G test passed with workaround #12846. Ping to internal gtp_br0 (192.168.128.1) and Cloudfire (1.1.1.1) passed successfully.

Hawkeye LTE test:

  1. Tested 1.8 AGW docker image on HK-6050 (NXP Arm LS1043A based device) with 5.4.47 kernel (Based on Ubuntu 20.04 LSDK image). UE Attach and traffic test using iperf is performed using srsRAN UE/eNodeb simulator.
  2. Tested 1.8 AGW docker image on HK-6010 with 5.4.47 kernel. Integration test passed with Sercomm SCE4255W small cell.

Ampere bring up in Carnegie Mellon University: Successfully brought up containerized 1.8 AGW on Arm64 Ampere server in Carnegie Mellon University Living Edge Lab. Successful means full deployment in a KVM VM on the server with successful check-in into 1.8 Orc8r in remote AWS instance.

5G SA Fixed Wireless Access (GA)

Building on top of the existing 1.7 release, 5G SA has been tested extensively on open source, commercial simulators as well as on real gnb and UE devices. A couple of new features have been added to provide enhanced security, quality of service (QoS), and other features in addition to recoverability in the event of restarts. Starting this release, 5G core also supports Ipv4/IPv6 dual stack of User Equipment or CPE devices. Key features included as part of the current release:

SUCI Extensions: Support registration of UE/CPE with concealed identity (Subscription Concealed Identifier).
IPv6 & Dual IPv4v6 support: Support for IPv6 and IPv4v6 sessions for the UE/CPE.
Stateless feature for 5G Core (recovery in the event of restarts).
5G QoS: Quality of Service configuration and support for PDU sessions.
Network initiated Session Modification: Dynamic configuration of QoS parameter for the PDU session.
QoS Flow Identifier (QFI) to flow mapping as part of GTP extension header processing.
These features are built on top of existing 5G SA features delivered as part of 1.7 (Mobile Management, Session management, etc.) .

CI Testing Results

Hardware-in-the-loop (HIL)
4G : Sanity, Availability, Performance,
5G-SA : Sanity, Availability, Performance, Features

Feature Testing
4G

Test-Report
Test-Logs
5G-SA

Test-Report
Test-Logs

Field Test

Known Issues

4G TeraVM based feature tests are not done as part of Release testing
3rd party deb packages and OVS packages are manually uploaded in magma artifactory. CI automation will happen post 1.8 release.
#13650 - two non sanity tests failing vs 1.8 .deb environment
AGW container environment is missing ryu patch - log-level from error to info for one statement
5G Tests : Session-Modification is not working as expected while triggering network session modification for reject scenarios #13502
5G Tests : Session-Modification issues with policy cleanup #13536
5G Tests : Traffic not resumed when services are restarted with few qos policies #13597
5G Tests : Multiple QoS Flow descriptors attached to Subscriberdb not working as expected #13604
5G Tests: MSIN in BCD format is not provided for encryption by spirent #13419
5G Tests: Handling of reject from Mobilityd when static-ip configuration is conflicting with IP-POOL Confighttps://github.com//issues/13258
5G Tests: SUCI Registration with Profile-B is failing while key length greater than 32 bytes #13708
5G Tests : Support for SUCI-Profile Encryption in case of Identity-Procedurehttps://github.com//issues/13038
5G Tests: 5G can't handle userLocationInformation NR timestamp field
#12846
Federation Gateway, Carrier Wifi Access Gateway and Domain proxy modules are not tested as part of the current 1.8
release.
While running the script "agw_install_docker.sh" mentioned in https://github.com/magma/magma/blob/v1.8/docs/readmes/lte/deploy_install_docker.md , netplan config might not take into effect on some of the systems. Manual netplan config will resolve the issue.
Mobilityd-Restart: mobility can not be cleanly restarted if there is no ipv6 interface defined #13826
Docker based testing for x86 has gone through basic sanity tests. Complete coverage is planned for the upcoming releases.

Access Gateway Upgrade Logs
1.7.0 > 1.8.0

ORC8R
Sanity Test Logs

What's Changed

  • fix: ansible is pinned because of ansible-core 2.13.4 breaking change (#13916) (#13919)
  • fix(orc8r): Updated helm chart version for 1.8.0 release (#13731) (#13882)
  • fix(agw): updated debian repo for 1.8.0 release (#13824)
  • chore: magma vm is based on focal-1.8.0 dist (#13806)
  • fix(agw): updated focal-ci to focal-1.8.0 (#13756)
  • fix(agw): updated debian repo for 1.8.0 release (#13798)
  • fix(agw): added missing the ansible tags for arm variable (#13797)
  • fix(agw): updated env file (#13770)
  • chore(dp): Remove apt packages version pinning in DP Dockerfiles (#13769) (#13776)
  • docs: Extended features in 5G SA documentation (#13624) (#13761)
  • fix(agw): updated env.j2 file (#13740)
  • fix(agw): updated docker install script for agw (#13726) (#13737)
  • fix(agw): Fixed cleanup for successful integ test (#13332) (#13722)
  • fix(agw): Enhanced debugging in CI for agw (#13423) (#13721)
  • fix: sentry_sdk is pinned to <1.9 (#13652) (#13720)
  • fix(pipelined): Updating pipelined production configuration (#13656) (#13676)
  • chore(dp): freeze skaffold version in dp integration tests (#13702) (#13719)
  • fix(sessiond) fix the session modification bug (#13716) (#13725)
  • fix(agw): Fixed file not found error in publishing integ test status (#13568) (#13634)
  • chore(agw): bump version of ovs that is required (#13629) (#13633)
  • fix(orc8r): Fix orc8r helm chart bugs (#13598) (#13635)
  • fix(agw): Fixed SCTP abort issue by setting finite timeout in sctp_sendmsg (#13146) (#13644)
  • feat(pipelined): Router Advertisement issue fix for 5G UE IPv6 (#13020) (#13632)
  • fix(ci): disabli...
Read more

Magma v1.7.0 (Mayon)

29 Mar 22:09
Compare
Choose a tag to compare

Introduction

The 1.7.0 release adds new features and fixes some of the known issues with previous releases. Please see the test report for more information. Note that new features follow these maturity definitions as it pertains to alpha, beta, or GA.

Key Features and Improvements

IPv6

The IPv6 pool allocation changes allow the assignment of a block of IPv6 prefixes for user devices. This feature also enables IPv6 static allocation to enable the assignment of an IPv6 prefix to an IMSI in subscriberDB. With this new implementation, Magma will support IPv4, IPv4v6, and IPv6 APN types. Documentation can be found here.

5G SA Fixed Wireless Access (Alpha)

One of the focus areas for the 1.7 release of Magma is to introduce the 5G SA core network components. From the grounds up it is designed with flexibility, reusability and keeping cloud native technologies in mind. This release puts up the foundation for 5G core network technologies which will be used in upcoming releases to provide end-to-end solutions for various deployments. Since this is an alpha feature, review the known issues section of the notes and test report prior to using this feature. Documentation is available for swagger implementation and headless install and support is available in the Wavelabs 5G Slack channel. Key features include:

  • Mobility Management Procedures (UE Registration, De-Registration, Authentication, Security Mode procedures with SUCI & GUTI registration)
  • Session Management Procedures (PDU Session Establishment, Release and related procedures)
  • Service Procedures via CPE (Service Request/Accept)
  • Idle Mode support & Paging
  • Traffic for UL/DL directions
  • Enabling/disabling 5G and AMF configurations via swagger API
  • SubscriberDB extension for a “forbidden list” to give operators flexibility on level of service for subscribers

5G NSA Fixed Wireless Access (Beta)

5G NSA bridges the connectivity gap between a 5G compatible UE and the magma core. This feature was previously released in v1.5 but enhancements and updates have been made to supplementary messages, layers and services. Further details are available here.

Docker Access Gateway (Alpha)

This feature enables containerized access gateways that are deployed via docker-compose files and orchestrated by Kubernetes. This feature can be deployed via Amazon Web Services. This is an alpha feature and can be prone to bugs. If you experience library dependency issues, backport this pull request or utilize the Slack channel. Documentation can be found here.

GTP Echo

GPRS Tunneling Protocol echo requests are used for path management purposes and error indication messages for exception handling. Error indication messages can be used to inform the other GTP entity that there is no EPS bearer from a received user-plane packet.

Inbound Roaming - Dedicated Bearer

Roaming support allows mobile users from one operator network to access services while visiting areas outside their network coverage. This can support multiple scenarios. Magma Partner Network uses Magma services for MME, HSS(Subscriberdb), SGW, PGW, and provides local breakout of data traffic. Roaming Partner Network uses all non-Magma services, and provides “federation” for S6a and S8 interface to support RPN users roaming to MPN network. Feature documentation can be found here.

Domain Proxy

The Domain Proxy feature is an application whose purpose is to communicate to eNodeBs with SAS, send requests to SAS, on their behalf, and maintain their desired state. Documentation can be found here.

S8 Unique TEID

Previously, each AGW on inbound roaming had its own GTP-U interface which means that on networks with multiple AGWs, the remote PGW will have to be configured each time a new AGW is added. To solve this, a GTP aggregator has been implemented that can be seen as a single SGW-U from the remote PGW. Documentation is available here.

Tracking Area Update (TAU)

This feature enhances the AGW to be able to support tracking area procedures when a UE enters a new tracking area. Prior to this, magma only supported periodic tracking area updates where the MME rejects the TAU request received with EPS update type “TA updating”.

CI Testing Results

Hardware-in-the-loop (HIL)

TeraVM Feature Testing

Sentry Dashboard

Known Issues

  • Wavelabs 5G CI: For test cases 7 and 9 there is a negative case where GUTI is corrupted resulting in a new registration to be sent (#10056). There is a proposed fix for TC9 with PR#11995 to add implicit deregistration support.
  • Wavelabs 5G CI: When multiple sessions are created simultaneously it can take subscriberDB a few seconds to share the DNN and AMBR information. Due to DNN mismatch this can cause the PDU session to fail. Issue and proposed changes captured on Issue #11523 for TeraVM and Issue #11429 for Spirent.
  • Wavelabs 5G CI: TeraVM periodic registration idle mode failure (#11236)
    Known bug with tracking area accept being sent on some TeraVM runs (#12114). This issue is resolved with pull requests #11995 and #12275.
  • MME memory leak issues (link). These fixes will be backported for 1.7.1.
  • FeG diameter client bug which can block response handle indefinitely. Already fixed on master. (link)
  • Docker AGW installations for 1.7 can experience library dependency issues. These are fully fixed in master and will be in 1.7.1. (#12278)
  • Error creating new organization in NMS (#12346)

Fresh Installation Logs

Access Gateway Upgrade Logs

Orc8r Upgrade

Previous upgrade instructions published for v1.6.0 are still valid and relevant for the upgrade from v1.6.1 to v1.7.0
Upgrade Logs

Image Versions

  • Version - 1.7.0-1648152173-73e61141b

Magma v1.6.1 (Glacier Peak)

17 Nov 23:46
346e86d
Compare
Choose a tag to compare

Introduction

The 1.6.1 release of Magma is focused on improving the product stability and addressing known issues/bugs. Please note this version was previously only a Release Candidate, but it has now been more extensively tested. For more details on the project’s improved level of release testing, please refer to the test report and TeraVM logs.

Key Features and Improvements

S1 Mobility

Fixes are backported. On v1.6.0, feature tests were failing to send handover notification messages over the real RAN environment.

MME Service Improvements

  • Fixed bug in servicing sessiond triggered session terminations.
  • Reduced the load on sessiond and pipelined by suppressing TEID updates during idle-active transitions to reduce the risks of sessiond triggered session terminations and detaches.
  • Fixed race condition in congested scenarios where dependent library recycles timer ids on one thread while expired timer is not yet processed on another thread.
  • During error events caught by handlers for ZMQ timers, (-1) return value was leading to individual thread exits without stopping the service itself. This issue is fixed by logging the exceptions and returning okay.
  • As a failsafe mechanism, individual thread exits from ZMQ event loops are caught and asserted to force MME service itself to restart. Due to the fix above, this failsafe mechanism isn’t expected to be called.
  • T3485 timer handler for default bearer activation was not resetting the timer ID, leading to unfulfilled retransmissions after the first retransmission.
  • S1AP UE states were not committed to Redis during IDLE/ACTIVE transitions that are fixed on v1.6.1.
  • Fixed issues for attach requests with unknown GUTI.
  • Fixed issues with the optimization of mme state synchronization that were only done for registered users before.
  • Memory leak fixes during NAS and session procedures.
  • Removed unchecked and hence unsafe pointer access.
  • Stop service303 timer in the right thread during service exits and restarts.

Data Path and Stability Improvements

  • Return error status from pipelined as GRPC response when local event for flow activations time out.
  • Service restarts would lead to loss of SGi connectivity in bridged mode AGW. Now flows are restored properly on SGI bridge on service restarts.
  • Enabled GTP-U checksum.
  • IPFIX sampling port is fixed.
  • Fixed vlan matching, where absence of wildcard in vlan match rule was leading to match failures.
  • Avoided the need of service restart when the uplink bridge is reconfigured due to port addition.
  • Enabled GTP-U echo by default and make it configurable.
  • Enabled GTP-U echo response.
  • Removed auto interface bring-ups to eliminate recursions in ifup script.
  • Eliminated continuous deletion of default drop rule to improve performance.
  • Fixed issues on bringing up SGi interface upon AGW reboots when interface file is missing.

FEG Improvements

  • To support some specific vendors, Service Requested Unit AVP needs to be set empty. A configuration option in the environment file is added to support this.
  • The default config value for the credit request unit is changed from 200Kbyte to 10Mbyte to prevent spamming.
  • Removed origin-state-id from S6a messages as per spec.

Other Improvements

  • Sessiond race condition fixes that would lead to failed service requests and stale states in sessiond.
  • Monitord failures due to “too many opened files” are fixed. The issue was caused due to holding onto inactive subscriber IPs and calling a large number of subprocess calls.
  • Subscriberdb had a bug introduced during the optimizations done for v1.6.0 that would lead to failed subscriber synchronization if services restart at the exact time of data sync from the cloud. The issue is fixed by changing the ordering of processing subscriber data and digest data.
  • Default log levels for directoryd and state services are changed from DEBUG to INFO level.
  • Service health watchdog improvements to catch all situations where a particular service is down.
  • AGW bootstrapping service stability improvements due to revoked certs.
  • Alert rule and threshold changes for S1 setup failure and cert expiry.
    NOTE: Alerts have to be re-synced to properly work with the certificate expiry time. The previous logic was incorrect and the alert was triggered when the certificate expiry date was greater than 720 hours (the fix is to invert the logic).
  • Updated OVS dependency.

Known Issues

  • HIGH BW traffic test fails to match expected data rate (9591)
  • QoS Flow 200UE Test Fail (9587)
  • In scale tests involving active/idle transitions, in a few instances, service rejects and timeouts ranged from 1-2% of total service requests. The raw count of total service requests was greater than 12,000 requests in a 120 minute test. period. (9690)
  • Header Enrichment enablement issue on non-NAT setups (10338)
  • Connectiond service restarts frequently (10081)
  • Orcr8r to AGW relay function can be severed for up to 30 seconds at a time due to a known bug which may elevate failures for procedures requiring a federation gateway. This however, does not impact any configuration management of the gateways.

Bare Metal Install

For new gateway installations on a Ubuntu 20.04 Server, please use the following install script:

  • wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/deploy/agw_install_ubuntu.sh

Bare Metal Install Log

Upgrade Notes

To upgrade an existing AGW, please run the following upgrade script:

  • wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/release/upgrade_magma.sh

Upgrade Logs

Image Versions

  • Ubuntu - 1.6.1-1636529012-5d886707

Orc8r

  • Previous upgrade instructions published for v1.6.0 are still valid and relevant for the upgrade from v1.5 to v1.6.1. Note: Terraform v0.15.0 was used to do the upgrade.
  • Orc8r 1.5.0 → 1.6.1upgrade logs (using terraform commands)
  • Orc8r 1.6.1 Fresh Install logs (using cloudstrapper)

Critical bug fixes

  • fix(sessiond): fix race condition on handle_activate_ue_flows_callback (#10213)
  • fix(mme): Backport PR 10186 (#10202)
  • fix(pipelined): Add grpc error code for timeouts (#10155)
  • feat(session_proxy): add a flag to disable Service Requested Unit AVP (#8697)
  • fix(mme): Using pair of mme_ue_id and timer_id and storing on set for (#9646)
  • fix(agw): enable checksum for GTPU (#9359)
  • feat(mme): Adding mme_app_imsi_timer_map and MME ue id validation che… (#9593)
  • fix(mme): Fixing guti unknown attach and adding s1ap test case (#9339)
  • fix(mme): Replace RETURNerror with RETURNok in timer handlers (#9416)
  • fix(mme): Fix for handling unknown GUTI attach (#9304)
  • fix(agw): Fixing monitord too many opened files error (#8810)
  • fix(mme): Fix NAS common procedure check segfaults (#8808)
  • perf(pipelined): backport-v1.6: Avoid service restart on bridge recon… (#7851) (#8428)
  • fix(agw): enable GTP echo (#8328) (#8649)
  • fix(mme): add config flag to control GTP-U echo (#7980)
  • feat(agw): enable GTP-U echo response. (#7885)
  • fix(mme): Updating S1AP UE state IMSI write on connection_establishment... (#9334)
  • fix(mme)(s1_handover) Send UE ctx release cmd to the source eNB after (#8046) (#8462)
  • fix(mme)(s1_handover) fix bugs in security context for HandoverReques… (#7985) (#8461)
  • fix(mme): Mitigate timer expiration handler with invalid UE context c… (#8648)
  • fix(agw): on AGW reboot bring up SGi interface. (#8169)
  • fix(m...
Read more

Magma v1.5.3 (Fuji)

10 Sep 22:56
Compare
Choose a tag to compare

Introduction

This minor release for the Magma v1.5 release contains fixes for some known issues reported for the v1.5 release. See the release page and test report for more information.

Fresh Installation

For fresh gateway installs, please use the following install scripts. Note that the install scripts vary by the OS used for the gateway.

Ubuntu Install Script

wget https://raw.githubusercontent.com/facebookincubator/magma/v1.5/lte/gateway/deploy/agw_install_ubuntu.sh
# Install Magma 
chmod +x agw_install_ubuntu.sh
bash ./agw_install_ubuntu.sh

Debian Install Script

wget https://raw.githubusercontent.com/facebookincubator/magma/v1.5/lte/gateway/deploy/agw_install.sh
# Install Magma 
chmod +x agw_install.sh
bash ./agw_install.sh

Image Version

  • Ubuntu > 1.5.3-1631131046-89c90f6d
  • Debian > 1.5.3-1631058504-93f5d781

Upgrade Notes

Access Gateway

Repo Change - In Magma Fuji (v1.5), Magma artifacts are now hosted on the new Magma core repositories. Gateways migrating from older Magma releases should update the repo in magma list.

Ubuntu
Add the following to /etc/apt/sources.list.d/magma.list

deb https://artifactory.magmacore.org/artifactory/debian focal-1.5.3 main
# Upgrade Magma
apt update 
apt upgrade magma

Debian
Add the following to /etc/apt/sources.list.d/magma.list

deb https://artifactory.magmacore.org/artifactory/debian stretch-1.5.3 main
# Upgrade Magma
apt update
apt upgrade magma -o Dpkg::Options::="--force-overwrite"

Critical bug fixes

  • Fix match for uplink egress flows which could result in mismatched VLAN flows (#7752)
  • Fix for mme crash observed after the execution of test_3495_timer_for_default_bearer_with_mme_restart.py TC and also the root cause of the issue (#6977, #7941)
  • Fix GUTI stale entries, showing up in scaling tests where the systems ends up in duplicate attach requests and ignoring legitimate users (#7721, #7926)
  • Fix to handle attach with unknown GUTI (#8007)
  • Fixed automatic bring up of SGi interface on AGW reboot (#8169)
  • Fix memory leak in TAU procedure (#8279)
  • Move MME and eNB stats handling to service303 thread (#8307)
  • Added asserts on single thread exits (#8455, #8480)
  • Removed auto interface bring-up to prevent recursion errors (#8477)
  • Fixed memory leaks observed during network initiated dedicated bearer deactivation procedure (#8417)
  • Added fix to close latest OF connection on OpenFlowController (#8519)
  • Free bstring field for ICS response (#8517)
  • Removed origin-state-id avp. Per 3GPP TS 129 272 V15.4.0 origin-state-id avp should not be included in any of the s6a messages (#8582)
  • Free esmmessagecontainer on attach reject proc (#8594, #8635)
  • Mitigate timer expiration handler with invalid UE context causes MME app thread exit (#8648)
  • Fixed aiohttpd debian dependency (#8734)
  • Increased value of default_requested_units on sessiond from 200kb to 10mb. (#8671)
  • To support some specific vendors we need to set Service Requested Unit AVP as empty. Added a flag to session_proxy service to disable that AVP (#8697)
  • Fixed NAS common procedure check segfaults (#8808, #8811)
  • Fixed monitord too many opened files error (#8810, #8812)

Magma v1.6.0 (Glacier Peak)

06 Jul 22:12
Compare
Choose a tag to compare

Introduction

The 1.6 (Glacier Peak) Magma release includes lots of great performance and reliability improvements, adds support for some new features, enhances existing ones and adds fixes for other known issues. This release officially deprecates support for Debian and establishes Ubuntu as the only supported OS for deploying Magma. See the release page and test report for more functionality and scale information.

Key Features

Inbound roaming enhancements

Inbound roaming was first launched in v1.5 to provide network mobility support by allowing mobile users from one operator network to access services while visiting areas outside their network coverage. Paging support as well as other relevant fixes have now been added to enhance the feature. See the related issues for details about other related work.

Service Area (TAC) Restriction

In addition to PLMN and IMEI network restriction features, Magma now supports Service Area (TAC) Restriction in beta for federated deployments. In a given PLMN, this feature allows network operators to create different service areas for which a UE is allowed or not allowed to attach to the network by configuring subscriber data on HSS with the allowed zone codes and by assigning a list of tracking area codes to each zone code using Orc8r APIs or the NMS for EPC configuration. See the related issues for details about other related work.

Congestion Control for UE attach/detach

MME introduced congestion control that rejects attach requests with cause congestion or implicitly drops initial UE messages based on the latencies observed in message processing in S1AP and NAS layers. This feature is added to maintain the stability of MME when the message processing speed falls behind the incoming request rate from RAN side. The feature can be disabled per AGW instance or at the network level using Orc8r or NMS. The congestion thresholds can be changes by modifying the associated configurations in the mme.yml file

Router mode dataplane

In Non-NAT mode, AGW is pre-configured in router mode where the AGW acts as the L3 next hop for the UE allocated subnet. Refer to the Magma AGW Non-NAT mode section of the online documentation for details.

GTP-U Segmentation offload

AGW can make use of the UDP Tunnel Segmentation Offload feature available in modern NICs for GTP-U tunnel traffic. This improves dataplane throughput.

Orc8r

Core

  • New bulk upload API has been added to provide an endpoint for the bulk provisioning of subscribers
  • Added support for subscriber digests for more efficient subscriber syncs to the access gateway
  • Added new metrics around certificate expiry and corresponding alerts on the NMS

Deployment

  • Amazon Relational Database Service (Amazon RDS, part of AWS) DB backups are now configured to be taken automatically to facilitate data recovery in cases of severe outages
  • Backup retentions for RDS are now configurable (AWS environments)
  • Configurable but optional notifications via email on various RDS events are now supported (AWS environments)
  • Orc8r deployment and cleanup from Community or Custom builds have now been greatly simplified
  • Elasticsearch curator changes to purge magma log indices based on space thresholds
  • Upgraded prometheus version from v2.20.1 to v2.27.1
  • Terraform version 0.15.0 is now supported

NMS

  • The Alerts UI has been updated to enhance the user experience
  • New Gateway YML editor has been added to enable a more convenient path to modify gateway service configurations, all within NMS

Access Gateway in the Cloud

  • Pre-built AGW AMIs from AWS Marketplace are now available for in-region, edge and on-premises AWS compute device deployments. Get started on AWS marketplace

Lawful Intercept (LI)

  • This feature aims at providing a standard Lawful Interception solution in beta as specified in ETSI TS 103 221-1 for X1 and ETSI TS 103 221-2 for X2 and X3

Known Issues

  • GTP-U Echo Request/Response for Inbound Roaming are not currently supported (GTP-U Echo Requests are supposed to be responded to by the AGW). If remote PGWs are configured with an inactivity timer, devices idle for longer than the S8 inactivity timer may not have a corresponding S8 bearer upon transitioning to the active state. This feature will be supported in subsequent releases. NOTE: Echo Requests/Responses are supported on GTP-C since v1.4

  • Subscriber database might not sync with the fresh install. Verify if there are any sync issues journalctl -fu magma@subscriberdb and restart Magma services by issuing following commands:

    • service magma@* stop
    • service magma@magmad restart
  • Control_proxy service errors if using both /var/opt/ and /etc/magma.
    control_proxy[6877]: 2021-07-06T23:16:24.590Z [127.0.0.1 -> streamer-controller.magma.etagecom.io,8443] "POST /magma.orc8r.Streamer/GetUpdates HTTP/2" 502 158bytes 0.051s

    • Restart the Magma services to override contents with /var/opt location
      • service magma@* stop
      • service magma@magmad restart

Fresh Install Notes

Note: Debian is no longer supported for new installations of v1.6 and beyond
For new gateway installations on Ubuntu 20.04 Server, please use the following install scripts.

Ubuntu

wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/deploy/agw_install_ubuntu.sh
chmod +x agw_install_ubuntu.sh
./agw_install_ubuntu.sh

Upgrade Notes

Cloud Upgrade

  • Cloud upgrade is supported from v1.5.2
  • Please note that the orc8r main.tf file should reference orc8r helm chart version - 1.5.23
  • New alerts (e.g. Cert expiry) have been added in this release. Similar to prior releases, it is necessary to click on the “Sync Pre-Defined alerts” in the NMS window for every network defined in the orc8r. Syncing the alerts once on the NMS does not replicate the behavior to other networks managed by the same NMS.

Access Gateway

  • Repo Change - Beginning with Magma Fuji (v1.5), Magma artifacts are now hosted on the new Magma Core repositories. Gateways migrating from older Magma releases should run the migration script to update the sources accordingly. This repository currently supports both Debian and Ubuntu OS flavors. Please note that v1.5.x aka Fuji is the last release with Debian support.

Note: Note: Debian is no longer supported for upgrades to v1.6 and beyond
To upgrade an existing AGW, please run the following upgrade script.

wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/release/upgrade_magma.sh
chmod +x upgrade_magma.sh
./upgrade_magma_sh

Image Version

  • Ubuntu > 1.6.0-1625592603-1f26ba81

Critical bug fixes

  • Fixed the certifier service to register the prometheus gauge (#7893)
  • Fixed ITTI message construction with correct APN size (#7901)
  • Removed Fatal from emergency attach handling (#7903)
  • Added ability to add Service Identifier mapping together to Rating Group. This is in order to include AVP code 439 Service-Identifier inside AVP MSCC in CCR-I send to OCS (#7498)
  • TCP diameter Gx/Gy links failure (#7496)
  • Fixed match for uplink egress flows in pipelineD (#7752)
  • Changed is_standalone to address multiple concurrent sessions (#7794)
  • Bug fix for Service Area Restriction during TAU procedure (#7799)
  • SubscriberDB service misc fixes related to APN resource handling (#7846)

Other fixes

  • Moved stats collection for eNodeB into S1AP thread (#7758)
  • Updated AGW to support the flat digest pattern, including storing and communicating digests (#7340)
  • Replaced “with default” getter with new MustGetEnv function in set SQL driver and DB source in orc8r/cloud/go/storage/storage.go (#7484)
  • Migrated stats collection to the mme_app thread (#7710)
  • Added 4GB of swap be default to magma VM (#7790)
  • Add minor Orc8r deployment changes. (#7717 and #7849)

Magma v1.5.2 (Fuji)

25 Jun 03:11
a74d309
Compare
Choose a tag to compare

Introduction

The Magma 1.5.2 (Fuji) minor release contains fixes for some known issues reported for the v1.5 and v1.5.1 release. See the release page and test report for more information

Known Issues

  • IPFIX records have been validated to work on v1.5.2 however, all flows might not be captured successfully at the collector. This is a known issue and will be addressed in later releases.
  • GTP-U Echo Request/Response for Inbound Roaming are not currently supported (GTP-U Echo Requests are supposed to be responded to by the AGW). If remote PGWs are configured with an inactivity timer, devices idle for longer than the S8 inactivity timer may not have a corresponding S8 bearer upon transitioning to the active state. This feature will be supported in subsequent releases. NOTE: Echo Requests/Responses are supported on GTP-C since v1.4.
  • Please refer to the v1.5 and v1.5.1 release notes for additional details

Fresh Installation

For fresh gateway installs, please use the following install scripts. Note that the install scripts vary by the preferred OS based on which the gateway is deployed.

  • Ubuntu
wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/deploy/agw_install_ubuntu.sh
chmod +x agw_install_ubuntu.sh
./agw_install_ubuntu.sh
  • Debian
wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/deploy/agw_install.sh
chmod +x agw_install.sh
./agw_install.sh

Upgrade Notes

Cloud Upgrade

  • Cloud upgrade is supported from v1.3 as well as v1.4
  • Terraform version 0.14.5 is recommended for orc8r upgrades. Current terraform scripts are not compatible with terraform 0.15.0.
  • Due to the database unification for NMS and orc8r, orc8r upgrades have two pre-requisite tasks:
    • DB Migration - Please refer to instructions on GitHub for the migration. Note that the migration MUST happen prior to executing the terraform upgrade.
    • Terraform main.tf sanitization - references to NMS DB need to be removed from the main.tf file. Further, the dialect for the orc8r DB needs to be specified. Please refer to the example main.tf located here.
  • Please note that the orc8r main.tf file should reference orc8r helm chart version - 1.5.21
  • In v1.5, a new pre-defined alert has been added to raise a critical alert when excessive duplicate attach requests are received at the gateway or if the SCTPD service restarts multiple times (this was introduced in v1.4). In order to start receiving these alarms, it is necessary to click on the “Sync Pre-Defined alerts” in the NMS window for every network defined in the orc8r. Syncing the alerts once on the NMS does not replicate the behavior to other networks managed by the same NMS.

Access Gateway

  • Repo Change - In Magma Fuji (v1.5), Magma artifacts are now hosted on the new Magmacore repositories. Gateways migrating from older Magma releases should run the migration script to update the sources accordingly. This repository currently supports both Debian and Ubuntu OS flavors (please note that Fuji is the last release for Debian).

To upgrade an existing AGW, please run the following upgrade script.

wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/release/upgrade_magma.sh
chmod +x upgrade_magma.sh
./upgrade_magma_sh

Note for 1.3.3 to 1.5.2 please select ‘Yes’ to install Wireshark; this is essential for the call tracing feature.

Magma

Image Version

  • Debian > 1.5.2-1624383772-562baa62
  • Ubuntu > 1.5.2-1624485681-ae972900

Critical bug fixes

  • Added fix to restart pipelineD service after uplink br reconfig (#7695 )
  • Fixed #7496, instabilities in Diameter links Gx/Gy configured TCP port to a DRA (#7637)
  • Fixed datapath bring up patch-up port inconsistencies on startup (#7659)
  • Gracefully handle missing IPv4 address on S8 interface (#7656)
  • Fixed NMS users & organizations not being created (#7651)
  • Backported #7545 and #7616 to provide support to service identifier on FeG (#7612)
  • Patched RYU Python 3.8 only for ubuntu (#7615)
  • Removed rule map entry in rule Deactivate call in the Pipelined service (#7539)
  • Backported a s8_proxy for the issue described in #7549 where Update Location Information on create session request at s8 was sending wrong MCC (in fact it was sending MNC two times) (#7571)
  • Added a fix to the PipelineD service to use the correct IP address value to get hash entry (#7526)
  • Fixed this issue #7343, by appending a suffix to the APN sent by the UE during the Create Session Request on inbound roaming case. (#7378)
  • Limit checking all ConntrackD events to only those which match the zone set by OVS (#7357)

Other fixes

  • Minor fix to NMS placeholder URL for HE (#7705)
  • Added fix to make organization query in the NMS case insensitive (#7677)
  • Added sending PLMN of MME within serving network in Create Session Request (#7597)
  • Updated AGW upgrade script with ‘force’ parameters (#7505)

v1.5.1 (Fuji)

04 Jun 22:50
Compare
Choose a tag to compare

Magma v1.5.1 Release Notes (Fuji)

Introduction

The Magma 1.5.1 (Fuji) minor release contains fixes for some known issues reported for the v1.5 release. See the release page and test report for more information.

Known Issues

Please refer to the v1.5 release notes

Upgrade Notes

Cloud Upgrade

  • Cloud upgrade is supported from v1.3 as well as v1.4
  • Terraform version 0.14.5 is recommended for orc8r upgrades. Current terraform scripts are not compatible with terraform 0.15.0.
  • Due to the database unification for NMS and orc8r, orc8r upgrades have two pre-requisite tasks:
    • DB Migration - Please refer to instructions on GitHub for the migration. Note that the migration MUST happen prior to executing the terraform upgrade.
    • Terraform main.tf sanitization - references to NMS DB need to be removed from the main.tf file. Further, the dialect for the orc8r DB needs to be specified. Please refer to the example main.tf located here.
  • Please note that the orc8r main.tf file should reference orc8r helm chart version - 1.5.21
  • Starting with v1.5, a new pre-defined alert has been added to raise a critical alert when excessive duplicate attach requests are received at the gateway or if the SCTPD service restarts multiple times (this was introduced in v1.4). In order to start receiving these alarms, it is necessary to click on the “Sync Pre-Defined alerts” in the NMS window for every network defined in the orc8r. Syncing the alerts once on the NMS does not replicate the behavior to other networks managed by the same NMS.

Magma

Access Gateway

  • Repo Change - Starting with Magma Fuji (v1.5), Magma artifacts are now hosted on the new Magmacore repositories. Gateways migrating from older Magma releases can run the migration script to update the sources accordingly. This repository currently supports both Debian and Ubuntu OS flavors (please note that Fuji is the last release for Debian).
wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/release/upgrade_magma.sh
chmod +x upgrade_magma.sh
./upgrade_magma_sh

Image Versions

  • Debian > 1.5.1-1622832859-484890af
  • Ubuntu > 1.5.1-1622775037-60e10f79

Critical bug fixes

  • Changed API limit of mme_group_id from 255 (8bits) to 65535 (16bits) (#7053)
  • Fixed IPtable rule config to config accumulation of IPtable rules on every service restart (#7151)
  • Added a change to ensure that a credit has >0 quota before un-suspending (#7037)
  • Fixing netmask parsing for Ipv6 address (#6920 (#6920)), a regression introduced by (#6712)
  • Added fix to allow AGW installation on server with SGi which has statically allocated IP address (#6832)
  • Added fix to accept eNB-init Reset even without UEs associated (#6808)
  • Added support for adding SGi as a router along with bridged mode for UE traffic (#6695)
  • Fixed bug in handling of non-consecutive TACs in TAI list, where the partial lists were not encoded correctly (#6697)
  • Fixing stale entries on S1AP IMSI directory which was affecting MME performance (#6800)

Other fixes

  • Fixed an AGW python Eventlet dependency (#6772)
  • Cleanup of the AGW deployment to auto-download the post-install script (#6611)
  • AGW: datapath: add dp_probe_cli to the magma package (#7247)
  • Fix logrotate config (#7159)

v1.5 (Fuji)

29 Apr 00:19
Compare
Choose a tag to compare

Magma v1.5 Release Notes (Fuji)

Introduction

The Magma 1.5 (Fuji) release adds support for some new features and fixes for other known issues. See the release page and test report for more information.

Key Features

Inbound roaming

Roaming support allows mobile users from one operator network to access services while visiting areas outside their network coverage. The implementation considers the use case when a subscriber of a network operator MNOH (home network) tries to access LTE services while visiting an area covered by operator MNOV (visiting network) that deploys Magma EPC.

Inbound roaming extends the S6a interface and adds support for the S8 interface. Inbound Roaming requires a federated architecture to connect to MNOV, while MNOH can be Federated using HSS, or in a non-Federated using Magma HSS which is then selected dynamically by PLMN Identifier (ID)

Idle Mode Paging Support: Magma 1.5 supports IDLE to CONNECTED UE originated mode. The current implementation does NOT support IDLE to CONNECTED network originated mode (network paging)

Ubuntu 20.04 support

Starting with this release, the default kernel for the AGW will be based on Ubuntu 20.04. Debian is still supported in this release but will be deprecated starting in release v1.6. This also updates Python to 3.8 and OVS to 2.14.

Intra-AGW S1 Mobility

This feature enables support for UE mobility across multiple eNBs over S1 connections and anchored at the same AGW instance. UEs should maintain the same IP address and should experience minimal network layer (i.e., IP layer for applications on the UE) packet loss. Note that Magma does not currently support indirect data forwarding, so some packet loss may be experienced during handover (this will be added in a future release).

PLMN restriction enhancements

This feature adds the ability to restrict UEs from unauthorized PLMNs. You can configure blocked PLMNs in the AGW via a config file so during the attach process, you can grep the PLMN from UE IMSI and perform an Attach reject by including PLMN of AGW into the restricted PLMN list.

IMEI restriction

Before this release, Magma did not check whether the hardware itself (as identified by its IMEI) is a legitimate/approved device type to access the network. IMEI restriction will allow such checks via configuration and will block access for the device via it’s IMEI if it is not allowed in the network.

Orc8r subscriber scaling

20K+ subscribers can now be provisioned at a time. Scaling limitations from previous releases have been addressed.

Reduced operating expenses via DB unification

This release unifies the DB for both Orc8r and NMS. The NMS DB was migrated from MariaDB to Postgres to standardize storage engines across both systems. For network operators using Magma on AWS, there are operating costs to running both MariaDB and Postgres, over using just one or the other. The unification is to have both NMS and orc8r use the same DB to reduce operating expenses of running Magma services.

NMS improvements

  • Gateway pool configuration for FWA high availability
  • Subscriber overview now displays configured subscribers and associated subscriber sessions in separate tables
  • Configured subscribers can be exported in a csv format.
  • Audit log table is available by default in admin page. Audit log table can be used to track any mutating changes done to the underlying configuration.

Known Issues

  • Attach Procedure Failure due to duplicate enb_ue_s1ap_ids. During scale testing, we observed on multiple gateways that after 5+ hrs we see attach procedure timeout on the UEs (#6414). It’s recommended to add a custom alert rule based on the duplicate_attach_request metric. Refer to the rules and metrics guides for configuration details.
  • S1 Handover testing with physical handsets is ongoing. During testing, we were unable to complete an S1 handover using a real UE and eNBs (#6429). We are continuing to test to determine if this behavior is UE or eNB dependent.

Upgrade Notes

Cloud Upgrade

  • Cloud upgrade is supported from v1.3 as well as v1.4
  • Terraform version 0.14.5 is recommended for orc8r upgrades. Current terraform scripts are not compatible with terraform 0.15.0.
  • Due to the database unification for NMS and orc8r, orc8r upgrades have two pre-requisite tasks:
    • DB Migration - Please refer to instructions on GitHub for the migration. Note that the migration MUST happen prior to executing the terraform upgrade.
    • Terraform main.tf sanitization - references to NMS DB need to be removed from the main.tf file. Further, the dialect for the orc8r DB needs to be specified. Please refer to the example main.tf located here.
  • Please note that the orc8r main.tf file should reference orc8r helm chart version - 1.5.21
  • In v1.5, a new pre-defined alert has been added to raise a critical alert when excessive duplicate attach requests are received at the gateway or if the SCTPD service restarts multiple times (this was introduced in v1.4). In order to start receiving these alarms, it is necessary to click on the “Sync Pre-Defined alerts” in the NMS window for every network defined in the orc8r. Syncing the alerts once on the NMS does not replicate the behavior to other networks managed by the same NMS.

Magma

Access Gateway

  • Repo Change - In Magma Fuji (v1.5), Magma artifacts are now hosted on the new Magmacore repositories. Gateways migrating from older Magma releases can run the migration script to update the sources accordingly. This repository currently supports both Debian and Ubuntu OS flavors (please note that Fuji is the last release for Debian).
wget https://raw.githubusercontent.com/magma/magma/master/lte/gateway/release/upgrade_magma.sh
chmod +x upgrade_magma.sh
./upgrade_magma_sh
  • Image Version - 1.5.0-1619628161-f023455f

Critical bug fixes

  • QoS: Fix max bandwidth calculation. Pyroute2 API expects max-bandwidth parameter in bytes rather than bit rate (#6335)
  • Added fix to flush Pipelined Redis State on Stateless Restart (#6363)
  • Applied the use of meaningful names for MME threads (#5819)
  • Fixed datapath header calculations in OVS-2.14 (#6140)
  • Fixed the regression on the handling of GUTI attach type introduced by (#4769) for the creation and allocation of the emm_ctxt struct (#6114)
  • Fixed the bug in handling of a late ULA message received after ULA timer expiration (#5905)
  • Fixed type casting bug in S1AP state conversion (#6193)
  • Fixed faulty cause type parsing in context modification failure (#5921)

AGW

  • Added hash signature in persisting MME states to Redis to prevent unnecessary writes (#5868).
  • Eliminate some of the unnecessary state sync to Redis in S1AP task (#5888).
  • Added support for error indication handling for unknown UE context at RAN (#5956).

NMS

  • Fixed a read only user bug in the NMS (#5477). In this release, an error is thrown whenever read only user attempts to make a post/put/delete call in orc8r.

Other

  • Starting with this release, AGW with less than 4GB of memory is no longer officially supported.

v1.4 (Etna)

16 Mar 21:09
1c13182
Compare
Choose a tag to compare

Etna Release Notes

Introduction

The 1.4.0 (Etna) Magma release contains support for some new features and fixes for other known issues. See the release page and test report for more information.

Key Features and Highlights

Stateless AGW

Magma v1.4.0 enables stateless mode for AGW by default. This mode increases the stability against crashes in core Magma services on AGW except for sctpd. The mode also enables hitless software or configuration updates for the same core services.

FWA HA

Magma AGWs can now be paired together in an HA pool via new Orc8r APIs. The AGW with the higher relative capacity is designated as the primary and the other AGW designated as the secondary by the Orc8r. The recommended configuration for relative capacity for the primary AGW is 255 (maximum allowed value) and for the secondary AGW is 1. The HA feature requires that the eNBs have MME pooling support (a.k.a. S1-Flex) and operator configures the same pair of AGWs in the MME pool set up via the vendor provided management tools. With the recommended configurations, the secondary AGW in the pool is primarily utilized when the primary AGW is not reachable anymore by the eNB. When there are UEs camped on the secondary AGW, they are eventually offloaded to the primary AGW once the primary AGW is denoted as healthy by the Orc8r. If the secondary AGW and the eNB do not have routable S1-U ip addresses, the HA feature is supported only for one eNB per site. If the secondary AGW and the eNB are in the same private network, then HA feature can be utilized for multiple eNBs in the same site.

Header Enrichment

This feature allows operators to enable header enrichment for UE HTTP traffic. The AGW service adds subscriber
information to HTTP requests to contextualize HTTP requests from the server. There could be privacy implications for this feature, so operators are encouraged to check local laws before using it.

NMS Improvements

  • Subscriber state view in LTE and Federated LTE networks
    • Enhanced subscriber table to display subscribers setup through federation apart from the configured subscribers. The subscriber table comes with a drop down which displays detailed session information for the subscriber. Additionally the “View JSON” option for the subscriber displays the subscriber JSON state in entirety.
    • Subscriber table additionally also displays IP Address and Active APNs
  • Call tracing feature
    • Added support for basic traffic capture for troubleshooting purposes. Monitoring of control messaging flow and other traffic between the Magma access gateway and eNodeB devices is possible with this feature.
  • There is a new UI for adding and modifying APN information
  • There is also a new UI for adding and modifying policies, rating groups and QoS profiles.
  • Metrics Explorer
    • A new metric explorer has been added to enable users to view all the metrics exposed by Magma. It additionally comes with a drop down which opens the metric in grafana and enables the user to make queries based on that metric.
  • Logs and events aggregation is enabled on the gateways by default.
  • Event table enhancements
    • EventTable is modified to display events across all event streams, earlier it was only restricted to magmad and sessiond streams.
    • User can filter event table based on event streams(mme/sessiond/magmad etc), event types or tags
  • Gateway Log Table enhancements
    • Users can now filter logs based on service and tags
  • Alarm Table enhancements
    • Added the ability to synchronize predefined alerts from the Alarm component
    • Cleaned up the dashboard alert table to display the alerts with their severities in their respective tabs and pulled out the labels from alerts and displayed them in a separate column on the table.

FeG

  • Additional ability to filter by charging characteristics to apply virtual APNs (#4164)

Debugging Tools

  • The show-tech tool enables operators to capture the essential state of the gateway (currently only supported on AGW), packages it and dumps it in a pre-configured destination directory. The collected data can then be shared with support teams to help identify and resolve issues quickly. Check out the associated docs

Known Issues

  • Access Gateway sctpd process may show the following error message under moderate load. In most instances, this is auto-remediated through an sctpd service restart while raising an unexpected service restart alert in the NMS. However, in rare situations, repeated service restarts may not recover the sctpd service and the only remediation is a manual access gateway reboot; a critical alert will be raised in the NMS for repeated restarts under 5 minutes for all impacted services.
 util.cpp:58] sctp_bindx ADD error error (98): Address already in use
  • When gateways or eNodeBs are added and when the top level gateway or eNodeB page doesn’t auto-refresh, it is possible for user to see stale values they click to view gateway or eNodeB detail page. User might have to refresh to see the latest values here. (#4985)
  • Stateless vs. stateful performance expectations. Stateless feature uses Redis to persist state. This brings increased stability against failures or support hitless software upgrades for magma package, however the control plane performance can see some degradations in terms of attach/detach rate per seconds. Since stateless is enabled by default, users need to disable it per AGW if higher performance is desired. Our scaling tests were done with attach/detach rates of 10 UE per second.
  • NMS
    • Read-only users are not supported in NMS (#5477)
    • Call tracing feature doesn’t work with lower timeouts. We need it to be set at, least to 300 secs for peoper function of the feature (#5478)
    • Unexpected service restart alerts might not get triggered for services which restart too quickly. This can cause sctpd unexpected restart alert to not be triggered. (#5479)

Upgrade Notes

  • As of v1.3.2, the apt source needs to be updated in order to get the latest tagged AGW build. Hence, it is required to modify /etc/apt/sources.list.d/packages_magma_etagecom_io.list on the gateway. Instead of “stretch stretch-1.3.3 main", please replace with "stretch-1.4.0 main". Following this, an apt update and apt upgrade magma will be required to finish the AGW upgrade.
  • The desired AGW tag is 1.4.0-xxxxxxxxxx-yyyyyyyy.
  • Upgrade from v1.3.x to 1.4.0 for the Access Gateway will require operators to use a force option else the upgrade may fail due to unmet dependencies. To mitigate this issue, it is recommended that the upgrade be done in the following fashion:
apt update
apt upgrade magma -o Dpkg::Options::="--force-overwrite"

Orc8r Upgrade (service mesh changes)

  • The upgrade steps are very similar to past upgrades except the following modifications need to be noted. Note that these are also discussed in detail on the v1.4 upgrade notes in the github documentation.
    • Set cluster_version in module orc8r in the main.tf file. This should be the current K8s version that was deployed with v1.3.x orc8r deployment.
    • Terraform should be upgrade to at least 0.14.0 on the host from where the Terraform commands will be run.
    • orc8r_deployment_type needs to be specified in module orc8r-app in the main.tf file. See upgrade documentation for more specifics.

Compatibility and Interoperability

Supported and validated setups (Static, DHCP, NAT, Non-NAT)

Critical bug fixes

AGW

  • ZMQ fix for thread safety for shared zmq contexts (#5307)
  • Subscriberdb db lock mitigation for concurrent S6a calls at high UE attach rates (#4698)
  • QoS performance improvement replacing subprocess calls with pyroute2 (#5240)
  • Pipelined getting stuck and hanging fix (#5255)
  • Pipelined performance and recovery redis fix (commit (f9a78ea))
  • Mobilityd stateless performance improvement (#5247)
  • Fixing SPGW state racing condition during IP allocation / create session through ITTI messaging (#5416, #5456)
  • Removed thread unsafe MME NAS state synchronization from non-owner threads (#5426)
  • Add proper handling of failed IP address allocation (#5200)
  • Avoid stale packet buffering on sctpd during mme restarts (#5355)
  • Unaligned memory fixes (#5262)
  • Clean up stale session metrics (#5306)
  • Restore metering metrics on SessionD service restart (#5290)
  • Fix race condition while handling duplicate attach requests (#4769)
  • Added a service restart check if SGi port is part of uplink-br0 before resetting interface IP address (#5495)

Other fixes

AGW

  • Timer ID update during resuming timers (#5303)
  • Reset hash table size to zero upon table destruction (#5108)
  • Fix null eNB context access (#5084)
  • Fix null pointer access in delete session response (#4991)
  • Fix eNB id initialization that leads to s1 setup failures for eNB ids that...
Read more

v1.3.3 (Durango)

15 Jan 19:29
e5ba0db
Compare
Choose a tag to compare

Durango Maintenance Release Notes

Introduction

This minor release for Magma contains fixes for some known issues affecting the stability and usability of the 1.3, 1.3.1 and 1.3.2 releases of Durango. See the release page for more information.

Key Features

Known Issues

  • We have observed service crash loops in our testing environment caused by ‘address in use“ errors that occur when SCTP sockets bind to port 36412 (S1AP port). These crashes have only been observed when the gateway is under moderate load. For mitigation, rebooting the AGW host is recommended.
  • MME service restarts were also observed during continuous load testing. This issue is currently under investigation; no mitigation action is required as call processing resumes normally after restart.

Upgrade Notes

  • As of v1.3.2, the apt source needs to be updated in order to get the latest tagged AGW build. Hence, it is required to modify /etc/apt/sources.list.d/packages_magma_etagecom_io.list on the gateway. Instead of “stretch main” or “stretch-1.3.2 main”, please replace with “stretch-1.3.3 main”. Following this, an “apt update” and “apt upgrade magma” will be required to finish the AGW upgrade.
  • The desired AGW tag is 1.3.3-1610467727-e5ba0dbf.

Compatibility and Interoperability

Deprecations

Critical bug fixes

  • Fixed the expired paging timer issue for detached UEs. The fix removes all the timers including the paging timer at the time of UE context removal. (#4302)
  • Fixed erroneous bearer deactivation of wrong UE. When initial context setup (ICS) timer for a UE-1 was happening, if another UE-2 starts the attach procedure, it was interfering with UE-2’s attach procedure by fetching UE-2’s context and triggering a bearer deactivation for UE-2 instead. (#4141)
  • Fixed the handling of NIL QoS record during Restart Recovery. (#4186).
  • Fixed a known issue where the SCTPD service goes into a crash loop after an MME service crash. Added dependencies to always start the SCTPD service with the MME service (#4179, #4176).
  • Fixed known IP configuration issues in non-NAT mode. This essentially deletes old configurations and forces the reconfiguration of the interface (#4121).
  • Added fixes to pipelined to gracefully handle missing uplink ports (#4202).

Security fixes

Other fixes

  • Added a fix for segmentation faults encountered by the MME service due to memory corruption while calling ctime. These changes replace calls to ctime with strftime (#4216, #4240).

Other