README.md 3.19 KB
Newer Older
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
------------------------------------------------------------------------------

                             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**)

Each has its own repository: this repository (`oai-cn5g-udm`) is meant for UDM.

# Licence info

It is distributed under `OAI Public License V1.1`.
See [OAI Website for more details](https://www.openairinterface.org/?page_id=698).

The text for `OAI Public License V1.1` is also available under [LICENSE](LICENSE)
file at the root of this repository.

# Where to start

The Openair-CN-5G UDM code is written, executed, and tested on UBUNTU server bionic version.
Other Linux distributions support will be added later on.

More details on the supported feature set is available on this [page](docs/FEATURE_SET.md).

# Collaborative work

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

*  URL: [https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udm](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-udm).

Process is explained in [CONTRIBUTING](CONTRIBUTING.md) 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](CHANGELOG.md) file.

# Repository Structure:

The OpenAirInterface CN UDM software is composed of the following parts: 

<pre>
openair-cn5g-udm
├── build:          Build directory, contains targets and object files generated by compilation of network functions. 
    ├── log:        Directory containing build log files.
    ├── scripts:    Directory containing scripts for building network functions.
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
65
    └── udm:        Directory containing CMakefile.txt and object files generated by compilation of UDM network function. 
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
66
67
├── ci-scripts:     Directory containing the script files for CI framework.
├── docs:           Directory containing the documentation files.
Raphael Defosseux's avatar
Raphael Defosseux committed
68
├── docker:         Directory containing the DockerFiles to build images.
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
69
├── etc:            Directory containing the configuration file to be deployed for UDM.
Raphael Defosseux's avatar
Raphael Defosseux committed
70
├── scripts:        Directory containing some scripts.
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
71
72
73
74
75
76
77
78
└── src:            Source files of UDM.
    ├── 5gaka:      Security algorimth implementation.
    ├── api-server: UDM services APIs. 
    ├── common:     Common header files
    │   └── utils:  Common utilities.
    ├── oai_udm:   UDM main directory, contains the "main" CMakeLists.txt file.
    └── udm_app:   UDM network functions procedures and contexts.
</pre>