oaisoftwarealliance/oai-smf repository overview

⁠

                         OPENAIR-CN-5G

An implementation of the 5G Core network by the OpenAirInterface community.

OPENAIR-CN-5G is an implementation of the 3GPP specifications for the 5G Core Network. At the moment, it contains the following network elements:

• Access and Mobility Management Function (AMF)
• Authentication Server Management Function (AUSF)
• Network Repository Function (NRF)
• Session Management Function (SMF)
• Unified Data Management (UDM)
• Unified Data Repository (UDR)
• User Plane Function (UPF)
• Network Slicing Selection Function (NSSF)
• Network Exposure Function (NEF)
• Policy Control Function (PCF)

Each has its own repository: this repository (oai-cn5g-smf) is meant for SMF.

⁠Licence info

It is distributed under CSSL V1.0. See OAI Website for more details⁠.

The text for CSSL V1.0 is also available under LICENSE⁠ file at the root of this repository.

As with all container images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

⁠Limitation of Liability

As stated in Section 9 of our LICENSE⁠:

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall Licensor and any Contributor, as such, be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of Your use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

⁠Base Image

Until May 12th, 2023; the published images were done on an Ubuntu-18.04 LTS base.

From May 15th, 2023 to September 25th, 2023; the published images were done on an Ubuntu-20.04 LTS base.

Starting September 26th, 2023; the published images are done on an Ubuntu-22.04 LTS base.

⁠Where to start

The Openair-CN-5G SMF code is written, executed, and tested on UBUNTU server bionic/focal/jammy versions. Other Linux distributions support will be added later on.

More details on the supported feature set is available on this page⁠.

⁠Collaborative work

This source code is managed through a GITLAB server, a collaborative development platform:

• URL: https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-smf⁠.

Process is explained in CONTRIBUTING⁠ file.

⁠Contribution requests

In a general way, anybody who is willing can contribute on any part of the code in any network component.

Contributions can be simple bugfixes, advices and remarks on the design, architecture, coding/implementation.

⁠Release Notes

They are available on the CHANGELOG⁠ file.

⁠Tag Management Explanation

• latest corresponds to the last validated / approved release we made. At the time of writing it was v1.1.0
• v1.y.z corresponds to all the approved releases we made
• develop corresponds to CI-based pushes when we accepted contributions.