-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add GO report card and reformat README.md file (#187)
- Loading branch information
1 parent
7929c4b
commit dd1e664
Showing
1 changed file
with
81 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,34 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: 2024 Intel Corporation | ||
| SPDX-FileCopyrightText: 2022 Great Software Laboratory Pvt. Ltd | ||
| SPDX-FileCopyrightText: 2021 Open Networking Foundation <[email protected]> | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
| [](https://goreportcard.com/report/github.com/omec-project/gnbsim) | ||
|
|
||
| # Table Of Contents | ||
| * [Introduction](#Introduction) | ||
| * [gNBSim Block Diagram](#gnbsim-simulator-block-diagram) | ||
| * [Supported Features](#supported-features) | ||
| * [Pending Features](#pending-features) | ||
| * [Support & Contributions](#Support-and-contributions) | ||
| * [License](#license) | ||
| * [Deployment model](/docs/deployment.md) | ||
| * [Configuration](/docs/config.md) | ||
| * Advanced Configuration/Features | ||
| * [API Based Configuration](/docs/apis.md) | ||
| * [Data Support](/docs/data.md) | ||
| * [Message Flow](/docs/gnbsim_flow.md) | ||
| * [Profile Details](/docs/profile_manager_design.md) | ||
| * [UE Originated Message Flow](/docs/ue_originated_flow.md) | ||
| * [UE Terminated Message Flow](/docs/ue_terminated_flow.md) | ||
| * [Introduction](#Introduction) | ||
| * [gNBSim Block Diagram](#gnbsim-simulator-block-diagram) | ||
| * [Supported Features](#supported-features) | ||
| * [Pending Features](#pending-features) | ||
| * [Support & Contributions](#Support-and-contributions) | ||
| * [License](#license) | ||
| * [Deployment model](/docs/deployment.md) | ||
| * [Configuration](/docs/config.md) | ||
| * Advanced Configuration/Features | ||
| * [API Based Configuration](/docs/apis.md) | ||
| * [Data Support](/docs/data.md) | ||
| * [Message Flow](/docs/gnbsim_flow.md) | ||
| * [Profile Details](/docs/profile_manager_design.md) | ||
| * [UE Originated Message Flow](/docs/ue_originated_flow.md) | ||
| * [UE Terminated Message Flow](/docs/ue_terminated_flow.md) | ||
|
|
||
|
|
||
| # Introduction | ||
|
|
||
| This repository is part of the SD-Core project. SD-Core is open source 5G implementation of 5G Core Network. | ||
| SD-Core provides a tool to simulate gNodeB and UE by generating NAS and NGAP messages for the configured UEs | ||
| and call flows. | ||
| This repository is part of the SD-Core project. SD-Core is open source 5G | ||
| implementation of 5G Core Network. SD-Core provides a tool to simulate gNodeB | ||
| and UE by generating NAS and NGAP messages for the configured UEs and call flows. | ||
|
|
||
| # gNBSim Simulator Block Diagram | ||
|
|
||
|
|
@@ -35,77 +37,78 @@ and call flows. | |
|
|
||
| # Supported features | ||
|
|
||
| Supported 3gpp procedures | ||
|
|
||
| - UE Registration | ||
| - UE Initiated PDU Session Establishment | ||
| - UE Initiated De-registration | ||
| - AN Release | ||
| - UE Initiated Service Request | ||
| - N/W triggered PDU Session Release | ||
| - UE Requested PDU Session Release | ||
| - N/W triggered UE Deregistration | ||
|
|
||
|
|
||
| Supported System level features | ||
|
|
||
| - Gnbsim can generate and send user data packets (ICMP echo request) | ||
| and process downlink user data (ICMP echo response) over the established data | ||
| plane path (N3 Tunnel). | ||
| - Executing all enabled profiles in parallel or in sequential order. | ||
| - Timeout for each call flow within profile | ||
| - Logging summary result | ||
| - HTTP API to execute profile | ||
| - Configure number of data packets to be sent and time interval between consecutive packets | ||
| - Configure AS (Application Server) address. This is used to send data packets | ||
| - Run gNBSim with single Interface or multi interface | ||
| - Support of Custom Profiles | ||
| - Delay between Procedures | ||
| - Timeout for every profile | ||
| - Logic to calculate latency per transaction/ operation | ||
| - Support retransmission of Service Request Message | ||
| - Support deployment of gNBSim as standalone container | ||
| - Reporting profile errors from all levels | ||
| Supported 3gpp procedures: | ||
|
|
||
| - UE Registration | ||
| - UE Initiated PDU Session Establishment | ||
| - UE Initiated De-registration | ||
| - AN Release | ||
| - UE Initiated Service Request | ||
| - N/W triggered PDU Session Release | ||
| - UE Requested PDU Session Release | ||
| - N/W triggered UE Deregistration | ||
|
|
||
| Supported System level features | ||
|
|
||
| - Gnbsim can generate and send user data packets (ICMP echo request) and process | ||
| downlink user data (ICMP echo response) over the established data plane path | ||
| (N3 Tunnel) | ||
| - Executing all enabled profiles in parallel or in sequential order | ||
| - Timeout for each call flow within profile | ||
| - Logging summary result | ||
| - HTTP API to execute profile | ||
| - Configure number of data packets to be sent and time interval between consecutive packets | ||
| - Configure AS (Application Server) address. This is used to send data packets | ||
| - Run gNBSim with single Interface or multi interface | ||
| - Support of Custom Profiles | ||
| - Delay between Procedures | ||
| - Timeout for every profile | ||
| - Logic to calculate latency per transaction/ operation | ||
| - Support retransmission of Service Request Message | ||
| - Support deployment of gNBSim as standalone container | ||
| - Reporting profile errors from all levels | ||
|
|
||
| # Pending Features | ||
|
|
||
| Data Testing Features | ||
| Data Testing Features | ||
|
|
||
| - Provision data interface to gNBSim Container/POD/executable for data traffic testing | ||
| - Triggering downlink data from gNB Sim (CI/CD feature as well) | ||
|
|
||
| 3gpp features for gNodeB Simulator | ||
|
|
||
| - Provision data interface to gNBSim Container/POD/executable for data traffic testing | ||
| - Triggering downlink data from gNB Sim (CI/CD feature as well) | ||
| - GUTI based registration | ||
| - Adding support for Resynchronization Profile | ||
| - Adding Support for N2 handover profile | ||
| - Adding Support for Xn Handover profile | ||
| - Adding support for handling end marker packet | ||
| - Generating GTPU echo request and handling incoming GTPU Request | ||
| - Support to send Error indication Message | ||
| - Support to handle Paging Request | ||
|
|
||
| 3gpp features for gNodeB Simulator | ||
|
|
||
| - GUTI based registration | ||
| - Adding support for Resynchronization Profile | ||
| - Adding Support for N2 handover profile | ||
| - Adding Support for Xn Handover profile | ||
| - Adding support for handling end marker packet | ||
| - Generating GTPU echo request and handling incoming GTPU Request | ||
| - Support to send Error indication Message | ||
| - Support to handle Paging Request | ||
| Common features for gNodeB Simulator | ||
|
|
||
| Common features for gNodeB Simulator | ||
| - Controlling Profiles - Adding support for aborting profile | ||
| - Controlling Profiles - Suspend/Pause profiles | ||
| - Controlling Profiles - Resume Profile | ||
| - Adding support for configurable rate of events | ||
|
|
||
| - Controlling Profiles - Adding support for aborting profile | ||
| - Controlling Profiles - Suspend/Pause profiles | ||
| - Controlling Profiles - Resume Profile | ||
| - Adding support for configurable rate of events | ||
|
|
||
| CI/CD features | ||
|
|
||
| - HTTP APIs to fetch subscriber/profile status from gNBSim | ||
| CI/CD features | ||
|
|
||
| Negative Testing features | ||
| - HTTP APIs to fetch subscriber/profile status from gNBSim | ||
|
|
||
| Negative Testing features | ||
|
|
||
| - Dropping incoming messages based on configuration | ||
| - Sending negative responses to request/command type messages based on configuration | ||
| - Handling security mode failure message | ||
|
|
||
| - Dropping incoming messages based on configuration | ||
| - Sending negative responses to request/command type messages based on configuration | ||
| - Handling security mode failure message | ||
|
|
||
|
|
||
| # Support and Contributions | ||
|
|
||
| The gnbsim project welcomes new contributors. Feel free to propose a new feature or fix bugs! | ||
| The gnbsim project welcomes new contributors. Feel free to propose a new feature | ||
| or fix bugs! | ||
|
|
||
| Before contributing, please follow these guidelines: | ||
|
|
||
| 1. gNBSim documentation details [here](./docs/README.md) | ||
|
|
||