README.md 2.74 KB
Newer Older
Raphael Defosseux's avatar
Raphael Defosseux committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
------------------------------------------------------------------------------

                             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-upf-vpp`) is meant for UPF.

21
22
23
24
25
This `UPF` repository contains mainly patches / hacks over 2 open-source projects:

- [Vector Packet Processing](https://github.com/fdio/vpp.git)
- [User Plane Gateway (UPG) based on VPP](https://github.com/travelping/upg-vpp)

Raphael Defosseux's avatar
Raphael Defosseux committed
26
27
# Licence info

28
29
30
31
As this repository contains mainly patches over 2 open-source projects that are
distributed under Apache V2, it is distributed under `Apache V2.0 License`.

See [Apache Website for more details](http://www.apache.org/licenses/LICENSE-2.0).
Raphael Defosseux's avatar
Raphael Defosseux committed
32

33
The text for `Apache V2.0 License` is also available under [LICENSE](LICENSE)
Raphael Defosseux's avatar
Raphael Defosseux committed
34
35
file at the root of this repository.

36
37
38
39
40
Some part(s) of the repository that are decorrelated from the 2 original open-source
projects may be under another LICENSE type.

Check the [NOTICE](NOTICE.md) file for more details.

Raphael Defosseux's avatar
Raphael Defosseux committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# Where to start

The Openair-CN-5G UPF 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-upf-vpp](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-upf-vpp).

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 UPF software is composed of the following parts: 

<pre>
openair-cn5g-upf-vpp
74
75
76
77
78
79
80
81
82
83
├── build
│   └── scripts
├── ci-scripts
├── docker
├── docs
│   └── images
└── scripts
    ├── patches
    ├── tests
    └── upf_conf
Raphael Defosseux's avatar
Raphael Defosseux committed
84
</pre>