Skip to content

O
OpenXG-AMF
Commit af3dabbb authored by Luhan Wang's avatar Luhan Wang
Browse files
Options

verified by ci env

parent 923c8fc6
Hide whitespace changes
Inline Side-by-side
Showing with 41 additions and 73 deletions
README.md
View file @ af3dabbb
# OpenXG-AMF
<img src="README.assets/openxglogo.png" alt="OpenXG" style="zoom: 100;" />
# 1. Generals
OpenXG is a series of 5G/6G-oriented open source projects developed by Open Source Radio Access Network Community. Currently, the community has developed the project from five aspects, including:
* Core network projects, 3GPP R15/R16 specification compliant network functions have been developed, including AMF, SMF, NRF, UPF, AUSF, UDM, AUSF, NWDAF, etc. Message level stateless mechanism is introduced in to the core network to make it better adapted to the cloud environment.
* Open hardware reference design, the reference design of heterogeneous computing hardware, white-box radio frontend, and open source UE hardware are also opened to the community.
* Radio access network projects, currently CU, DU and UE protocol software are developed, which is mainly compliant with 3GPP R15/R16 specifications. The software is developed by a modular-design, and which is flexible to customize to different vertical scenarios.
* AI-enabled management projects, three kinds of projects are developed under this category, including the AIEngine, which is aimed to provide the core AI capability for the management, the network measurement, and computing network for cloud-edge-end collaborative.
* Uses cases and applications in verticals, some key use cases when applying OpenXG to vertical scenarios are also developed as a reference for the community.
# 2. License
The OpenXG series projects are distributed under OS-RAN license, which is derived from the Fair, Reasonable, and Non-Discriminatory principle. See [online version for details](http://www.openxg.org.cn/?falu_69.html).
# 3. How to start
## Introduction
OpenXG-AMF is developed by the OS-RAN community. It is compliant with 3GPP R15/R16 specification. Currently AMF support with AUSF or no-AUSF mode, and also support stateless mode.
# How to start
## Download source code from Gitlab
git clone http://git.opensource5g.org/openxg/amf.git
cd amf/
git checkout master
```
git clone http://git.opensource5g.org/openxg/openxg-amf.git
cd openxg-amf/
```
As master branch is usually the stable branch, so we would suggest you start from the master:
```
git checkout master
```
## install dependencies
cd /amf/build/scripts
./build_amf -I -f
OpenXG-AMF relies on some third-party software or libraries, please install the dependencies when you first build the project, run by:
```
cd build/scripts
sudo ./build_amf -I -f
```
## build AMF
./build_amf -c -V -b Debug -j
When you finish install the dependencies, you can finally build the AMF executables by:
```
sudo ./build_amf -c -V -b Debug -j
```
## launch AMF
sudo amf -c etc/amf.conf -o
AMF executable files will be installed to /usr/local/bin/ by default, you can run AMF by simply type:
```
sudo amf -c etc/amf.conf -o
```
Etc/amf.conf is the config file for AMF.
Customize the config file according to your environments.
Enjoy.
docs/FEATURE_SET.md deleted 100644 → 0
View file @ 923c8fc6
<table style="border-collapse: collapse; border: none;">
<tr style="border-collapse: collapse; border: none;">
<td style="border-collapse: collapse; border: none;">
<a href="http://www.openairinterface.org/">
<img src="./images/oai_final_logo.png" alt="" border=3 height=50 width=150>
</img>
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">OpenAirInterface AMF Feature Set</font></b>
</td>
</tr>
</table>
**Table of Contents**
1. [5GC Service Based Architecture](#1-5gc-service-based-architecture)
2. [OAI AMF Available Interfaces](#2-oai-smf-available-interfaces)
3. [OAI AMF Feature List](#3-oai-smf-feature-list)
# 1. 5GC Service Based Architecture #
![5GC SBA](./images/5gc_sba.png)
# 2. OAI AMF Available Interfaces #
| **ID** | **Interface** | **Status** | **Comment** |
| ------ | ------------- | ------------------ | --------------------------------------------------------------------------|
| 1 | N1 | :heavy_check_mark: | Communicate with UE via NAS message |
| 2 | N2 | :heavy_check_mark: | Communicate with gNB via NGAP message |
| 3 | N8 | :x: | Interface to/from UDM (e.g., retrieve UE subscription data) |
| 4 | N11 | :heavy_check_mark: | Interface to/from SMF (e.g., N1N2MessageTransfer, PDU Session Services) |
| 5 | N14 | :x: | Interface between AMFs |
| 6 | N15 | :x: | Interface between AMF and PCF |
# 3. OAI AMF Feature List #
Based on document **3GPP TS 23.501 V16.0.0 §6.2.1**.
| **ID** | **Classification** | **Status** | **Comments** |
| ------ | ------------------------------------------------------------------- | ------------------ | ------------------------------------------- |
| 1 | Termination of RAN CP interface (N2) | :heavy_check_mark: | Communicate with gNB via NGAP message |
| 2 | Termination of NAS (N1) | :heavy_check_mark: | Communicate with UE via NAS message |
| 3 | NAS ciphering and integrity protection | :heavy_check_mark: | |
| 4 | Registration management | :heavy_check_mark: | |
| 5 | Connection management | :heavy_check_mark: | |
| 6 | Reachability management | :x: | |
| 7 | Mobility Management | :x: | |
| 8 | Lawful intercept (for AMF events and interface to LI System) | :x: | |
| 9 | Provide transport for SM messages between UE and SMF | :heavy_check_mark: | |
| 10 | Transparent proxy for routing SM messages | :x: | |
| 11 | Access Authentication | :heavy_check_mark: | |
| 12 | Access Authorization | :heavy_check_mark: | |
| 13 | Provide transport for SMS messages between UE and SMSF. | :x: | |
| 14 | Security Anchor Functionality (SEAF) | :heavy_check_mark: | |
| 15 | Location Services management for regulatory services | :x: | |
| 16 | Provide transport for Location Services messages between | | |
| | UE and LMF as well as between RAN and LMF. | :x: | |
| 17 | EPS Bearer ID allocation for interworking with EPS. | :x: | |
| 18 | UE mobility event notification | :x: | |
| 19 | Support for Control Plane CIoT 5GS Optimisation. | :x: | |
| 20 | Provisioning of external parameters | :x: | |
| 21 | Support non-3GPP access networks | :x: | |
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment