Release v1.4.2 - 5GMS Application Function

This is a bug-fix and specification uplift release, no new API features have been added.

This release includes:

1. Uplift to 3GPP TS 26.512 V17.9.1
   1. Introduce MetricsReportingConfiguratiuon.sliceScope and MetricsReportingClientConfiguration.sliceScope fields for limiting metrics reports to applications using media over particular network slices.
   2. Add string pattern validation for fields where a format or valid pattern is given in the 3GPP 5G_APIs OpenAPI YAML descriptions of the 5GMS interfaces.
   3. Error responses about particular field problems will now include the field generating the error in the ProblemDetails.invalidParameters array.
2. Change to omit the "POST" operation in the OPTIONS response for PolicyTemplate provisioning when policy templates support has not been configured in the AF. Allows the rt-5gms-application-provider web UI disable "Dynamic Policies" when they are not available.
3. Bug fixes for memory issues.

---

Change Log summary

• Reflect the enabled state of PolicyTemplate provisioning in the OPTIONS method by @davidjwbbc in #162
• Uplift to 3GPP TS 26.512 V17.9.1 by @davidjwbbc in #164
• Bug-fix: Update README for new dependencies and meson version consistency by @davidjwbbc in #167

Full Changelog: rt-5gms-application-function-v1.4.1...rt-5gms-application-function-v1.4.2

Release v1.4.1 - 5GMS Application Function

This release introduces the Metrics Reporting feature and contains some documentation updates and bug fixes.

In this release

New Feature: Metrics Reporting
Provisioning for metrics reporting has been added to the interface at reference point M1 and metrics report client configuration and collection has been added to the interface at reference point M5.

Enhancement: Improved OpenAPI code generation
The templates for code generation from OpenAPI YAML have been improved to add some new data type handling and error reporting.

Architecture: Move of Python tools
The Python tools and module for interacting with the M1 API interface have been moved to the rt-5gms-application-provider repository.

---

What's Changed

• Enhancement: Use new branches and common areas in 5G-MAG/open5gs and 5G-MAG/rt-common-shared by @davidjwbbc in #136
• Use new paths for Open5GS OpenAPI generator script and templates by @davidjwbbc in #138
• Location header included for creation of Metrics Configuration by @stojkovicv in #142
• Moving M1 python tools and classes to rt-5gms-application-provider by @davidjwbbc in #141
• M5 | Metrics Reporting API by @stojkovicv in #143
• Bug-fix: Add range checking for parameters in MetricsReportingConfiguration by @davidjwbbc in #148
• Various memory leaks and bug fixes found during metrics provisioning testing by @davidjwbbc in #150
• QoE Metrics Reporting | Handling of missing scheme value by @stojkovicv in #152
• Fixed parsing client id value from QoE metrics by @stojkovicv in #155
• Bug-fix: Response message for activateConsumptionReporting operation at M1 by @davidjwbbc in #160
• Documentation updates by @jordijoangimenez in #161

New Contributors

• @stojkovicv made their first contribution in #142

Full Changelog: rt-5gms-application-function-v1.4.0...rt-5gms-application-function-v1.4.1

Release v1.4.0 - 5GMS Application Function

This release introduces several new features and fixes some bugs.

In this release

New Feature: Consumption Reporting

Provisioning for consumption reporting has been added to the interface at reference point M1 and consumption report client configuration and collection has been added to the interface at reference point M5. There is no Data Collection AF part of the 5GMS Application Function as yet so collected reports are simply stored to disk on the 5GMS AF host for now.

New Feature: Network Assistance

The network assistance delivery boost feature has been added to the 5GMS Application Function. This new feature requires connection to a functioning 5G Core in order to be used. Please see the wiki for instructions on configuring network assistance to enable this feature.

This will advertise the presence of Network Assistance to the UE via the Service Access Information and will accept delivery boost requests from the UE. When a delivery boost is active the UE will be provided with a guaranteed minimum bit rate for a short period of time. The level of minimum bit rate and the period of time it will be provided for are both configurable.

New Feature: Dynamic Policies

The dynamic policies feature allows a UE to request that pre-provisioned network Quality of Service parameters be applied to one or more of its service data flows. This allows the Media Session Handler in the UE to request QoS settings to be applied to media transfers as guided by the media manifest.

This new feature requires connection to a functioning 5G Core in order to be used. Please see the wiki for instructions on configuring dynamic policies for details on enabling this feature in the 5GMS AF.

Enhancement: ACME certificate management

An example certificate manager which uses the ACME protocol (with default provider being Let's Encrypt) to acquire signed certificates is provided and can be configured instead of the default self signed certificate manager. Please check you have the right to use the Let's Encrypt service before enabling this certificate manager.

Enhancement: Improved validation on API communications

All interfaces now have better checks for number ranges and enumerated types. Reasons for parse errors are now, in most cases, returned back to the client in the detail of the error report.

Enhancement: Uplift all interfaces to comply with 3GPP TS 26.512 V17.7.0.

Interfaces have been adjusted to meet the standards laid out in 3GPP TS 26.512 V17.7.0.

This affects some operations at reference points M1 (provisioning) and M5 (network media session handling).

Bug fixes

• Various memory leaks have been fixed.
• Corrections to API parsing issues

What's Changed

• Feature: ACME Certificate Signer by @davidjwbbc in #72
• Documentation update by @jordijoangimenez in #77
• Update README.md by @jordijoangimenez in #78
• Uplift to TS 26.512 V17.5.0 and Release 17 version of Open5GS by @davidjwbbc in #85
• Feature: M1 - Consumption Reporting Provisioning by @davidjwbbc in #92
• Feature: SAI - Consumption Reporting by @davidjwbbc in #94
• Feature: Add M5 ConsumptionReporting API by @davidjwbbc in #96
• Fix: ConsumptionReportConfiguration validation and accessReporting field by @davidjwbbc in #100
• Bug-fix: Use canonical domain in publication dirs by @davidjwbbc in #102
• Enhancement: Add Let's Encrypt Certificate Manager for the AF to use. by @davidjwbbc in #105
• Feature: Network Assistance and Dynamic Policies by @davidjwbbc in #108
• Add PolicyTemplates to the msaf-configuration tool by @davidjwbbc in #111
• Add cmake and pyOpenSSL as dependencies in README.md by @dsilhavy in #116
• Feature/cicd clean by @dsilhavy in #117
• Enhancement: Uplift to TS26.512 v17.7.0 by @davidjwbbc in #118
• Enhancement: M1 session tool: policy templates operations by @davidjwbbc in #119
• Bug fix: Policy templates field validation by @davidjwbbc in #125
• Bug-fix: Network Assistance and Dynamic policies by @davidjwbbc in #130

Full Changelog: rt-5gms-application-function-v1.3.0...rt-5gms-application-function-v1.4.0

Release v1.3.0 - 5GMS Application Function

Release v1.3.0

This release brings the Reference Tools 5GMS Application Function in line with 3GPP TS 26.512 v17.4.0.

Major changes in this release:

• The single media entry point is gone from the ContentHostingConfiguration and has been replaced by entry points per distribution configuration. This allows multiple entry points for the same media to be configured which enables the Application Function to offer the UE the media in different formats.
• Addition of systemd unit files to assist in the deployment of the 5GMS Application Function as a system service.
• Addition of msaf-configuration utility which will be used by the Systemd unit files to configure the AF once it's started.
• A few bug fixes

What's Changed

• Enhancement: Uplift to TS 26.512 v17.4.0 spec by @davidjwbbc in #62
• Fix: TS 26.512 v17.4.0 APIs rollback for v1.2.x branch by @davidjwbbc in #61
• Bug Fixes: Memory leak in AF and fix for m1-session del-stream matching by @davidjwbbc in #66
• Fix: Bugs found during deployment of v1.3.0 RC1 and addition of SystemD files. by @davidjwbbc in #69

Full Changelog: rt-5gms-application-function-v1.2.0...rt-5gms-application-function-v1.3.0

Release v1.2.1 - 5GMS Application Function

Release v1.2.1

This is a bug fix release to deal with a discrepancy between the 5GMS Application Function source and the latest Release-17 5G APIs which was preventing v1.2.0 compiling.

What's Changed

• Fix: TS 26.512 v17.4.0 APIs rollback for v1.2.x branch by @davidjwbbc in #61

Full Changelog: rt-5gms-application-function-v1.2.0...rt-5gms-application-function-v1.2.1

Release v1.2.0 - 5GMS Application Function

Release v1.2.0

Major changes in this release:

• Implementation of the interfaces at reference point M1 for:
  • Provisioning Session (TS 26.512 clauses 4.3.2 & 7.2)
  • Content Protocols Discovery (TS 26.512 clauses 4.3.4 & 7.5)
  • Server Certificates (TS 26.512 clauses 4.3.6 & 7.3)
  • Content Hosting Configuration (TS 26.512 clauses 4.3.3 & 7.6)
• Removal of stream configuration from the msaf.yaml configuration file.
• Improvement of server headers for all API interfaces:
  • Addition of an ETag header to identify data instances.
  • Addition of a Last-Modified header to indicate the change date of the data.
  • Addition of a Cache-Control header with max-age field to indicate cache time.
  • Server header now indicates the 5GMSd AF name and major API version used with the individual API interface details held in a comment field in the same header.
• Introduction of an m1-session tool for managing stream configuration at runtime.
  • Management of Provisioning Sessions, Certificates and Content Hosting.
  • Querying of available downlink/uplink protocols.
  • Pluggable certificate signing class to allow easy enhancement with custom signing.

Testing of the new M1 API interfaces is described in the "Testing the M1 Interface" wiki page. Other testing wiki pages have been updated to use the new m1-session tool for configuration. The information on "Testing as a Local User" has also been updated in the wiki to include extra instruction needed to use the new m1-session tool when testing in a temporary development deployment.

What's Changed

• Feature: M1 provisioning by @davidjwbbc in #53
• Various fixes for issues found while writing up the testing by @davidjwbbc in #54
• Bug fixes and final improvements before v1.2.0 Release Candidate by @davidjwbbc in #56

Full Changelog: rt-5gms-application-function-v1.1.0...rt-5gms-application-function-v1.2.0

Release v1.1.0 - 5GMS Application Function

Release v1.1.0

This marks the first version of the 5GMS Application Function which now directly controls the 5GMS Application Server via the interface at reference point M3 (see 3GPP TS 26.501). This means that the AF now requires an AS listening at the configured AS location (default: localhost TCP port 7777) to be running in order to operate properly and as part of the 5G Media Streaming architecture. Upon start up the AF will now select and configure the AS using the configuration it has been provided.

What's Changed

• Feature: 5GMS Application Function M3 API by @devbbc in #23
• Feature: uplift to TS 26.512 v17.3.0 by @devbbc in #26
• Fix: Use domainNameAlias for the authority in the mediaPlayerEntry when available and improve error logging by the 5GMS AF by @devbbc in #30
• Enhancement: improved logging around content hosting configuration and certificates configuration files by @davidjwbbc in #32
• Prepare release candidate for v1.1.0 by @davidjwbbc in #34
• Documentation and deployment updates for v1.1.0 release candidate by @davidjwbbc in #40
• Improve examples and logging by @davidjwbbc in #42
• Fix for lack of relative filenames in msaf.yaml and documentation improvements for release candidate by @davidjwbbc in #44

Full Changelog: rt-5gms-application-function-v1.0.1...rt-5gms-application-function-v1.1.0

Release v1.0.1

This is a bug-fix and documentation improvement release of the MVP#2 5GMS Application Function.

This release will work with 5GMS Application Server release v1.0.1 to provide the 5GMS network functions.

What's Changed

• Backport Fix to v1.0.x: Use domainNameAlias for the authority in the mediaPlayerEntry when available and improve error logging by the 5GMS AF by @davidjwbbc in #31
• Enhancement backport to v1.0.x: improved logging around content hosting configuration and certificates configuration files by @davidjwbbc in #33
• Bump version for v1.0.1 release. by @davidjwbbc in #35

Full Changelog: rt-5gms-application-function-v1.0.0...rt-5gms-application-function-v1.0.1

Release v1.0.0

This is release v1.0.0 of the 5G-MAG Reference Tools 5GMS Application Function.

This release meets the requirements for MVP#2.

The 5GMS Application Function does not yet implement the M1 interface or M3 interface and only has a partial implementation of the M5 interface (the ServiceAccessInformation API is implemented). As a replacement for the M1 interface, this 5GMS Application Function is configured using the YAML application configuration file (msaf.yaml is the default configuration) and a 5G OpenAPI ContentHostingConfiguration JSON file (See TS 26.512 Annex C.3.5 for details of the data structure). Example ContentHostingConfiguration files can be found in the rt-common-shared examples directory.

What's Changed

• Change default open5gs server/client type to HTTP/1.1 by @davidjwbbc in #11
• Update README.md by @jordijoangimenez in #14
• Prepare for release. by @davidjwbbc in #21
• Minor additions to the installation guide in README.md. by @dsilhavy in #22

New Contributors

• @devbbc submitted the initial contribution
• @davidjwbbc made their first contribution in #11
• @jordijoangimenez made their first contribution in #14
• @dsilhavy made their first contribution in #22

Full Changelog: https://github.com/5G-MAG/rt-5gms-application-function/commits/rt-5gms-application-function-v1.0.0